@simpleapps-com/augur-api 0.4.1 → 0.4.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/core/schema-factories.d.ts +18 -18
- package/dist/cjs/index.d.ts +1 -1
- package/dist/cjs/index.js +1 -1
- package/dist/cjs/services/agr-site/client.d.ts +1 -1
- package/dist/cjs/services/agr-site/schemas/content.d.ts +2 -2
- package/dist/cjs/services/avalara/client.d.ts +2 -2
- package/dist/cjs/services/avalara/schemas.d.ts +56 -56
- package/dist/cjs/services/brand-folder/client.d.ts +4 -4
- package/dist/cjs/services/brand-folder/schemas.d.ts +16 -16
- package/dist/cjs/services/commerce/client.d.ts +2 -2
- package/dist/cjs/services/commerce/schemas/cart.d.ts +30 -30
- package/dist/cjs/services/commerce/schemas/checkout.d.ts +64 -64
- package/dist/cjs/services/commerce/schemas/recommendations.d.ts +8 -8
- package/dist/cjs/services/customers/client.d.ts +418 -391
- package/dist/cjs/services/customers/client.d.ts.map +1 -1
- package/dist/cjs/services/customers/client.js +138 -31
- package/dist/cjs/services/customers/client.js.map +1 -1
- package/dist/cjs/services/customers/schemas/contactsIdCustomers.d.ts +258 -0
- package/dist/cjs/services/customers/schemas/contactsIdCustomers.d.ts.map +1 -0
- package/dist/cjs/services/customers/schemas/contactsIdCustomers.js +31 -0
- package/dist/cjs/services/customers/schemas/contactsIdCustomers.js.map +1 -0
- package/dist/cjs/services/customers/schemas/contactsIdDoc.d.ts +121 -0
- package/dist/cjs/services/customers/schemas/contactsIdDoc.d.ts.map +1 -0
- package/dist/cjs/services/customers/schemas/contactsIdDoc.js +15 -0
- package/dist/cjs/services/customers/schemas/contactsIdDoc.js.map +1 -0
- package/dist/cjs/services/customers/schemas/contactsIdWebAllowance.d.ts +101 -0
- package/dist/cjs/services/customers/schemas/contactsIdWebAllowance.d.ts.map +1 -0
- package/dist/cjs/services/customers/schemas/contactsIdWebAllowance.js +13 -0
- package/dist/cjs/services/customers/schemas/contactsIdWebAllowance.js.map +1 -0
- package/dist/cjs/services/customers/schemas/contactsRefresh.d.ts +91 -0
- package/dist/cjs/services/customers/schemas/contactsRefresh.d.ts.map +1 -0
- package/dist/cjs/services/customers/schemas/contactsRefresh.js +12 -0
- package/dist/cjs/services/customers/schemas/contactsRefresh.js.map +1 -0
- package/dist/cjs/services/customers/schemas/contactsUdId.d.ts +97 -0
- package/dist/cjs/services/customers/schemas/contactsUdId.d.ts.map +1 -0
- package/dist/cjs/services/customers/schemas/contactsUdId.js +11 -0
- package/dist/cjs/services/customers/schemas/contactsUdId.js.map +1 -0
- package/dist/cjs/services/customers/schemas/customer.d.ts +261 -0
- package/dist/cjs/services/customers/schemas/customer.d.ts.map +1 -0
- package/dist/cjs/services/customers/schemas/customer.js +32 -0
- package/dist/cjs/services/customers/schemas/customer.js.map +1 -0
- package/dist/cjs/services/customers/schemas/customerCustomerIdAddress.d.ts +159 -0
- package/dist/cjs/services/customers/schemas/customerCustomerIdAddress.d.ts.map +1 -0
- package/dist/cjs/services/customers/schemas/customerCustomerIdAddress.js +22 -0
- package/dist/cjs/services/customers/schemas/customerCustomerIdAddress.js.map +1 -0
- package/dist/cjs/services/customers/schemas/customerCustomerIdContacts.d.ts +266 -0
- package/dist/cjs/services/customers/schemas/customerCustomerIdContacts.d.ts.map +1 -0
- package/dist/cjs/services/customers/schemas/customerCustomerIdContacts.js +28 -0
- package/dist/cjs/services/customers/schemas/customerCustomerIdContacts.js.map +1 -0
- package/dist/cjs/services/customers/schemas/customerCustomerIdDoc.d.ts +237 -0
- package/dist/cjs/services/customers/schemas/customerCustomerIdDoc.d.ts.map +1 -0
- package/dist/cjs/services/customers/schemas/customerCustomerIdDoc.js +25 -0
- package/dist/cjs/services/customers/schemas/customerCustomerIdDoc.js.map +1 -0
- package/dist/cjs/services/customers/schemas/customerCustomerIdInvoices.d.ts +192 -0
- package/dist/cjs/services/customers/schemas/customerCustomerIdInvoices.d.ts.map +1 -0
- package/dist/cjs/services/customers/schemas/customerCustomerIdInvoices.js +26 -0
- package/dist/cjs/services/customers/schemas/customerCustomerIdInvoices.js.map +1 -0
- package/dist/cjs/services/customers/schemas/customerCustomerIdInvoicesInvoiceNo.d.ts +171 -0
- package/dist/cjs/services/customers/schemas/customerCustomerIdInvoicesInvoiceNo.d.ts.map +1 -0
- package/dist/cjs/services/customers/schemas/customerCustomerIdInvoicesInvoiceNo.js +20 -0
- package/dist/cjs/services/customers/schemas/customerCustomerIdInvoicesInvoiceNo.js.map +1 -0
- package/dist/cjs/services/customers/schemas/customerCustomerIdOrders.d.ts +455 -0
- package/dist/cjs/services/customers/schemas/customerCustomerIdOrders.d.ts.map +1 -0
- package/dist/cjs/services/customers/schemas/customerCustomerIdOrders.js +50 -0
- package/dist/cjs/services/customers/schemas/customerCustomerIdOrders.js.map +1 -0
- package/dist/cjs/services/customers/schemas/customerCustomerIdOrdersOrderNo.d.ts +269 -0
- package/dist/cjs/services/customers/schemas/customerCustomerIdOrdersOrderNo.d.ts.map +1 -0
- package/dist/cjs/services/customers/schemas/customerCustomerIdOrdersOrderNo.js +29 -0
- package/dist/cjs/services/customers/schemas/customerCustomerIdOrdersOrderNo.js.map +1 -0
- package/dist/cjs/services/customers/schemas/customerCustomerIdPurchasedItems.d.ts +139 -0
- package/dist/cjs/services/customers/schemas/customerCustomerIdPurchasedItems.d.ts.map +1 -0
- package/dist/cjs/services/customers/schemas/customerCustomerIdPurchasedItems.js +20 -0
- package/dist/cjs/services/customers/schemas/customerCustomerIdPurchasedItems.js.map +1 -0
- package/dist/cjs/services/customers/schemas/customerCustomerIdQuotes.d.ts +159 -0
- package/dist/cjs/services/customers/schemas/customerCustomerIdQuotes.d.ts.map +1 -0
- package/dist/cjs/services/customers/schemas/customerCustomerIdQuotes.js +22 -0
- package/dist/cjs/services/customers/schemas/customerCustomerIdQuotes.js.map +1 -0
- package/dist/cjs/services/customers/schemas/customerCustomerIdQuotesQuoteNo.d.ts +249 -0
- package/dist/cjs/services/customers/schemas/customerCustomerIdQuotesQuoteNo.d.ts.map +1 -0
- package/dist/cjs/services/customers/schemas/customerCustomerIdQuotesQuoteNo.js +27 -0
- package/dist/cjs/services/customers/schemas/customerCustomerIdQuotesQuoteNo.js.map +1 -0
- package/dist/cjs/services/customers/schemas/customerCustomerIdShipTo.d.ts +329 -0
- package/dist/cjs/services/customers/schemas/customerCustomerIdShipTo.d.ts.map +1 -0
- package/dist/cjs/services/customers/schemas/customerCustomerIdShipTo.js +35 -0
- package/dist/cjs/services/customers/schemas/customerCustomerIdShipTo.js.map +1 -0
- package/dist/cjs/services/customers/schemas/customerLookup.d.ts +99 -0
- package/dist/cjs/services/customers/schemas/customerLookup.d.ts.map +1 -0
- package/dist/cjs/services/customers/schemas/customerLookup.js +16 -0
- package/dist/cjs/services/customers/schemas/customerLookup.js.map +1 -0
- package/dist/cjs/services/customers/schemas/{health.d.ts → healthCheck.d.ts} +1 -1
- package/dist/cjs/services/customers/schemas/healthCheck.d.ts.map +1 -0
- package/dist/cjs/services/{orders/schemas/health.js → customers/schemas/healthCheck.js} +1 -1
- package/dist/cjs/services/customers/schemas/healthCheck.js.map +1 -0
- package/dist/cjs/services/customers/schemas/index.d.ts +245 -8
- package/dist/cjs/services/customers/schemas/index.d.ts.map +1 -1
- package/dist/cjs/services/customers/schemas/index.js +27 -9
- package/dist/cjs/services/customers/schemas/index.js.map +1 -1
- package/dist/cjs/services/customers/schemas/oeContactsCustomerRefresh.d.ts +91 -0
- package/dist/cjs/services/customers/schemas/oeContactsCustomerRefresh.d.ts.map +1 -0
- package/dist/cjs/services/customers/schemas/oeContactsCustomerRefresh.js +12 -0
- package/dist/cjs/services/customers/schemas/oeContactsCustomerRefresh.js.map +1 -0
- package/dist/cjs/services/customers/schemas/shipToRefresh.d.ts +91 -0
- package/dist/cjs/services/customers/schemas/shipToRefresh.d.ts.map +1 -0
- package/dist/cjs/services/customers/schemas/shipToRefresh.js +12 -0
- package/dist/cjs/services/customers/schemas/shipToRefresh.js.map +1 -0
- package/dist/cjs/services/gregorovich/client.d.ts +1 -1
- package/dist/cjs/services/gregorovich/schemas/ollamaGenerate.d.ts +4 -4
- package/dist/cjs/services/items/client.d.ts +199 -209
- package/dist/cjs/services/items/client.d.ts.map +1 -1
- package/dist/cjs/services/items/client.js +9 -53
- package/dist/cjs/services/items/client.js.map +1 -1
- package/dist/cjs/services/items/schemas/attributeGroupsAttributes.d.ts +14 -14
- package/dist/cjs/services/items/schemas/bins.d.ts +14 -14
- package/dist/cjs/services/items/schemas/brandsItems.d.ts +251 -154
- package/dist/cjs/services/items/schemas/brandsItems.d.ts.map +1 -1
- package/dist/cjs/services/items/schemas/brandsItems.js +39 -35
- package/dist/cjs/services/items/schemas/brandsItems.js.map +1 -1
- package/dist/cjs/services/items/schemas/categories.d.ts +82 -240
- package/dist/cjs/services/items/schemas/categories.d.ts.map +1 -1
- package/dist/cjs/services/items/schemas/categories.js +4 -13
- package/dist/cjs/services/items/schemas/categories.js.map +1 -1
- package/dist/cjs/services/items/schemas/categoriesAttributes.d.ts +110 -0
- package/dist/cjs/services/items/schemas/categoriesAttributes.d.ts.map +1 -0
- package/dist/cjs/services/items/schemas/categoriesAttributes.js +15 -0
- package/dist/cjs/services/items/schemas/categoriesAttributes.js.map +1 -0
- package/dist/cjs/services/items/schemas/faq.d.ts +20 -20
- package/dist/{esm/services/orders/schemas/health.d.ts → cjs/services/items/schemas/healthCheck.d.ts} +1 -1
- package/dist/cjs/services/items/schemas/healthCheck.d.ts.map +1 -0
- package/dist/cjs/services/items/schemas/{health.js → healthCheck.js} +2 -4
- package/dist/cjs/services/items/schemas/healthCheck.js.map +1 -0
- package/dist/cjs/services/items/schemas/index.d.ts +8 -4
- package/dist/cjs/services/items/schemas/index.d.ts.map +1 -1
- package/dist/cjs/services/items/schemas/index.js +9 -4
- package/dist/cjs/services/items/schemas/index.js.map +1 -1
- package/dist/cjs/services/items/schemas/internalPdf.d.ts +8 -8
- package/dist/{esm/services/items/schemas/products.d.ts → cjs/services/items/schemas/invMast.d.ts} +169 -99
- package/dist/cjs/services/items/schemas/invMast.d.ts.map +1 -0
- package/dist/cjs/services/items/schemas/{products.js → invMast.js} +12 -5
- package/dist/cjs/services/items/schemas/invMast.js.map +1 -0
- package/dist/cjs/services/items/schemas/invMastAlternateCode.d.ts +8 -8
- package/dist/cjs/services/items/schemas/invMastAttributes.d.ts +10 -10
- package/dist/cjs/services/items/schemas/invMastAttributesValues.d.ts +18 -18
- package/dist/cjs/services/items/schemas/invMastFaq.d.ts +45 -45
- package/dist/cjs/services/items/schemas/invMastLinks.d.ts +6 -6
- package/dist/cjs/services/items/schemas/invMastSubParts.d.ts +6 -6
- package/dist/cjs/services/items/schemas/itemCategoryDoc.d.ts +137 -0
- package/dist/cjs/services/items/schemas/itemCategoryDoc.d.ts.map +1 -0
- package/dist/cjs/services/items/schemas/itemCategoryDoc.js +22 -0
- package/dist/cjs/services/items/schemas/itemCategoryDoc.js.map +1 -0
- package/dist/{types/services/items/schemas/wishlists.d.ts → cjs/services/items/schemas/itemWishlist.d.ts} +1 -1
- package/dist/cjs/services/items/schemas/itemWishlist.d.ts.map +1 -0
- package/dist/cjs/services/items/schemas/{wishlists.js → itemWishlist.js} +1 -1
- package/dist/cjs/services/items/schemas/itemWishlist.js.map +1 -0
- package/dist/cjs/services/items/schemas/itemWishlistHdr.d.ts +44 -44
- package/dist/cjs/services/items/schemas/itemWishlistLine.d.ts +16 -16
- package/dist/cjs/services/items/schemas/locationsBins.d.ts +15 -262
- package/dist/cjs/services/items/schemas/locationsBins.d.ts.map +1 -1
- package/dist/cjs/services/items/schemas/locationsBins.js +2 -19
- package/dist/cjs/services/items/schemas/locationsBins.js.map +1 -1
- package/dist/cjs/services/items/schemas/ping.d.ts +49 -0
- package/dist/cjs/services/items/schemas/ping.d.ts.map +1 -0
- package/dist/cjs/services/items/schemas/ping.js +7 -0
- package/dist/cjs/services/items/schemas/ping.js.map +1 -0
- package/dist/cjs/services/items/schemas/productLinks.d.ts +14 -14
- package/dist/cjs/services/items/schemas/subparts.d.ts +18 -18
- package/dist/cjs/services/items/schemas/updateItemAttributeValueRequest.d.ts +22 -0
- package/dist/cjs/services/items/schemas/updateItemAttributeValueRequest.d.ts.map +1 -0
- package/dist/cjs/services/items/schemas/updateItemAttributeValueRequest.js +14 -0
- package/dist/cjs/services/items/schemas/updateItemAttributeValueRequest.js.map +1 -0
- package/dist/cjs/services/items/schemas/variants.d.ts +58 -58
- package/dist/cjs/services/joomla/client.d.ts +696 -771
- package/dist/cjs/services/joomla/client.d.ts.map +1 -1
- package/dist/cjs/services/joomla/client.js +546 -894
- package/dist/cjs/services/joomla/client.js.map +1 -1
- package/dist/cjs/services/joomla/schemas/content.d.ts +285 -11
- package/dist/cjs/services/joomla/schemas/content.d.ts.map +1 -1
- package/dist/cjs/services/joomla/schemas/content.js +41 -11
- package/dist/cjs/services/joomla/schemas/content.js.map +1 -1
- package/dist/cjs/services/joomla/schemas/contentId.d.ts +336 -0
- package/dist/cjs/services/joomla/schemas/contentId.d.ts.map +1 -0
- package/dist/cjs/services/joomla/schemas/contentId.js +47 -0
- package/dist/cjs/services/joomla/schemas/contentId.js.map +1 -0
- package/dist/cjs/services/joomla/schemas/contentIdDoc.d.ts +412 -0
- package/dist/cjs/services/joomla/schemas/contentIdDoc.d.ts.map +1 -0
- package/dist/cjs/services/joomla/schemas/contentIdDoc.js +55 -0
- package/dist/cjs/services/joomla/schemas/contentIdDoc.js.map +1 -0
- package/dist/cjs/services/joomla/schemas/healthCheck.d.ts +85 -0
- package/dist/cjs/services/joomla/schemas/healthCheck.d.ts.map +1 -0
- package/dist/cjs/services/joomla/schemas/healthCheck.js +17 -0
- package/dist/cjs/services/joomla/schemas/healthCheck.js.map +1 -0
- package/dist/cjs/services/joomla/schemas/index.d.ts +16 -2
- package/dist/cjs/services/joomla/schemas/index.d.ts.map +1 -1
- package/dist/cjs/services/joomla/schemas/index.js +27 -8
- package/dist/cjs/services/joomla/schemas/index.js.map +1 -1
- package/dist/cjs/services/joomla/schemas/menuIdDoc.d.ts +295 -0
- package/dist/cjs/services/joomla/schemas/menuIdDoc.d.ts.map +1 -0
- package/dist/cjs/services/joomla/schemas/menuIdDoc.js +38 -0
- package/dist/cjs/services/joomla/schemas/menuIdDoc.js.map +1 -0
- package/dist/cjs/services/joomla/schemas/tags.d.ts +275 -0
- package/dist/cjs/services/joomla/schemas/tags.d.ts.map +1 -0
- package/dist/cjs/services/joomla/schemas/tags.js +43 -0
- package/dist/cjs/services/joomla/schemas/tags.js.map +1 -0
- package/dist/cjs/services/joomla/schemas/userGroups.d.ts +226 -0
- package/dist/cjs/services/joomla/schemas/userGroups.d.ts.map +1 -0
- package/dist/cjs/services/joomla/schemas/userGroups.js +36 -0
- package/dist/cjs/services/joomla/schemas/userGroups.js.map +1 -0
- package/dist/cjs/services/joomla/schemas/users.d.ts +230 -79
- package/dist/cjs/services/joomla/schemas/users.d.ts.map +1 -1
- package/dist/cjs/services/joomla/schemas/users.js +47 -48
- package/dist/cjs/services/joomla/schemas/users.js.map +1 -1
- package/dist/cjs/services/joomla/schemas/usersId.d.ts +531 -0
- package/dist/cjs/services/joomla/schemas/usersId.d.ts.map +1 -0
- package/dist/cjs/services/joomla/schemas/usersId.js +55 -0
- package/dist/cjs/services/joomla/schemas/usersId.js.map +1 -0
- package/dist/cjs/services/joomla/schemas/usersIdDoc.d.ts +327 -0
- package/dist/cjs/services/joomla/schemas/usersIdDoc.d.ts.map +1 -0
- package/dist/cjs/services/joomla/schemas/usersIdDoc.js +42 -0
- package/dist/cjs/services/joomla/schemas/usersIdDoc.js.map +1 -0
- package/dist/cjs/services/joomla/schemas/usersIdGroups.d.ts +260 -0
- package/dist/cjs/services/joomla/schemas/usersIdGroups.d.ts.map +1 -0
- package/dist/cjs/services/joomla/schemas/usersIdGroups.js +44 -0
- package/dist/cjs/services/joomla/schemas/usersIdGroups.js.map +1 -0
- package/dist/cjs/services/joomla/schemas/usersIdGroupsGroupId.d.ts +187 -0
- package/dist/cjs/services/joomla/schemas/usersIdGroupsGroupId.d.ts.map +1 -0
- package/dist/cjs/services/joomla/schemas/usersIdGroupsGroupId.js +28 -0
- package/dist/cjs/services/joomla/schemas/usersIdGroupsGroupId.js.map +1 -0
- package/dist/cjs/services/joomla/schemas/usersIdTrinity.d.ts +460 -0
- package/dist/cjs/services/joomla/schemas/usersIdTrinity.d.ts.map +1 -0
- package/dist/cjs/services/joomla/schemas/usersIdTrinity.js +56 -0
- package/dist/cjs/services/joomla/schemas/usersIdTrinity.js.map +1 -0
- package/dist/cjs/services/joomla/schemas/usersVerifyPassword.d.ts +129 -0
- package/dist/cjs/services/joomla/schemas/usersVerifyPassword.d.ts.map +1 -0
- package/dist/cjs/services/joomla/schemas/usersVerifyPassword.js +27 -0
- package/dist/cjs/services/joomla/schemas/usersVerifyPassword.js.map +1 -0
- package/dist/cjs/services/legacy/schemas/inventory.d.ts +8 -8
- package/dist/cjs/services/nexus/client.d.ts +84 -96
- package/dist/cjs/services/nexus/client.d.ts.map +1 -1
- package/dist/cjs/services/nexus/client.js +66 -78
- package/dist/cjs/services/nexus/client.js.map +1 -1
- package/dist/cjs/services/open-search/client.d.ts +3 -3
- package/dist/cjs/services/open-search/schemas/itemSearch.d.ts +2 -2
- package/dist/cjs/services/open-search/schemas/items.d.ts +10 -10
- package/dist/cjs/services/open-search/schemas/search.d.ts +2 -2
- package/dist/cjs/services/orders/client.d.ts +29 -29
- package/dist/cjs/services/orders/schemas/{health.d.ts → healthCheck.d.ts} +1 -1
- package/dist/cjs/services/orders/schemas/healthCheck.d.ts.map +1 -0
- package/dist/cjs/services/{customers/schemas/health.js → orders/schemas/healthCheck.js} +1 -2
- package/dist/cjs/services/orders/schemas/healthCheck.js.map +1 -0
- package/dist/cjs/services/orders/schemas/index.d.ts +9 -5
- package/dist/cjs/services/orders/schemas/index.d.ts.map +1 -1
- package/dist/cjs/services/orders/schemas/index.js +10 -5
- package/dist/cjs/services/orders/schemas/index.js.map +1 -1
- package/dist/{types/services/orders/schemas/invoices.d.ts → cjs/services/orders/schemas/invoiceHdrReprint.d.ts} +1 -1
- package/dist/cjs/services/orders/schemas/invoiceHdrReprint.d.ts.map +1 -0
- package/dist/cjs/services/orders/schemas/{invoices.js → invoiceHdrReprint.js} +1 -1
- package/dist/cjs/services/orders/schemas/invoiceHdrReprint.js.map +1 -0
- package/dist/{types/services/orders/schemas/orders.d.ts → cjs/services/orders/schemas/oeHdrDoc.d.ts} +45 -233
- package/dist/cjs/services/orders/schemas/oeHdrDoc.d.ts.map +1 -0
- package/dist/cjs/services/orders/schemas/{orders.js → oeHdrDoc.js} +3 -27
- package/dist/cjs/services/orders/schemas/oeHdrDoc.js.map +1 -0
- package/dist/cjs/services/orders/schemas/oeHdrLookup.d.ts +190 -0
- package/dist/cjs/services/orders/schemas/oeHdrLookup.d.ts.map +1 -0
- package/dist/cjs/services/orders/schemas/oeHdrLookup.js +31 -0
- package/dist/cjs/services/orders/schemas/oeHdrLookup.js.map +1 -0
- package/dist/cjs/services/orders/schemas/oeHdrSalesrepOeHdr.d.ts +141 -0
- package/dist/cjs/services/orders/schemas/oeHdrSalesrepOeHdr.d.ts.map +1 -0
- package/dist/cjs/services/orders/schemas/oeHdrSalesrepOeHdr.js +19 -0
- package/dist/cjs/services/orders/schemas/oeHdrSalesrepOeHdr.js.map +1 -0
- package/dist/cjs/services/orders/schemas/{salesrep.d.ts → oeHdrSalesrepOeHdrDoc.d.ts} +9 -148
- package/dist/cjs/services/orders/schemas/oeHdrSalesrepOeHdrDoc.d.ts.map +1 -0
- package/dist/cjs/services/orders/schemas/{salesrep.js → oeHdrSalesrepOeHdrDoc.js} +3 -15
- package/dist/cjs/services/orders/schemas/oeHdrSalesrepOeHdrDoc.js.map +1 -0
- package/dist/{types/services/orders/schemas/purchase-orders.d.ts → cjs/services/orders/schemas/poHdr.d.ts} +49 -692
- package/dist/cjs/services/orders/schemas/poHdr.d.ts.map +1 -0
- package/dist/cjs/services/orders/schemas/{purchase-orders.js → poHdr.js} +2 -51
- package/dist/cjs/services/orders/schemas/poHdr.js.map +1 -0
- package/dist/cjs/services/orders/schemas/poHdrDoc.d.ts +475 -0
- package/dist/cjs/services/orders/schemas/poHdrDoc.d.ts.map +1 -0
- package/dist/cjs/services/orders/schemas/poHdrDoc.js +31 -0
- package/dist/cjs/services/orders/schemas/poHdrDoc.js.map +1 -0
- package/dist/cjs/services/orders/schemas/poHdrScan.d.ts +172 -0
- package/dist/cjs/services/orders/schemas/poHdrScan.d.ts.map +1 -0
- package/dist/cjs/services/orders/schemas/poHdrScan.js +33 -0
- package/dist/cjs/services/orders/schemas/poHdrScan.js.map +1 -0
- package/dist/cjs/services/p21-core/schemas/company.d.ts +2 -2
- package/dist/cjs/services/p21-pim/client.d.ts +1 -1
- package/dist/cjs/services/p21-pim/schemas/podcasts.d.ts +2 -2
- package/dist/cjs/services/payments/schemas/unified.d.ts +2 -2
- package/dist/cjs/services/pricing/schemas/taxEngine.d.ts +6 -6
- package/dist/cjs/services/slack/schemas/webHook.d.ts +8 -8
- package/dist/cjs/services/smarty-streets/schemas/usLookup.d.ts +4 -4
- package/dist/cjs/services/vmi/client.d.ts +4 -4
- package/dist/cjs/services/vmi/schemas/products.d.ts +2 -2
- package/dist/cjs/services/vmi/schemas/warehouse.d.ts +2 -2
- package/dist/cjs/utils/cross-site-auth.d.ts.map +1 -1
- package/dist/cjs/utils/cross-site-auth.js +1 -1
- package/dist/cjs/utils/cross-site-auth.js.map +1 -1
- package/dist/esm/core/schema-factories.d.ts +18 -18
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/esm/services/agr-site/client.d.ts +1 -1
- package/dist/esm/services/agr-site/schemas/content.d.ts +2 -2
- package/dist/esm/services/avalara/client.d.ts +2 -2
- package/dist/esm/services/avalara/schemas.d.ts +56 -56
- package/dist/esm/services/brand-folder/client.d.ts +4 -4
- package/dist/esm/services/brand-folder/schemas.d.ts +16 -16
- package/dist/esm/services/commerce/client.d.ts +2 -2
- package/dist/esm/services/commerce/schemas/cart.d.ts +30 -30
- package/dist/esm/services/commerce/schemas/checkout.d.ts +64 -64
- package/dist/esm/services/commerce/schemas/recommendations.d.ts +8 -8
- package/dist/esm/services/customers/client.d.ts +418 -391
- package/dist/esm/services/customers/client.d.ts.map +1 -1
- package/dist/esm/services/customers/client.js +140 -53
- package/dist/esm/services/customers/client.js.map +1 -1
- package/dist/esm/services/customers/schemas/contactsIdCustomers.d.ts +258 -0
- package/dist/esm/services/customers/schemas/contactsIdCustomers.d.ts.map +1 -0
- package/dist/esm/services/customers/schemas/contactsIdCustomers.js +28 -0
- package/dist/esm/services/customers/schemas/contactsIdCustomers.js.map +1 -0
- package/dist/esm/services/customers/schemas/contactsIdDoc.d.ts +121 -0
- package/dist/esm/services/customers/schemas/contactsIdDoc.d.ts.map +1 -0
- package/dist/esm/services/customers/schemas/contactsIdDoc.js +12 -0
- package/dist/esm/services/customers/schemas/contactsIdDoc.js.map +1 -0
- package/dist/esm/services/customers/schemas/contactsIdWebAllowance.d.ts +101 -0
- package/dist/esm/services/customers/schemas/contactsIdWebAllowance.d.ts.map +1 -0
- package/dist/esm/services/customers/schemas/contactsIdWebAllowance.js +10 -0
- package/dist/esm/services/customers/schemas/contactsIdWebAllowance.js.map +1 -0
- package/dist/esm/services/customers/schemas/contactsRefresh.d.ts +91 -0
- package/dist/esm/services/customers/schemas/contactsRefresh.d.ts.map +1 -0
- package/dist/esm/services/customers/schemas/contactsRefresh.js +9 -0
- package/dist/esm/services/customers/schemas/contactsRefresh.js.map +1 -0
- package/dist/esm/services/customers/schemas/contactsUdId.d.ts +97 -0
- package/dist/esm/services/customers/schemas/contactsUdId.d.ts.map +1 -0
- package/dist/esm/services/customers/schemas/contactsUdId.js +8 -0
- package/dist/esm/services/customers/schemas/contactsUdId.js.map +1 -0
- package/dist/esm/services/customers/schemas/customer.d.ts +261 -0
- package/dist/esm/services/customers/schemas/customer.d.ts.map +1 -0
- package/dist/esm/services/customers/schemas/customer.js +29 -0
- package/dist/esm/services/customers/schemas/customer.js.map +1 -0
- package/dist/esm/services/customers/schemas/customerCustomerIdAddress.d.ts +159 -0
- package/dist/esm/services/customers/schemas/customerCustomerIdAddress.d.ts.map +1 -0
- package/dist/esm/services/customers/schemas/customerCustomerIdAddress.js +19 -0
- package/dist/esm/services/customers/schemas/customerCustomerIdAddress.js.map +1 -0
- package/dist/esm/services/customers/schemas/customerCustomerIdContacts.d.ts +266 -0
- package/dist/esm/services/customers/schemas/customerCustomerIdContacts.d.ts.map +1 -0
- package/dist/esm/services/customers/schemas/customerCustomerIdContacts.js +25 -0
- package/dist/esm/services/customers/schemas/customerCustomerIdContacts.js.map +1 -0
- package/dist/esm/services/customers/schemas/customerCustomerIdDoc.d.ts +237 -0
- package/dist/esm/services/customers/schemas/customerCustomerIdDoc.d.ts.map +1 -0
- package/dist/esm/services/customers/schemas/customerCustomerIdDoc.js +22 -0
- package/dist/esm/services/customers/schemas/customerCustomerIdDoc.js.map +1 -0
- package/dist/esm/services/customers/schemas/customerCustomerIdInvoices.d.ts +192 -0
- package/dist/esm/services/customers/schemas/customerCustomerIdInvoices.d.ts.map +1 -0
- package/dist/esm/services/customers/schemas/customerCustomerIdInvoices.js +23 -0
- package/dist/esm/services/customers/schemas/customerCustomerIdInvoices.js.map +1 -0
- package/dist/esm/services/customers/schemas/customerCustomerIdInvoicesInvoiceNo.d.ts +171 -0
- package/dist/esm/services/customers/schemas/customerCustomerIdInvoicesInvoiceNo.d.ts.map +1 -0
- package/dist/esm/services/customers/schemas/customerCustomerIdInvoicesInvoiceNo.js +17 -0
- package/dist/esm/services/customers/schemas/customerCustomerIdInvoicesInvoiceNo.js.map +1 -0
- package/dist/esm/services/customers/schemas/customerCustomerIdOrders.d.ts +455 -0
- package/dist/esm/services/customers/schemas/customerCustomerIdOrders.d.ts.map +1 -0
- package/dist/esm/services/customers/schemas/customerCustomerIdOrders.js +47 -0
- package/dist/esm/services/customers/schemas/customerCustomerIdOrders.js.map +1 -0
- package/dist/esm/services/customers/schemas/customerCustomerIdOrdersOrderNo.d.ts +269 -0
- package/dist/esm/services/customers/schemas/customerCustomerIdOrdersOrderNo.d.ts.map +1 -0
- package/dist/esm/services/customers/schemas/customerCustomerIdOrdersOrderNo.js +26 -0
- package/dist/esm/services/customers/schemas/customerCustomerIdOrdersOrderNo.js.map +1 -0
- package/dist/esm/services/customers/schemas/customerCustomerIdPurchasedItems.d.ts +139 -0
- package/dist/esm/services/customers/schemas/customerCustomerIdPurchasedItems.d.ts.map +1 -0
- package/dist/esm/services/customers/schemas/customerCustomerIdPurchasedItems.js +17 -0
- package/dist/esm/services/customers/schemas/customerCustomerIdPurchasedItems.js.map +1 -0
- package/dist/esm/services/customers/schemas/customerCustomerIdQuotes.d.ts +159 -0
- package/dist/esm/services/customers/schemas/customerCustomerIdQuotes.d.ts.map +1 -0
- package/dist/esm/services/customers/schemas/customerCustomerIdQuotes.js +19 -0
- package/dist/esm/services/customers/schemas/customerCustomerIdQuotes.js.map +1 -0
- package/dist/esm/services/customers/schemas/customerCustomerIdQuotesQuoteNo.d.ts +249 -0
- package/dist/esm/services/customers/schemas/customerCustomerIdQuotesQuoteNo.d.ts.map +1 -0
- package/dist/esm/services/customers/schemas/customerCustomerIdQuotesQuoteNo.js +24 -0
- package/dist/esm/services/customers/schemas/customerCustomerIdQuotesQuoteNo.js.map +1 -0
- package/dist/esm/services/customers/schemas/customerCustomerIdShipTo.d.ts +329 -0
- package/dist/esm/services/customers/schemas/customerCustomerIdShipTo.d.ts.map +1 -0
- package/dist/esm/services/customers/schemas/customerCustomerIdShipTo.js +32 -0
- package/dist/esm/services/customers/schemas/customerCustomerIdShipTo.js.map +1 -0
- package/dist/esm/services/customers/schemas/customerLookup.d.ts +99 -0
- package/dist/esm/services/customers/schemas/customerLookup.d.ts.map +1 -0
- package/dist/esm/services/customers/schemas/customerLookup.js +13 -0
- package/dist/esm/services/customers/schemas/customerLookup.js.map +1 -0
- package/dist/esm/services/customers/schemas/{health.d.ts → healthCheck.d.ts} +1 -1
- package/dist/esm/services/customers/schemas/healthCheck.d.ts.map +1 -0
- package/dist/esm/services/{orders/schemas/health.js → customers/schemas/healthCheck.js} +1 -1
- package/dist/esm/services/customers/schemas/healthCheck.js.map +1 -0
- package/dist/esm/services/customers/schemas/index.d.ts +245 -8
- package/dist/esm/services/customers/schemas/index.d.ts.map +1 -1
- package/dist/esm/services/customers/schemas/index.js +26 -9
- package/dist/esm/services/customers/schemas/index.js.map +1 -1
- package/dist/esm/services/customers/schemas/oeContactsCustomerRefresh.d.ts +91 -0
- package/dist/esm/services/customers/schemas/oeContactsCustomerRefresh.d.ts.map +1 -0
- package/dist/esm/services/customers/schemas/oeContactsCustomerRefresh.js +9 -0
- package/dist/esm/services/customers/schemas/oeContactsCustomerRefresh.js.map +1 -0
- package/dist/esm/services/customers/schemas/shipToRefresh.d.ts +91 -0
- package/dist/esm/services/customers/schemas/shipToRefresh.d.ts.map +1 -0
- package/dist/esm/services/customers/schemas/shipToRefresh.js +9 -0
- package/dist/esm/services/customers/schemas/shipToRefresh.js.map +1 -0
- package/dist/esm/services/gregorovich/client.d.ts +1 -1
- package/dist/esm/services/gregorovich/schemas/ollamaGenerate.d.ts +4 -4
- package/dist/esm/services/items/client.d.ts +199 -209
- package/dist/esm/services/items/client.d.ts.map +1 -1
- package/dist/esm/services/items/client.js +13 -55
- package/dist/esm/services/items/client.js.map +1 -1
- package/dist/esm/services/items/schemas/attributeGroupsAttributes.d.ts +14 -14
- package/dist/esm/services/items/schemas/bins.d.ts +14 -14
- package/dist/esm/services/items/schemas/brandsItems.d.ts +251 -154
- package/dist/esm/services/items/schemas/brandsItems.d.ts.map +1 -1
- package/dist/esm/services/items/schemas/brandsItems.js +39 -35
- package/dist/esm/services/items/schemas/brandsItems.js.map +1 -1
- package/dist/esm/services/items/schemas/categories.d.ts +82 -240
- package/dist/esm/services/items/schemas/categories.d.ts.map +1 -1
- package/dist/esm/services/items/schemas/categories.js +3 -12
- package/dist/esm/services/items/schemas/categories.js.map +1 -1
- package/dist/esm/services/items/schemas/categoriesAttributes.d.ts +110 -0
- package/dist/esm/services/items/schemas/categoriesAttributes.d.ts.map +1 -0
- package/dist/esm/services/items/schemas/categoriesAttributes.js +12 -0
- package/dist/esm/services/items/schemas/categoriesAttributes.js.map +1 -0
- package/dist/esm/services/items/schemas/faq.d.ts +20 -20
- package/dist/esm/services/items/schemas/healthCheck.d.ts +70 -0
- package/dist/esm/services/items/schemas/healthCheck.d.ts.map +1 -0
- package/dist/esm/services/items/schemas/healthCheck.js +4 -0
- package/dist/esm/services/items/schemas/healthCheck.js.map +1 -0
- package/dist/esm/services/items/schemas/index.d.ts +8 -4
- package/dist/esm/services/items/schemas/index.d.ts.map +1 -1
- package/dist/esm/services/items/schemas/index.js +9 -4
- package/dist/esm/services/items/schemas/index.js.map +1 -1
- package/dist/esm/services/items/schemas/internalPdf.d.ts +8 -8
- package/dist/{types/services/items/schemas/products.d.ts → esm/services/items/schemas/invMast.d.ts} +169 -99
- package/dist/esm/services/items/schemas/invMast.d.ts.map +1 -0
- package/dist/esm/services/items/schemas/{products.js → invMast.js} +12 -5
- package/dist/esm/services/items/schemas/invMast.js.map +1 -0
- package/dist/esm/services/items/schemas/invMastAlternateCode.d.ts +8 -8
- package/dist/esm/services/items/schemas/invMastAttributes.d.ts +10 -10
- package/dist/esm/services/items/schemas/invMastAttributesValues.d.ts +18 -18
- package/dist/esm/services/items/schemas/invMastFaq.d.ts +45 -45
- package/dist/esm/services/items/schemas/invMastLinks.d.ts +6 -6
- package/dist/esm/services/items/schemas/invMastSubParts.d.ts +6 -6
- package/dist/esm/services/items/schemas/itemCategoryDoc.d.ts +137 -0
- package/dist/esm/services/items/schemas/itemCategoryDoc.d.ts.map +1 -0
- package/dist/esm/services/items/schemas/itemCategoryDoc.js +19 -0
- package/dist/esm/services/items/schemas/itemCategoryDoc.js.map +1 -0
- package/dist/esm/services/items/schemas/{wishlists.d.ts → itemWishlist.d.ts} +1 -1
- package/dist/esm/services/items/schemas/itemWishlist.d.ts.map +1 -0
- package/dist/esm/services/items/schemas/{wishlists.js → itemWishlist.js} +1 -1
- package/dist/esm/services/items/schemas/itemWishlist.js.map +1 -0
- package/dist/esm/services/items/schemas/itemWishlistHdr.d.ts +44 -44
- package/dist/esm/services/items/schemas/itemWishlistLine.d.ts +16 -16
- package/dist/esm/services/items/schemas/locationsBins.d.ts +15 -262
- package/dist/esm/services/items/schemas/locationsBins.d.ts.map +1 -1
- package/dist/esm/services/items/schemas/locationsBins.js +2 -19
- package/dist/esm/services/items/schemas/locationsBins.js.map +1 -1
- package/dist/esm/services/items/schemas/ping.d.ts +49 -0
- package/dist/esm/services/items/schemas/ping.d.ts.map +1 -0
- package/dist/esm/services/items/schemas/ping.js +4 -0
- package/dist/esm/services/items/schemas/ping.js.map +1 -0
- package/dist/esm/services/items/schemas/productLinks.d.ts +14 -14
- package/dist/esm/services/items/schemas/subparts.d.ts +18 -18
- package/dist/esm/services/items/schemas/updateItemAttributeValueRequest.d.ts +22 -0
- package/dist/esm/services/items/schemas/updateItemAttributeValueRequest.d.ts.map +1 -0
- package/dist/esm/services/items/schemas/updateItemAttributeValueRequest.js +11 -0
- package/dist/esm/services/items/schemas/updateItemAttributeValueRequest.js.map +1 -0
- package/dist/esm/services/items/schemas/variants.d.ts +58 -58
- package/dist/esm/services/joomla/client.d.ts +696 -771
- package/dist/esm/services/joomla/client.d.ts.map +1 -1
- package/dist/esm/services/joomla/client.js +550 -900
- package/dist/esm/services/joomla/client.js.map +1 -1
- package/dist/esm/services/joomla/schemas/content.d.ts +285 -11
- package/dist/esm/services/joomla/schemas/content.d.ts.map +1 -1
- package/dist/esm/services/joomla/schemas/content.js +39 -11
- package/dist/esm/services/joomla/schemas/content.js.map +1 -1
- package/dist/esm/services/joomla/schemas/contentId.d.ts +336 -0
- package/dist/esm/services/joomla/schemas/contentId.d.ts.map +1 -0
- package/dist/esm/services/joomla/schemas/contentId.js +44 -0
- package/dist/esm/services/joomla/schemas/contentId.js.map +1 -0
- package/dist/esm/services/joomla/schemas/contentIdDoc.d.ts +412 -0
- package/dist/esm/services/joomla/schemas/contentIdDoc.d.ts.map +1 -0
- package/dist/esm/services/joomla/schemas/contentIdDoc.js +52 -0
- package/dist/esm/services/joomla/schemas/contentIdDoc.js.map +1 -0
- package/dist/esm/services/joomla/schemas/healthCheck.d.ts +85 -0
- package/dist/esm/services/joomla/schemas/healthCheck.d.ts.map +1 -0
- package/dist/esm/services/joomla/schemas/healthCheck.js +14 -0
- package/dist/esm/services/joomla/schemas/healthCheck.js.map +1 -0
- package/dist/esm/services/joomla/schemas/index.d.ts +16 -2
- package/dist/esm/services/joomla/schemas/index.d.ts.map +1 -1
- package/dist/esm/services/joomla/schemas/index.js +20 -7
- package/dist/esm/services/joomla/schemas/index.js.map +1 -1
- package/dist/esm/services/joomla/schemas/menuIdDoc.d.ts +295 -0
- package/dist/esm/services/joomla/schemas/menuIdDoc.d.ts.map +1 -0
- package/dist/esm/services/joomla/schemas/menuIdDoc.js +35 -0
- package/dist/esm/services/joomla/schemas/menuIdDoc.js.map +1 -0
- package/dist/esm/services/joomla/schemas/tags.d.ts +275 -0
- package/dist/esm/services/joomla/schemas/tags.d.ts.map +1 -0
- package/dist/esm/services/joomla/schemas/tags.js +40 -0
- package/dist/esm/services/joomla/schemas/tags.js.map +1 -0
- package/dist/esm/services/joomla/schemas/userGroups.d.ts +226 -0
- package/dist/esm/services/joomla/schemas/userGroups.d.ts.map +1 -0
- package/dist/esm/services/joomla/schemas/userGroups.js +33 -0
- package/dist/esm/services/joomla/schemas/userGroups.js.map +1 -0
- package/dist/esm/services/joomla/schemas/users.d.ts +230 -79
- package/dist/esm/services/joomla/schemas/users.d.ts.map +1 -1
- package/dist/esm/services/joomla/schemas/users.js +46 -47
- package/dist/esm/services/joomla/schemas/users.js.map +1 -1
- package/dist/esm/services/joomla/schemas/usersId.d.ts +531 -0
- package/dist/esm/services/joomla/schemas/usersId.d.ts.map +1 -0
- package/dist/esm/services/joomla/schemas/usersId.js +52 -0
- package/dist/esm/services/joomla/schemas/usersId.js.map +1 -0
- package/dist/esm/services/joomla/schemas/usersIdDoc.d.ts +327 -0
- package/dist/esm/services/joomla/schemas/usersIdDoc.d.ts.map +1 -0
- package/dist/esm/services/joomla/schemas/usersIdDoc.js +39 -0
- package/dist/esm/services/joomla/schemas/usersIdDoc.js.map +1 -0
- package/dist/esm/services/joomla/schemas/usersIdGroups.d.ts +260 -0
- package/dist/esm/services/joomla/schemas/usersIdGroups.d.ts.map +1 -0
- package/dist/esm/services/joomla/schemas/usersIdGroups.js +41 -0
- package/dist/esm/services/joomla/schemas/usersIdGroups.js.map +1 -0
- package/dist/esm/services/joomla/schemas/usersIdGroupsGroupId.d.ts +187 -0
- package/dist/esm/services/joomla/schemas/usersIdGroupsGroupId.d.ts.map +1 -0
- package/dist/esm/services/joomla/schemas/usersIdGroupsGroupId.js +25 -0
- package/dist/esm/services/joomla/schemas/usersIdGroupsGroupId.js.map +1 -0
- package/dist/esm/services/joomla/schemas/usersIdTrinity.d.ts +460 -0
- package/dist/esm/services/joomla/schemas/usersIdTrinity.d.ts.map +1 -0
- package/dist/esm/services/joomla/schemas/usersIdTrinity.js +53 -0
- package/dist/esm/services/joomla/schemas/usersIdTrinity.js.map +1 -0
- package/dist/esm/services/joomla/schemas/usersVerifyPassword.d.ts +129 -0
- package/dist/esm/services/joomla/schemas/usersVerifyPassword.d.ts.map +1 -0
- package/dist/esm/services/joomla/schemas/usersVerifyPassword.js +24 -0
- package/dist/esm/services/joomla/schemas/usersVerifyPassword.js.map +1 -0
- package/dist/esm/services/legacy/schemas/inventory.d.ts +8 -8
- package/dist/esm/services/nexus/client.d.ts +84 -96
- package/dist/esm/services/nexus/client.d.ts.map +1 -1
- package/dist/esm/services/nexus/client.js +66 -78
- package/dist/esm/services/nexus/client.js.map +1 -1
- package/dist/esm/services/open-search/client.d.ts +3 -3
- package/dist/esm/services/open-search/schemas/itemSearch.d.ts +2 -2
- package/dist/esm/services/open-search/schemas/items.d.ts +10 -10
- package/dist/esm/services/open-search/schemas/search.d.ts +2 -2
- package/dist/esm/services/orders/client.d.ts +29 -29
- package/dist/esm/services/orders/schemas/healthCheck.d.ts +70 -0
- package/dist/esm/services/orders/schemas/healthCheck.d.ts.map +1 -0
- package/dist/esm/services/{customers/schemas/health.js → orders/schemas/healthCheck.js} +1 -2
- package/dist/esm/services/orders/schemas/healthCheck.js.map +1 -0
- package/dist/esm/services/orders/schemas/index.d.ts +9 -5
- package/dist/esm/services/orders/schemas/index.d.ts.map +1 -1
- package/dist/esm/services/orders/schemas/index.js +10 -5
- package/dist/esm/services/orders/schemas/index.js.map +1 -1
- package/dist/{cjs/services/orders/schemas/invoices.d.ts → esm/services/orders/schemas/invoiceHdrReprint.d.ts} +1 -1
- package/dist/esm/services/orders/schemas/invoiceHdrReprint.d.ts.map +1 -0
- package/dist/esm/services/orders/schemas/{invoices.js → invoiceHdrReprint.js} +1 -1
- package/dist/esm/services/orders/schemas/invoiceHdrReprint.js.map +1 -0
- package/dist/esm/services/orders/schemas/{orders.d.ts → oeHdrDoc.d.ts} +45 -233
- package/dist/esm/services/orders/schemas/oeHdrDoc.d.ts.map +1 -0
- package/dist/esm/services/orders/schemas/{orders.js → oeHdrDoc.js} +3 -27
- package/dist/esm/services/orders/schemas/oeHdrDoc.js.map +1 -0
- package/dist/esm/services/orders/schemas/oeHdrLookup.d.ts +190 -0
- package/dist/esm/services/orders/schemas/oeHdrLookup.d.ts.map +1 -0
- package/dist/esm/services/orders/schemas/oeHdrLookup.js +28 -0
- package/dist/esm/services/orders/schemas/oeHdrLookup.js.map +1 -0
- package/dist/esm/services/orders/schemas/oeHdrSalesrepOeHdr.d.ts +141 -0
- package/dist/esm/services/orders/schemas/oeHdrSalesrepOeHdr.d.ts.map +1 -0
- package/dist/esm/services/orders/schemas/oeHdrSalesrepOeHdr.js +16 -0
- package/dist/esm/services/orders/schemas/oeHdrSalesrepOeHdr.js.map +1 -0
- package/dist/esm/services/orders/schemas/{salesrep.d.ts → oeHdrSalesrepOeHdrDoc.d.ts} +9 -148
- package/dist/esm/services/orders/schemas/oeHdrSalesrepOeHdrDoc.d.ts.map +1 -0
- package/dist/esm/services/orders/schemas/{salesrep.js → oeHdrSalesrepOeHdrDoc.js} +2 -14
- package/dist/esm/services/orders/schemas/oeHdrSalesrepOeHdrDoc.js.map +1 -0
- package/dist/{cjs/services/orders/schemas/purchase-orders.d.ts → esm/services/orders/schemas/poHdr.d.ts} +49 -692
- package/dist/esm/services/orders/schemas/poHdr.d.ts.map +1 -0
- package/dist/esm/services/orders/schemas/{purchase-orders.js → poHdr.js} +1 -50
- package/dist/esm/services/orders/schemas/poHdr.js.map +1 -0
- package/dist/esm/services/orders/schemas/poHdrDoc.d.ts +475 -0
- package/dist/esm/services/orders/schemas/poHdrDoc.d.ts.map +1 -0
- package/dist/esm/services/orders/schemas/poHdrDoc.js +28 -0
- package/dist/esm/services/orders/schemas/poHdrDoc.js.map +1 -0
- package/dist/esm/services/orders/schemas/poHdrScan.d.ts +172 -0
- package/dist/esm/services/orders/schemas/poHdrScan.d.ts.map +1 -0
- package/dist/esm/services/orders/schemas/poHdrScan.js +30 -0
- package/dist/esm/services/orders/schemas/poHdrScan.js.map +1 -0
- package/dist/esm/services/p21-core/schemas/company.d.ts +2 -2
- package/dist/esm/services/p21-pim/client.d.ts +1 -1
- package/dist/esm/services/p21-pim/schemas/podcasts.d.ts +2 -2
- package/dist/esm/services/payments/schemas/unified.d.ts +2 -2
- package/dist/esm/services/pricing/schemas/taxEngine.d.ts +6 -6
- package/dist/esm/services/slack/schemas/webHook.d.ts +8 -8
- package/dist/esm/services/smarty-streets/schemas/usLookup.d.ts +4 -4
- package/dist/esm/services/vmi/client.d.ts +4 -4
- package/dist/esm/services/vmi/schemas/products.d.ts +2 -2
- package/dist/esm/services/vmi/schemas/warehouse.d.ts +2 -2
- package/dist/esm/utils/cross-site-auth.d.ts.map +1 -1
- package/dist/esm/utils/cross-site-auth.js +1 -1
- package/dist/esm/utils/cross-site-auth.js.map +1 -1
- package/dist/types/core/schema-factories.d.ts +18 -18
- package/dist/types/index.d.ts +1 -1
- package/dist/types/services/agr-site/client.d.ts +1 -1
- package/dist/types/services/agr-site/schemas/content.d.ts +2 -2
- package/dist/types/services/avalara/client.d.ts +2 -2
- package/dist/types/services/avalara/schemas.d.ts +56 -56
- package/dist/types/services/brand-folder/client.d.ts +4 -4
- package/dist/types/services/brand-folder/schemas.d.ts +16 -16
- package/dist/types/services/commerce/client.d.ts +2 -2
- package/dist/types/services/commerce/schemas/cart.d.ts +30 -30
- package/dist/types/services/commerce/schemas/checkout.d.ts +64 -64
- package/dist/types/services/commerce/schemas/recommendations.d.ts +8 -8
- package/dist/types/services/customers/client.d.ts +418 -391
- package/dist/types/services/customers/client.d.ts.map +1 -1
- package/dist/types/services/customers/schemas/contactsIdCustomers.d.ts +258 -0
- package/dist/types/services/customers/schemas/contactsIdCustomers.d.ts.map +1 -0
- package/dist/types/services/customers/schemas/contactsIdDoc.d.ts +121 -0
- package/dist/types/services/customers/schemas/contactsIdDoc.d.ts.map +1 -0
- package/dist/types/services/customers/schemas/contactsIdWebAllowance.d.ts +101 -0
- package/dist/types/services/customers/schemas/contactsIdWebAllowance.d.ts.map +1 -0
- package/dist/types/services/customers/schemas/contactsRefresh.d.ts +91 -0
- package/dist/types/services/customers/schemas/contactsRefresh.d.ts.map +1 -0
- package/dist/types/services/customers/schemas/contactsUdId.d.ts +97 -0
- package/dist/types/services/customers/schemas/contactsUdId.d.ts.map +1 -0
- package/dist/types/services/customers/schemas/customer.d.ts +261 -0
- package/dist/types/services/customers/schemas/customer.d.ts.map +1 -0
- package/dist/types/services/customers/schemas/customerCustomerIdAddress.d.ts +159 -0
- package/dist/types/services/customers/schemas/customerCustomerIdAddress.d.ts.map +1 -0
- package/dist/types/services/customers/schemas/customerCustomerIdContacts.d.ts +266 -0
- package/dist/types/services/customers/schemas/customerCustomerIdContacts.d.ts.map +1 -0
- package/dist/types/services/customers/schemas/customerCustomerIdDoc.d.ts +237 -0
- package/dist/types/services/customers/schemas/customerCustomerIdDoc.d.ts.map +1 -0
- package/dist/types/services/customers/schemas/customerCustomerIdInvoices.d.ts +192 -0
- package/dist/types/services/customers/schemas/customerCustomerIdInvoices.d.ts.map +1 -0
- package/dist/types/services/customers/schemas/customerCustomerIdInvoicesInvoiceNo.d.ts +171 -0
- package/dist/types/services/customers/schemas/customerCustomerIdInvoicesInvoiceNo.d.ts.map +1 -0
- package/dist/types/services/customers/schemas/customerCustomerIdOrders.d.ts +455 -0
- package/dist/types/services/customers/schemas/customerCustomerIdOrders.d.ts.map +1 -0
- package/dist/types/services/customers/schemas/customerCustomerIdOrdersOrderNo.d.ts +269 -0
- package/dist/types/services/customers/schemas/customerCustomerIdOrdersOrderNo.d.ts.map +1 -0
- package/dist/types/services/customers/schemas/customerCustomerIdPurchasedItems.d.ts +139 -0
- package/dist/types/services/customers/schemas/customerCustomerIdPurchasedItems.d.ts.map +1 -0
- package/dist/types/services/customers/schemas/customerCustomerIdQuotes.d.ts +159 -0
- package/dist/types/services/customers/schemas/customerCustomerIdQuotes.d.ts.map +1 -0
- package/dist/types/services/customers/schemas/customerCustomerIdQuotesQuoteNo.d.ts +249 -0
- package/dist/types/services/customers/schemas/customerCustomerIdQuotesQuoteNo.d.ts.map +1 -0
- package/dist/types/services/customers/schemas/customerCustomerIdShipTo.d.ts +329 -0
- package/dist/types/services/customers/schemas/customerCustomerIdShipTo.d.ts.map +1 -0
- package/dist/types/services/customers/schemas/customerLookup.d.ts +99 -0
- package/dist/types/services/customers/schemas/customerLookup.d.ts.map +1 -0
- package/dist/types/services/customers/schemas/healthCheck.d.ts +70 -0
- package/dist/types/services/customers/schemas/healthCheck.d.ts.map +1 -0
- package/dist/types/services/customers/schemas/index.d.ts +245 -8
- package/dist/types/services/customers/schemas/index.d.ts.map +1 -1
- package/dist/types/services/customers/schemas/oeContactsCustomerRefresh.d.ts +91 -0
- package/dist/types/services/customers/schemas/oeContactsCustomerRefresh.d.ts.map +1 -0
- package/dist/types/services/customers/schemas/shipToRefresh.d.ts +91 -0
- package/dist/types/services/customers/schemas/shipToRefresh.d.ts.map +1 -0
- package/dist/types/services/gregorovich/client.d.ts +1 -1
- package/dist/types/services/gregorovich/schemas/ollamaGenerate.d.ts +4 -4
- package/dist/types/services/items/client.d.ts +199 -209
- package/dist/types/services/items/client.d.ts.map +1 -1
- package/dist/types/services/items/schemas/attributeGroupsAttributes.d.ts +14 -14
- package/dist/types/services/items/schemas/bins.d.ts +14 -14
- package/dist/types/services/items/schemas/brandsItems.d.ts +251 -154
- package/dist/types/services/items/schemas/brandsItems.d.ts.map +1 -1
- package/dist/types/services/items/schemas/categories.d.ts +82 -240
- package/dist/types/services/items/schemas/categories.d.ts.map +1 -1
- package/dist/types/services/items/schemas/categoriesAttributes.d.ts +110 -0
- package/dist/types/services/items/schemas/categoriesAttributes.d.ts.map +1 -0
- package/dist/types/services/items/schemas/faq.d.ts +20 -20
- package/dist/types/services/items/schemas/healthCheck.d.ts +70 -0
- package/dist/types/services/items/schemas/healthCheck.d.ts.map +1 -0
- package/dist/types/services/items/schemas/index.d.ts +8 -4
- package/dist/types/services/items/schemas/index.d.ts.map +1 -1
- package/dist/types/services/items/schemas/internalPdf.d.ts +8 -8
- package/dist/{cjs/services/items/schemas/products.d.ts → types/services/items/schemas/invMast.d.ts} +169 -99
- package/dist/types/services/items/schemas/invMast.d.ts.map +1 -0
- package/dist/types/services/items/schemas/invMastAlternateCode.d.ts +8 -8
- package/dist/types/services/items/schemas/invMastAttributes.d.ts +10 -10
- package/dist/types/services/items/schemas/invMastAttributesValues.d.ts +18 -18
- package/dist/types/services/items/schemas/invMastFaq.d.ts +45 -45
- package/dist/types/services/items/schemas/invMastLinks.d.ts +6 -6
- package/dist/types/services/items/schemas/invMastSubParts.d.ts +6 -6
- package/dist/types/services/items/schemas/itemCategoryDoc.d.ts +137 -0
- package/dist/types/services/items/schemas/itemCategoryDoc.d.ts.map +1 -0
- package/dist/{cjs/services/items/schemas/wishlists.d.ts → types/services/items/schemas/itemWishlist.d.ts} +1 -1
- package/dist/types/services/items/schemas/itemWishlist.d.ts.map +1 -0
- package/dist/types/services/items/schemas/itemWishlistHdr.d.ts +44 -44
- package/dist/types/services/items/schemas/itemWishlistLine.d.ts +16 -16
- package/dist/types/services/items/schemas/locationsBins.d.ts +15 -262
- package/dist/types/services/items/schemas/locationsBins.d.ts.map +1 -1
- package/dist/types/services/items/schemas/ping.d.ts +49 -0
- package/dist/types/services/items/schemas/ping.d.ts.map +1 -0
- package/dist/types/services/items/schemas/productLinks.d.ts +14 -14
- package/dist/types/services/items/schemas/subparts.d.ts +18 -18
- package/dist/types/services/items/schemas/updateItemAttributeValueRequest.d.ts +22 -0
- package/dist/types/services/items/schemas/updateItemAttributeValueRequest.d.ts.map +1 -0
- package/dist/types/services/items/schemas/variants.d.ts +58 -58
- package/dist/types/services/joomla/client.d.ts +696 -771
- package/dist/types/services/joomla/client.d.ts.map +1 -1
- package/dist/types/services/joomla/schemas/content.d.ts +285 -11
- package/dist/types/services/joomla/schemas/content.d.ts.map +1 -1
- package/dist/types/services/joomla/schemas/contentId.d.ts +336 -0
- package/dist/types/services/joomla/schemas/contentId.d.ts.map +1 -0
- package/dist/types/services/joomla/schemas/contentIdDoc.d.ts +412 -0
- package/dist/types/services/joomla/schemas/contentIdDoc.d.ts.map +1 -0
- package/dist/types/services/joomla/schemas/healthCheck.d.ts +85 -0
- package/dist/types/services/joomla/schemas/healthCheck.d.ts.map +1 -0
- package/dist/types/services/joomla/schemas/index.d.ts +16 -2
- package/dist/types/services/joomla/schemas/index.d.ts.map +1 -1
- package/dist/types/services/joomla/schemas/menuIdDoc.d.ts +295 -0
- package/dist/types/services/joomla/schemas/menuIdDoc.d.ts.map +1 -0
- package/dist/types/services/joomla/schemas/tags.d.ts +275 -0
- package/dist/types/services/joomla/schemas/tags.d.ts.map +1 -0
- package/dist/types/services/joomla/schemas/userGroups.d.ts +226 -0
- package/dist/types/services/joomla/schemas/userGroups.d.ts.map +1 -0
- package/dist/types/services/joomla/schemas/users.d.ts +230 -79
- package/dist/types/services/joomla/schemas/users.d.ts.map +1 -1
- package/dist/types/services/joomla/schemas/usersId.d.ts +531 -0
- package/dist/types/services/joomla/schemas/usersId.d.ts.map +1 -0
- package/dist/types/services/joomla/schemas/usersIdDoc.d.ts +327 -0
- package/dist/types/services/joomla/schemas/usersIdDoc.d.ts.map +1 -0
- package/dist/types/services/joomla/schemas/usersIdGroups.d.ts +260 -0
- package/dist/types/services/joomla/schemas/usersIdGroups.d.ts.map +1 -0
- package/dist/types/services/joomla/schemas/usersIdGroupsGroupId.d.ts +187 -0
- package/dist/types/services/joomla/schemas/usersIdGroupsGroupId.d.ts.map +1 -0
- package/dist/types/services/joomla/schemas/usersIdTrinity.d.ts +460 -0
- package/dist/types/services/joomla/schemas/usersIdTrinity.d.ts.map +1 -0
- package/dist/types/services/joomla/schemas/usersVerifyPassword.d.ts +129 -0
- package/dist/types/services/joomla/schemas/usersVerifyPassword.d.ts.map +1 -0
- package/dist/types/services/legacy/schemas/inventory.d.ts +8 -8
- package/dist/types/services/nexus/client.d.ts +84 -96
- package/dist/types/services/nexus/client.d.ts.map +1 -1
- package/dist/types/services/open-search/client.d.ts +3 -3
- package/dist/types/services/open-search/schemas/itemSearch.d.ts +2 -2
- package/dist/types/services/open-search/schemas/items.d.ts +10 -10
- package/dist/types/services/open-search/schemas/search.d.ts +2 -2
- package/dist/types/services/orders/client.d.ts +29 -29
- package/dist/types/services/orders/schemas/healthCheck.d.ts +70 -0
- package/dist/types/services/orders/schemas/healthCheck.d.ts.map +1 -0
- package/dist/types/services/orders/schemas/index.d.ts +9 -5
- package/dist/types/services/orders/schemas/index.d.ts.map +1 -1
- package/dist/{esm/services/orders/schemas/invoices.d.ts → types/services/orders/schemas/invoiceHdrReprint.d.ts} +1 -1
- package/dist/types/services/orders/schemas/invoiceHdrReprint.d.ts.map +1 -0
- package/dist/{cjs/services/orders/schemas/orders.d.ts → types/services/orders/schemas/oeHdrDoc.d.ts} +45 -233
- package/dist/types/services/orders/schemas/oeHdrDoc.d.ts.map +1 -0
- package/dist/types/services/orders/schemas/oeHdrLookup.d.ts +190 -0
- package/dist/types/services/orders/schemas/oeHdrLookup.d.ts.map +1 -0
- package/dist/types/services/orders/schemas/oeHdrSalesrepOeHdr.d.ts +141 -0
- package/dist/types/services/orders/schemas/oeHdrSalesrepOeHdr.d.ts.map +1 -0
- package/dist/types/services/orders/schemas/{salesrep.d.ts → oeHdrSalesrepOeHdrDoc.d.ts} +9 -148
- package/dist/types/services/orders/schemas/oeHdrSalesrepOeHdrDoc.d.ts.map +1 -0
- package/dist/{esm/services/orders/schemas/purchase-orders.d.ts → types/services/orders/schemas/poHdr.d.ts} +49 -692
- package/dist/types/services/orders/schemas/poHdr.d.ts.map +1 -0
- package/dist/types/services/orders/schemas/poHdrDoc.d.ts +475 -0
- package/dist/types/services/orders/schemas/poHdrDoc.d.ts.map +1 -0
- package/dist/types/services/orders/schemas/poHdrScan.d.ts +172 -0
- package/dist/types/services/orders/schemas/poHdrScan.d.ts.map +1 -0
- package/dist/types/services/p21-core/schemas/company.d.ts +2 -2
- package/dist/types/services/p21-pim/client.d.ts +1 -1
- package/dist/types/services/p21-pim/schemas/podcasts.d.ts +2 -2
- package/dist/types/services/payments/schemas/unified.d.ts +2 -2
- package/dist/types/services/pricing/schemas/taxEngine.d.ts +6 -6
- package/dist/types/services/slack/schemas/webHook.d.ts +8 -8
- package/dist/types/services/smarty-streets/schemas/usLookup.d.ts +4 -4
- package/dist/types/services/vmi/client.d.ts +4 -4
- package/dist/types/services/vmi/schemas/products.d.ts +2 -2
- package/dist/types/services/vmi/schemas/warehouse.d.ts +2 -2
- package/dist/types/utils/cross-site-auth.d.ts.map +1 -1
- package/package.json +1 -1
- package/dist/cjs/services/customers/schemas/addresses.d.ts +0 -862
- package/dist/cjs/services/customers/schemas/addresses.d.ts.map +0 -1
- package/dist/cjs/services/customers/schemas/addresses.js +0 -75
- package/dist/cjs/services/customers/schemas/addresses.js.map +0 -1
- package/dist/cjs/services/customers/schemas/contacts.d.ts +0 -859
- package/dist/cjs/services/customers/schemas/contacts.d.ts.map +0 -1
- package/dist/cjs/services/customers/schemas/contacts.js +0 -85
- package/dist/cjs/services/customers/schemas/contacts.js.map +0 -1
- package/dist/cjs/services/customers/schemas/customers.d.ts +0 -1111
- package/dist/cjs/services/customers/schemas/customers.d.ts.map +0 -1
- package/dist/cjs/services/customers/schemas/customers.js +0 -102
- package/dist/cjs/services/customers/schemas/customers.js.map +0 -1
- package/dist/cjs/services/customers/schemas/health.d.ts.map +0 -1
- package/dist/cjs/services/customers/schemas/health.js.map +0 -1
- package/dist/cjs/services/customers/schemas/invoices.d.ts +0 -1029
- package/dist/cjs/services/customers/schemas/invoices.d.ts.map +0 -1
- package/dist/cjs/services/customers/schemas/invoices.js +0 -66
- package/dist/cjs/services/customers/schemas/invoices.js.map +0 -1
- package/dist/cjs/services/customers/schemas/orders.d.ts +0 -2208
- package/dist/cjs/services/customers/schemas/orders.d.ts.map +0 -1
- package/dist/cjs/services/customers/schemas/orders.js +0 -116
- package/dist/cjs/services/customers/schemas/orders.js.map +0 -1
- package/dist/cjs/services/customers/schemas/purchased-items.d.ts +0 -169
- package/dist/cjs/services/customers/schemas/purchased-items.d.ts.map +0 -1
- package/dist/cjs/services/customers/schemas/purchased-items.js +0 -26
- package/dist/cjs/services/customers/schemas/purchased-items.js.map +0 -1
- package/dist/cjs/services/customers/schemas/quotes.d.ts +0 -2395
- package/dist/cjs/services/customers/schemas/quotes.d.ts.map +0 -1
- package/dist/cjs/services/customers/schemas/quotes.js +0 -117
- package/dist/cjs/services/customers/schemas/quotes.js.map +0 -1
- package/dist/cjs/services/items/schemas/brandItems.d.ts +0 -401
- package/dist/cjs/services/items/schemas/brandItems.d.ts.map +0 -1
- package/dist/cjs/services/items/schemas/brandItems.js +0 -48
- package/dist/cjs/services/items/schemas/brandItems.js.map +0 -1
- package/dist/cjs/services/items/schemas/categoriesImages.d.ts +0 -127
- package/dist/cjs/services/items/schemas/categoriesImages.d.ts.map +0 -1
- package/dist/cjs/services/items/schemas/categoriesImages.js +0 -24
- package/dist/cjs/services/items/schemas/categoriesImages.js.map +0 -1
- package/dist/cjs/services/items/schemas/health.d.ts +0 -117
- package/dist/cjs/services/items/schemas/health.d.ts.map +0 -1
- package/dist/cjs/services/items/schemas/health.js.map +0 -1
- package/dist/cjs/services/items/schemas/products.d.ts.map +0 -1
- package/dist/cjs/services/items/schemas/products.js.map +0 -1
- package/dist/cjs/services/items/schemas/wishlists.d.ts.map +0 -1
- package/dist/cjs/services/items/schemas/wishlists.js.map +0 -1
- package/dist/cjs/services/joomla/schemas/groups.d.ts +0 -12
- package/dist/cjs/services/joomla/schemas/groups.d.ts.map +0 -1
- package/dist/cjs/services/joomla/schemas/groups.js +0 -13
- package/dist/cjs/services/joomla/schemas/groups.js.map +0 -1
- package/dist/cjs/services/orders/schemas/health.d.ts.map +0 -1
- package/dist/cjs/services/orders/schemas/health.js.map +0 -1
- package/dist/cjs/services/orders/schemas/invoices.d.ts.map +0 -1
- package/dist/cjs/services/orders/schemas/invoices.js.map +0 -1
- package/dist/cjs/services/orders/schemas/orders.d.ts.map +0 -1
- package/dist/cjs/services/orders/schemas/orders.js.map +0 -1
- package/dist/cjs/services/orders/schemas/purchase-orders.d.ts.map +0 -1
- package/dist/cjs/services/orders/schemas/purchase-orders.js.map +0 -1
- package/dist/cjs/services/orders/schemas/salesrep.d.ts.map +0 -1
- package/dist/cjs/services/orders/schemas/salesrep.js.map +0 -1
- package/dist/esm/services/customers/schemas/addresses.d.ts +0 -862
- package/dist/esm/services/customers/schemas/addresses.d.ts.map +0 -1
- package/dist/esm/services/customers/schemas/addresses.js +0 -72
- package/dist/esm/services/customers/schemas/addresses.js.map +0 -1
- package/dist/esm/services/customers/schemas/contacts.d.ts +0 -859
- package/dist/esm/services/customers/schemas/contacts.d.ts.map +0 -1
- package/dist/esm/services/customers/schemas/contacts.js +0 -82
- package/dist/esm/services/customers/schemas/contacts.js.map +0 -1
- package/dist/esm/services/customers/schemas/customers.d.ts +0 -1111
- package/dist/esm/services/customers/schemas/customers.d.ts.map +0 -1
- package/dist/esm/services/customers/schemas/customers.js +0 -99
- package/dist/esm/services/customers/schemas/customers.js.map +0 -1
- package/dist/esm/services/customers/schemas/health.d.ts.map +0 -1
- package/dist/esm/services/customers/schemas/health.js.map +0 -1
- package/dist/esm/services/customers/schemas/invoices.d.ts +0 -1029
- package/dist/esm/services/customers/schemas/invoices.d.ts.map +0 -1
- package/dist/esm/services/customers/schemas/invoices.js +0 -63
- package/dist/esm/services/customers/schemas/invoices.js.map +0 -1
- package/dist/esm/services/customers/schemas/orders.d.ts +0 -2208
- package/dist/esm/services/customers/schemas/orders.d.ts.map +0 -1
- package/dist/esm/services/customers/schemas/orders.js +0 -113
- package/dist/esm/services/customers/schemas/orders.js.map +0 -1
- package/dist/esm/services/customers/schemas/purchased-items.d.ts +0 -169
- package/dist/esm/services/customers/schemas/purchased-items.d.ts.map +0 -1
- package/dist/esm/services/customers/schemas/purchased-items.js +0 -23
- package/dist/esm/services/customers/schemas/purchased-items.js.map +0 -1
- package/dist/esm/services/customers/schemas/quotes.d.ts +0 -2395
- package/dist/esm/services/customers/schemas/quotes.d.ts.map +0 -1
- package/dist/esm/services/customers/schemas/quotes.js +0 -114
- package/dist/esm/services/customers/schemas/quotes.js.map +0 -1
- package/dist/esm/services/items/schemas/brandItems.d.ts +0 -401
- package/dist/esm/services/items/schemas/brandItems.d.ts.map +0 -1
- package/dist/esm/services/items/schemas/brandItems.js +0 -45
- package/dist/esm/services/items/schemas/brandItems.js.map +0 -1
- package/dist/esm/services/items/schemas/categoriesImages.d.ts +0 -127
- package/dist/esm/services/items/schemas/categoriesImages.d.ts.map +0 -1
- package/dist/esm/services/items/schemas/categoriesImages.js +0 -21
- package/dist/esm/services/items/schemas/categoriesImages.js.map +0 -1
- package/dist/esm/services/items/schemas/health.d.ts +0 -117
- package/dist/esm/services/items/schemas/health.d.ts.map +0 -1
- package/dist/esm/services/items/schemas/health.js +0 -6
- package/dist/esm/services/items/schemas/health.js.map +0 -1
- package/dist/esm/services/items/schemas/products.d.ts.map +0 -1
- package/dist/esm/services/items/schemas/products.js.map +0 -1
- package/dist/esm/services/items/schemas/wishlists.d.ts.map +0 -1
- package/dist/esm/services/items/schemas/wishlists.js.map +0 -1
- package/dist/esm/services/joomla/schemas/groups.d.ts +0 -12
- package/dist/esm/services/joomla/schemas/groups.d.ts.map +0 -1
- package/dist/esm/services/joomla/schemas/groups.js +0 -12
- package/dist/esm/services/joomla/schemas/groups.js.map +0 -1
- package/dist/esm/services/orders/schemas/health.d.ts.map +0 -1
- package/dist/esm/services/orders/schemas/health.js.map +0 -1
- package/dist/esm/services/orders/schemas/invoices.d.ts.map +0 -1
- package/dist/esm/services/orders/schemas/invoices.js.map +0 -1
- package/dist/esm/services/orders/schemas/orders.d.ts.map +0 -1
- package/dist/esm/services/orders/schemas/orders.js.map +0 -1
- package/dist/esm/services/orders/schemas/purchase-orders.d.ts.map +0 -1
- package/dist/esm/services/orders/schemas/purchase-orders.js.map +0 -1
- package/dist/esm/services/orders/schemas/salesrep.d.ts.map +0 -1
- package/dist/esm/services/orders/schemas/salesrep.js.map +0 -1
- package/dist/types/services/customers/schemas/addresses.d.ts +0 -862
- package/dist/types/services/customers/schemas/addresses.d.ts.map +0 -1
- package/dist/types/services/customers/schemas/contacts.d.ts +0 -859
- package/dist/types/services/customers/schemas/contacts.d.ts.map +0 -1
- package/dist/types/services/customers/schemas/customers.d.ts +0 -1111
- package/dist/types/services/customers/schemas/customers.d.ts.map +0 -1
- package/dist/types/services/customers/schemas/health.d.ts +0 -70
- package/dist/types/services/customers/schemas/health.d.ts.map +0 -1
- package/dist/types/services/customers/schemas/invoices.d.ts +0 -1029
- package/dist/types/services/customers/schemas/invoices.d.ts.map +0 -1
- package/dist/types/services/customers/schemas/orders.d.ts +0 -2208
- package/dist/types/services/customers/schemas/orders.d.ts.map +0 -1
- package/dist/types/services/customers/schemas/purchased-items.d.ts +0 -169
- package/dist/types/services/customers/schemas/purchased-items.d.ts.map +0 -1
- package/dist/types/services/customers/schemas/quotes.d.ts +0 -2395
- package/dist/types/services/customers/schemas/quotes.d.ts.map +0 -1
- package/dist/types/services/items/schemas/brandItems.d.ts +0 -401
- package/dist/types/services/items/schemas/brandItems.d.ts.map +0 -1
- package/dist/types/services/items/schemas/categoriesImages.d.ts +0 -127
- package/dist/types/services/items/schemas/categoriesImages.d.ts.map +0 -1
- package/dist/types/services/items/schemas/health.d.ts +0 -117
- package/dist/types/services/items/schemas/health.d.ts.map +0 -1
- package/dist/types/services/items/schemas/products.d.ts.map +0 -1
- package/dist/types/services/items/schemas/wishlists.d.ts.map +0 -1
- package/dist/types/services/joomla/schemas/groups.d.ts +0 -12
- package/dist/types/services/joomla/schemas/groups.d.ts.map +0 -1
- package/dist/types/services/orders/schemas/health.d.ts +0 -70
- package/dist/types/services/orders/schemas/health.d.ts.map +0 -1
- package/dist/types/services/orders/schemas/invoices.d.ts.map +0 -1
- package/dist/types/services/orders/schemas/orders.d.ts.map +0 -1
- package/dist/types/services/orders/schemas/purchase-orders.d.ts.map +0 -1
- package/dist/types/services/orders/schemas/salesrep.d.ts.map +0 -1
|
@@ -1,14 +1,9 @@
|
|
|
1
1
|
import { BaseServiceClient } from '../../core/base-client';
|
|
2
2
|
import type { HTTPClient } from '../../core/client';
|
|
3
|
-
import {
|
|
4
|
-
import type { z } from 'zod';
|
|
5
|
-
import { BaseGetParamsSchema } from '../../core/schemas';
|
|
6
|
-
type CreateUserRequest = z.infer<typeof CreateUserRequestSchema>;
|
|
7
|
-
type UpdateUserRequest = z.infer<typeof UpdateUserRequestSchema>;
|
|
8
|
-
type BaseGetParams = z.infer<typeof BaseGetParamsSchema>;
|
|
3
|
+
import { type ContentParams, type ContentResponse, type ContentIdParams, type ContentIdResponse, type ContentIdDocParams, type ContentIdDocResponse, type HealthCheckResponse, type MenuIdDocResponse, type TagsParams, type TagsResponse, type UsersIdGroupsGroupIdResponse, type UsersIdGroupsParams, type UsersIdGroupsResponse, type UsersIdGroupsCreateRequest, type UsersIdGroupsCreateResponse, type UserGroupsParams, type UserGroupsResponse, type UsersIdResponse, type UsersIdUpdateRequest, type UsersIdUpdateResponse, type UsersIdDeleteResponse, type UsersIdDocResponse, type UsersIdTrinityParams, type UsersIdTrinityResponse, type UsersParams, type UsersResponse, type UsersCreateRequest, type UsersCreateResponse, type UsersVerifyPasswordRequest, type UsersVerifyPasswordResponse } from './schemas';
|
|
9
4
|
/**
|
|
10
|
-
* Joomla API Client
|
|
11
|
-
* @description
|
|
5
|
+
* Joomla API Client - OpenAPI Compliant
|
|
6
|
+
* @description Fully compliant client following OpenAPI Path Mirroring Pattern
|
|
12
7
|
* @example
|
|
13
8
|
* ```typescript
|
|
14
9
|
* import { HTTPClient } from '@augur/api-client/core';
|
|
@@ -17,831 +12,793 @@ type BaseGetParams = z.infer<typeof BaseGetParamsSchema>;
|
|
|
17
12
|
* const http = new HTTPClient('joomla', { siteId: 'your-site-id', bearerToken: 'your-token' });
|
|
18
13
|
* const joomla = new JoomlaClient(http);
|
|
19
14
|
*
|
|
20
|
-
* //
|
|
21
|
-
* const content = await joomla.content.
|
|
15
|
+
* // OpenAPI Path Mirroring: /content GET -> client.content.get()
|
|
16
|
+
* const content = await joomla.content.get({ limit: 10 });
|
|
22
17
|
*
|
|
23
|
-
* //
|
|
24
|
-
* const auth = await joomla.users.verifyPassword({ username: 'user', password: 'pass' });
|
|
18
|
+
* // OpenAPI Path Mirroring: /users/verify-password POST -> client.users.verifyPassword.create()
|
|
19
|
+
* const auth = await joomla.users.verifyPassword.create({ username: 'user', password: 'pass' });
|
|
25
20
|
* ```
|
|
26
21
|
*/
|
|
27
22
|
export declare class JoomlaClient extends BaseServiceClient {
|
|
28
|
-
/**
|
|
29
|
-
* Create a new JoomlaClient instance
|
|
30
|
-
* @param http Configured HTTPClient instance
|
|
31
|
-
* @param baseUrl Base URL for the Joomla API (default: https://joomla.augur-api.com)
|
|
32
|
-
*/
|
|
33
23
|
constructor(http: HTTPClient, baseUrl?: string);
|
|
34
24
|
/**
|
|
35
|
-
* Content endpoints
|
|
36
|
-
* @description Methods for content management including articles, documents, and metadata
|
|
25
|
+
* Content endpoints - /content
|
|
37
26
|
*/
|
|
38
27
|
content: {
|
|
39
28
|
/**
|
|
40
|
-
*
|
|
41
|
-
* @
|
|
42
|
-
* @fullPath api.joomla.content.list
|
|
29
|
+
* List content items - /content GET
|
|
30
|
+
* @fullPath api.joomla.content.get
|
|
43
31
|
* @service joomla
|
|
44
32
|
* @domain content-management
|
|
45
|
-
* @dataMethod
|
|
46
|
-
* @pagination Uses count, total, totalResults for pagination metadata. Supports limit/offset parameters.
|
|
47
|
-
* @caching Supports edgeCache parameter (1-8 hours) for improved performance on content that changes infrequently
|
|
33
|
+
* @dataMethod getData() - returns only the content array without metadata
|
|
48
34
|
* @discoverable true
|
|
49
|
-
* @searchTerms ["content", "articles", "list content", "cms content"
|
|
50
|
-
* @relatedEndpoints ["api.joomla.content.get", "api.joomla.content.
|
|
51
|
-
* @commonPatterns ["list articles", "get content", "
|
|
52
|
-
* @param params Optional filtering, pagination, and caching parameters
|
|
53
|
-
* @param params.categoryIdList Comma-separated list of category IDs to filter content (e.g., '1,2,3')
|
|
54
|
-
* @param params.q Search query for filtering content by title/text
|
|
55
|
-
* @param params.limit Maximum number of content items to return (default: 20, max: 100)
|
|
56
|
-
* @param params.offset Number of items to skip for pagination (default: 0)
|
|
57
|
-
* @param params.edgeCache Cache duration in hours (1, 2, 3, 4, 5, 8) - recommended for content
|
|
58
|
-
* @returns BaseResponse<ContentItem[]> with pagination metadata and content array
|
|
59
|
-
* @throws ValidationError When parameters are invalid or response is malformed
|
|
60
|
-
* @example
|
|
61
|
-
* ```typescript
|
|
62
|
-
* // Get all content with full response metadata
|
|
63
|
-
* const response = await api.joomla.content.list();
|
|
64
|
-
* console.log(`Found ${response.total} articles, showing ${response.data.length}`);
|
|
65
|
-
*
|
|
66
|
-
* // Filter content by categories with search
|
|
67
|
-
* const filtered = await api.joomla.content.list({
|
|
68
|
-
* categoryIdList: '1,2,3',
|
|
69
|
-
* q: 'product review',
|
|
70
|
-
* limit: 10
|
|
71
|
-
* });
|
|
72
|
-
*
|
|
73
|
-
* // Get just content data without metadata
|
|
74
|
-
* const articles = await api.joomla.content.listData({
|
|
75
|
-
* categoryIdList: '5',
|
|
76
|
-
* limit: 20
|
|
77
|
-
* });
|
|
78
|
-
* articles.forEach(article => console.log(article.title, article.alias));
|
|
79
|
-
*
|
|
80
|
-
* // Use aggressive caching for content (recommended)
|
|
81
|
-
* const cachedContent = await api.joomla.content.list({
|
|
82
|
-
* edgeCache: 4, // Cache for 4 hours - content changes infrequently
|
|
83
|
-
* categoryIdList: '1,2,3'
|
|
84
|
-
* });
|
|
85
|
-
* ```
|
|
35
|
+
* @searchTerms ["content", "articles", "list content", "cms content"]
|
|
36
|
+
* @relatedEndpoints ["api.joomla.content.get", "api.joomla.content.doc.get"]
|
|
37
|
+
* @commonPatterns ["list articles", "get content", "cms articles"]
|
|
86
38
|
*/
|
|
87
|
-
|
|
88
|
-
edgeCache?: 3 | 2 | 4 | 1 | "1" | 5 | 8 | "2" | "3" | "4" | "5" | "8" | undefined;
|
|
89
|
-
limit?: number | undefined;
|
|
90
|
-
offset?: number | undefined;
|
|
91
|
-
} | undefined) => Promise<{
|
|
92
|
-
params: Record<string, unknown> | unknown[];
|
|
93
|
-
data: unknown[];
|
|
94
|
-
options: Record<string, unknown> | unknown[];
|
|
95
|
-
status: number;
|
|
96
|
-
message: string;
|
|
97
|
-
count: number;
|
|
98
|
-
total: number;
|
|
99
|
-
totalResults: number;
|
|
100
|
-
}>;
|
|
39
|
+
get: (params?: ContentParams) => Promise<ContentResponse>;
|
|
101
40
|
/**
|
|
102
|
-
* Get content
|
|
103
|
-
* @
|
|
104
|
-
* @fullPath api.joomla.content.get
|
|
41
|
+
* Get content data only - /content GET (data method)
|
|
42
|
+
* @fullPath api.joomla.content.getData
|
|
105
43
|
* @service joomla
|
|
106
44
|
* @domain content-management
|
|
107
|
-
* @dataMethod getData(
|
|
108
|
-
* @caching Supports edgeCache parameter (1-8 hours) for improved performance
|
|
109
|
-
* @aliasLookup Supports alias-based lookup by using contentId=0 with params.alias
|
|
45
|
+
* @dataMethod getData() - returns only the content array without metadata
|
|
110
46
|
* @discoverable true
|
|
111
|
-
* @searchTerms ["
|
|
112
|
-
* @relatedEndpoints ["api.joomla.content.
|
|
113
|
-
* @commonPatterns ["get content
|
|
114
|
-
* @param contentId Content ID (number) or use 0 for alias lookup
|
|
115
|
-
* @param params Optional parameters for alias lookup and caching
|
|
116
|
-
* @param params.alias Content alias for lookup when contentId is 0
|
|
117
|
-
* @param params.catid Category ID for alias lookup specificity
|
|
118
|
-
* @param params.edgeCache Cache duration in hours (1, 2, 3, 4, 5, 8) for improved performance
|
|
119
|
-
* @returns BaseResponse<ContentItem> with complete content details and metadata
|
|
120
|
-
* @throws ValidationError When parameters are invalid or response is malformed
|
|
121
|
-
* @example
|
|
122
|
-
* ```typescript
|
|
123
|
-
* // Get content by ID with full response metadata
|
|
124
|
-
* const response = await api.joomla.content.get(123);
|
|
125
|
-
* console.log('Article:', response.data.title, 'Status:', response.status);
|
|
126
|
-
*
|
|
127
|
-
* // Get content by alias
|
|
128
|
-
* const byAlias = await api.joomla.content.get(0, {
|
|
129
|
-
* alias: 'my-article',
|
|
130
|
-
* catid: 45
|
|
131
|
-
* });
|
|
132
|
-
*
|
|
133
|
-
* // Get just content data without metadata
|
|
134
|
-
* const article = await api.joomla.content.getData(123);
|
|
135
|
-
* console.log(article.title, article.introtext, article.fulltext);
|
|
136
|
-
*
|
|
137
|
-
* // Use edge caching for frequently accessed content
|
|
138
|
-
* const cachedContent = await api.joomla.content.get(123, { edgeCache: 8 });
|
|
139
|
-
* ```
|
|
140
|
-
*/
|
|
141
|
-
get: (contentId: number | string, params?: BaseGetParams) => Promise<GenericResponse>;
|
|
142
|
-
/**
|
|
143
|
-
* Get content documentation
|
|
144
|
-
* @description Returns enhanced content document with custom fields, images, and metadata
|
|
145
|
-
* @param contentId Content ID (number) or alias lookup (use 0 with query params)
|
|
146
|
-
* @returns Enhanced content document with additional metadata
|
|
147
|
-
* @throws ValidationError When response is malformed
|
|
148
|
-
* @example
|
|
149
|
-
* ```typescript
|
|
150
|
-
* const doc = await client.content.getDoc(123);
|
|
151
|
-
* console.log(doc.id, doc.title, doc.content, doc.metadata);
|
|
152
|
-
* ```
|
|
47
|
+
* @searchTerms ["content data", "articles data", "get content data", "cms content data"]
|
|
48
|
+
* @relatedEndpoints ["api.joomla.content.get"]
|
|
49
|
+
* @commonPatterns ["get content data only", "extract article data"]
|
|
153
50
|
*/
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
51
|
+
getData: (params?: ContentParams) => Promise<{
|
|
52
|
+
id: number;
|
|
53
|
+
title: string;
|
|
54
|
+
alias: string;
|
|
55
|
+
introtext: string;
|
|
56
|
+
catid: number;
|
|
57
|
+
created: string;
|
|
58
|
+
created_by: number;
|
|
59
|
+
modified: string;
|
|
60
|
+
modified_by: number;
|
|
61
|
+
publish_up: string;
|
|
62
|
+
publish_down: string | null;
|
|
63
|
+
state: number;
|
|
64
|
+
access: number;
|
|
65
|
+
language: string;
|
|
66
|
+
hits: number;
|
|
67
|
+
featured: number;
|
|
68
|
+
ordering: number;
|
|
69
|
+
fulltext?: string | undefined;
|
|
70
|
+
metakey?: string | undefined;
|
|
71
|
+
metadesc?: string | undefined;
|
|
72
|
+
}[]>;
|
|
164
73
|
/**
|
|
165
|
-
*
|
|
166
|
-
* @
|
|
167
|
-
* @
|
|
168
|
-
* @
|
|
169
|
-
* @
|
|
74
|
+
* Get content by ID - /content/{id} GET
|
|
75
|
+
* @fullPath api.joomla.content.getById
|
|
76
|
+
* @service joomla
|
|
77
|
+
* @domain content-management
|
|
78
|
+
* @dataMethod getByIdData() - returns only the content object without metadata
|
|
79
|
+
* @discoverable true
|
|
80
|
+
* @searchTerms ["content by id", "single article", "get article by id"]
|
|
81
|
+
* @relatedEndpoints ["api.joomla.content.get", "api.joomla.content.doc.get"]
|
|
82
|
+
* @commonPatterns ["get article details", "fetch content item"]
|
|
170
83
|
*/
|
|
171
|
-
|
|
84
|
+
getById: (contentId: number | string, params?: ContentIdParams) => Promise<ContentIdResponse>;
|
|
172
85
|
/**
|
|
173
|
-
* Get content
|
|
174
|
-
* @
|
|
175
|
-
* @
|
|
176
|
-
* @
|
|
177
|
-
* @returns
|
|
178
|
-
* @
|
|
86
|
+
* Get content by ID data only - /content/{id} GET (data method)
|
|
87
|
+
* @fullPath api.joomla.content.getByIdData
|
|
88
|
+
* @service joomla
|
|
89
|
+
* @domain content-management
|
|
90
|
+
* @dataMethod getByIdData() - returns only the content object without metadata
|
|
91
|
+
* @discoverable true
|
|
92
|
+
* @searchTerms ["content data by id", "article data", "single content data"]
|
|
93
|
+
* @relatedEndpoints ["api.joomla.content.getById"]
|
|
94
|
+
* @commonPatterns ["extract article data", "get content data only"]
|
|
179
95
|
*/
|
|
180
|
-
|
|
96
|
+
getByIdData: (contentId: number | string, params?: ContentIdParams) => Promise<{
|
|
97
|
+
id: number;
|
|
98
|
+
title: string;
|
|
99
|
+
alias: string;
|
|
100
|
+
introtext: string;
|
|
101
|
+
fulltext: string;
|
|
102
|
+
catid: number;
|
|
103
|
+
created: string;
|
|
104
|
+
created_by: number;
|
|
105
|
+
modified: string;
|
|
106
|
+
modified_by: number;
|
|
107
|
+
publish_up: string;
|
|
108
|
+
publish_down: string | null;
|
|
109
|
+
state: number;
|
|
110
|
+
access: number;
|
|
111
|
+
language: string;
|
|
112
|
+
metakey: string;
|
|
113
|
+
metadesc: string;
|
|
114
|
+
hits: number;
|
|
115
|
+
featured: number;
|
|
116
|
+
ordering: number;
|
|
117
|
+
category_title?: string | undefined;
|
|
118
|
+
created_by_alias?: string | undefined;
|
|
119
|
+
images?: string | undefined;
|
|
120
|
+
urls?: string | undefined;
|
|
121
|
+
attribs?: string | undefined;
|
|
122
|
+
metadata?: string | undefined;
|
|
123
|
+
}>;
|
|
181
124
|
/**
|
|
182
|
-
*
|
|
183
|
-
* @description Returns only the data from enhanced content document response
|
|
184
|
-
* @param contentId Content ID (number) or alias lookup (use 0 with query params)
|
|
185
|
-
* @returns Enhanced content document (data only)
|
|
186
|
-
* @throws ValidationError When response is malformed
|
|
125
|
+
* Content document endpoints - /content/{id}/doc
|
|
187
126
|
*/
|
|
188
|
-
|
|
127
|
+
doc: {
|
|
128
|
+
/**
|
|
129
|
+
* Get content document - /content/{id}/doc GET
|
|
130
|
+
* @fullPath api.joomla.content.doc.get
|
|
131
|
+
* @service joomla
|
|
132
|
+
* @domain content-management
|
|
133
|
+
* @dataMethod getData() - returns only the document data without metadata
|
|
134
|
+
* @discoverable true
|
|
135
|
+
* @searchTerms ["content document", "article document", "content doc", "full content"]
|
|
136
|
+
* @relatedEndpoints ["api.joomla.content.getById"]
|
|
137
|
+
* @commonPatterns ["get full content document", "fetch article with metadata"]
|
|
138
|
+
*/
|
|
139
|
+
get: (contentId: number | string, params?: ContentIdDocParams) => Promise<ContentIdDocResponse>;
|
|
140
|
+
/**
|
|
141
|
+
* Get content document data only - /content/{id}/doc GET (data method)
|
|
142
|
+
* @fullPath api.joomla.content.doc.getData
|
|
143
|
+
* @service joomla
|
|
144
|
+
* @domain content-management
|
|
145
|
+
* @dataMethod getData() - returns only the document data without metadata
|
|
146
|
+
* @discoverable true
|
|
147
|
+
* @searchTerms ["content document data", "article doc data", "full content data"]
|
|
148
|
+
* @relatedEndpoints ["api.joomla.content.doc.get"]
|
|
149
|
+
* @commonPatterns ["extract document data", "get full content data only"]
|
|
150
|
+
*/
|
|
151
|
+
getData: (contentId: number | string, params?: ContentIdDocParams) => Promise<{
|
|
152
|
+
id: number;
|
|
153
|
+
title: string;
|
|
154
|
+
alias: string;
|
|
155
|
+
introtext: string;
|
|
156
|
+
fulltext: string;
|
|
157
|
+
catid: number;
|
|
158
|
+
created: string;
|
|
159
|
+
created_by: number;
|
|
160
|
+
modified: string;
|
|
161
|
+
modified_by: number;
|
|
162
|
+
publish_up: string;
|
|
163
|
+
publish_down: string | null;
|
|
164
|
+
state: number;
|
|
165
|
+
access: number;
|
|
166
|
+
language: string;
|
|
167
|
+
metakey: string;
|
|
168
|
+
metadesc: string;
|
|
169
|
+
hits: number;
|
|
170
|
+
featured: number;
|
|
171
|
+
ordering: number;
|
|
172
|
+
category_title: string;
|
|
173
|
+
category_alias: string;
|
|
174
|
+
created_by_alias?: string | undefined;
|
|
175
|
+
images?: Record<string, unknown> | undefined;
|
|
176
|
+
urls?: Record<string, unknown> | undefined;
|
|
177
|
+
author_name?: string | undefined;
|
|
178
|
+
custom_fields?: Record<string, unknown> | undefined;
|
|
179
|
+
tags?: {
|
|
180
|
+
id: number;
|
|
181
|
+
title: string;
|
|
182
|
+
alias: string;
|
|
183
|
+
}[] | undefined;
|
|
184
|
+
}>;
|
|
185
|
+
};
|
|
189
186
|
};
|
|
190
187
|
/**
|
|
191
|
-
*
|
|
192
|
-
* @description Methods for user management including authentication, CRUD operations, and group management
|
|
188
|
+
* Health check endpoint - /health-check
|
|
193
189
|
*/
|
|
194
|
-
|
|
190
|
+
healthCheck: {
|
|
195
191
|
/**
|
|
196
|
-
*
|
|
197
|
-
* @
|
|
198
|
-
* @fullPath api.joomla.users.list
|
|
192
|
+
* Service health check
|
|
193
|
+
* @fullPath api.joomla.healthCheck.get
|
|
199
194
|
* @service joomla
|
|
200
|
-
* @domain
|
|
201
|
-
* @dataMethod
|
|
202
|
-
* @pagination Uses count, total, totalResults for pagination metadata. Supports limit/offset parameters.
|
|
203
|
-
* @caching Supports edgeCache parameter (1-8 hours) for improved performance
|
|
195
|
+
* @domain system
|
|
196
|
+
* @dataMethod getData() - returns only the health data without metadata
|
|
204
197
|
* @discoverable true
|
|
205
|
-
* @searchTerms ["users", "list users", "get users", "user management", "accounts", "profiles"]
|
|
206
|
-
* @relatedEndpoints ["api.joomla.userGroups.list", "api.customers.customer.list", "api.joomla.users.get"]
|
|
207
|
-
* @commonPatterns ["list all users", "search users", "paginate users", "filter users"]
|
|
208
|
-
* @param params Optional filtering, pagination, and caching parameters
|
|
209
|
-
* @param params.q Search query for filtering users by username/email (optional)
|
|
210
|
-
* @param params.limit Maximum number of users to return (default: 20, max: 100)
|
|
211
|
-
* @param params.offset Number of users to skip for pagination (default: 0)
|
|
212
|
-
* @param params.edgeCache Cache duration in hours (1, 2, 3, 4, 5, 8) for improved performance
|
|
213
|
-
* @returns BaseResponse<User[]> with pagination metadata and user array
|
|
214
|
-
* @throws ValidationError When parameters are invalid or response is malformed
|
|
215
|
-
* @example
|
|
216
|
-
* ```typescript
|
|
217
|
-
* // Get all users without search filter
|
|
218
|
-
* const response = await api.joomla.users.list();
|
|
219
|
-
* console.log(`Found ${response.total} users, showing ${response.data.length}`);
|
|
220
|
-
* console.log('Pagination:', { count: response.count, total: response.total });
|
|
221
|
-
*
|
|
222
|
-
* // Search users with specific query and pagination
|
|
223
|
-
* const searchResults = await api.joomla.users.list({
|
|
224
|
-
* q: 'simple',
|
|
225
|
-
* limit: 10,
|
|
226
|
-
* offset: 0
|
|
227
|
-
* });
|
|
228
|
-
*
|
|
229
|
-
* // Get just user data without metadata (using data method)
|
|
230
|
-
* const users = await api.joomla.users.listData({ limit: 20 });
|
|
231
|
-
* users.forEach(user => console.log(user.username, user.email));
|
|
232
|
-
*
|
|
233
|
-
* // Use edge caching for performance
|
|
234
|
-
* const cachedUsers = await api.joomla.users.list({
|
|
235
|
-
* edgeCache: 2, // Cache for 2 hours
|
|
236
|
-
* limit: 50
|
|
237
|
-
* });
|
|
238
|
-
* ```
|
|
239
198
|
*/
|
|
240
|
-
|
|
241
|
-
edgeCache?: 3 | 2 | 4 | 1 | "1" | 5 | 8 | "2" | "3" | "4" | "5" | "8" | undefined;
|
|
242
|
-
limit?: number | undefined;
|
|
243
|
-
offset?: number | undefined;
|
|
244
|
-
} | undefined) => Promise<{
|
|
245
|
-
params: Record<string, unknown> | unknown[];
|
|
246
|
-
data: unknown[];
|
|
247
|
-
options: Record<string, unknown> | unknown[];
|
|
248
|
-
status: number;
|
|
249
|
-
message: string;
|
|
250
|
-
count: number;
|
|
251
|
-
total: number;
|
|
252
|
-
totalResults: number;
|
|
253
|
-
}>;
|
|
199
|
+
get: () => Promise<HealthCheckResponse>;
|
|
254
200
|
/**
|
|
255
|
-
* Get
|
|
256
|
-
* @
|
|
257
|
-
* @fullPath api.joomla.users.get
|
|
201
|
+
* Get service health data only - /health-check GET (data method)
|
|
202
|
+
* @fullPath api.joomla.healthCheck.getData
|
|
258
203
|
* @service joomla
|
|
259
|
-
* @domain
|
|
260
|
-
* @dataMethod getData(
|
|
261
|
-
* @caching Supports edgeCache parameter (1-8 hours) for improved performance
|
|
204
|
+
* @domain system
|
|
205
|
+
* @dataMethod getData() - returns only the health data without metadata
|
|
262
206
|
* @discoverable true
|
|
263
|
-
* @searchTerms ["
|
|
264
|
-
* @relatedEndpoints ["api.joomla.
|
|
265
|
-
* @commonPatterns ["
|
|
266
|
-
* @param userId User ID (number or string) - the unique identifier for the user
|
|
267
|
-
* @param params Optional caching parameters
|
|
268
|
-
* @param params.edgeCache Cache duration in hours (1, 2, 3, 4, 5, 8) for improved performance
|
|
269
|
-
* @returns BaseResponse<User> with complete user details and metadata
|
|
270
|
-
* @throws ValidationError When userId is invalid or response is malformed
|
|
271
|
-
* @example
|
|
272
|
-
* ```typescript
|
|
273
|
-
* // Get user with full response metadata
|
|
274
|
-
* const response = await api.joomla.users.get(123);
|
|
275
|
-
* console.log('User:', response.data.username, response.data.email);
|
|
276
|
-
* console.log('Status:', response.status, response.message);
|
|
277
|
-
*
|
|
278
|
-
* // Get just user data without metadata
|
|
279
|
-
* const user = await api.joomla.users.getData(123);
|
|
280
|
-
* console.log(user.username, user.email, user.registerDate);
|
|
281
|
-
*
|
|
282
|
-
* // Use edge caching for frequently accessed users
|
|
283
|
-
* const cachedUser = await api.joomla.users.get(123, { edgeCache: 1 });
|
|
284
|
-
* ```
|
|
285
|
-
*/
|
|
286
|
-
get: (userId: number | string) => Promise<GenericResponse>;
|
|
287
|
-
/**
|
|
288
|
-
* Get user documentation
|
|
289
|
-
* @description Returns enhanced user document with profile values, customer information, and metadata
|
|
290
|
-
* @param userId User ID (number or string)
|
|
291
|
-
* @returns Enhanced user document with profile data
|
|
292
|
-
* @throws ValidationError When response is malformed
|
|
293
|
-
* @example
|
|
294
|
-
* ```typescript
|
|
295
|
-
* const userDoc = await client.users.getDoc(123);
|
|
296
|
-
* console.log(userDoc.username, userDoc.email, userDoc.customerId);
|
|
297
|
-
* console.log(userDoc.profileValues?.['simpleweb_customer.simpleweb_customer_companyname']);
|
|
298
|
-
* ```
|
|
299
|
-
*/
|
|
300
|
-
getDoc: (userId: number | string) => Promise<GenericResponse>;
|
|
301
|
-
/**
|
|
302
|
-
* Get Trinity user documentation
|
|
303
|
-
* @description Returns specialized Trinity business logic document with territory assignment and role detection
|
|
304
|
-
* @param userId User ID (number or string)
|
|
305
|
-
* @param params Optional filtering and pagination parameters
|
|
306
|
-
* @returns Trinity document with profile, role, groups, and territory information
|
|
307
|
-
* @throws ValidationError When parameters are invalid or response is malformed
|
|
308
|
-
* @example
|
|
309
|
-
* ```typescript
|
|
310
|
-
* const trinity = await client.users.getTrinityDoc(123);
|
|
311
|
-
* console.log(trinity.profile.companyName, trinity.territory, trinity.role);
|
|
312
|
-
*
|
|
313
|
-
* // With filtering
|
|
314
|
-
* const filtered = await client.users.getTrinityDoc(123, { q: 'search', limit: 5 });
|
|
315
|
-
* ```
|
|
207
|
+
* @searchTerms ["health data", "service health data", "health check data"]
|
|
208
|
+
* @relatedEndpoints ["api.joomla.healthCheck.get"]
|
|
209
|
+
* @commonPatterns ["extract health data", "get health status only"]
|
|
316
210
|
*/
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
211
|
+
getData: () => Promise<{
|
|
212
|
+
siteHash: string;
|
|
213
|
+
siteId: string;
|
|
214
|
+
}>;
|
|
215
|
+
};
|
|
216
|
+
/**
|
|
217
|
+
* Menu endpoints - /menu/{id}/doc
|
|
218
|
+
*/
|
|
219
|
+
menu: {
|
|
220
|
+
doc: {
|
|
323
221
|
/**
|
|
324
|
-
* Get
|
|
325
|
-
* @
|
|
326
|
-
* @fullPath api.joomla.users.groups.list
|
|
222
|
+
* Get menu document - /menu/{id}/doc GET
|
|
223
|
+
* @fullPath api.joomla.menu.doc.get
|
|
327
224
|
* @service joomla
|
|
328
|
-
* @domain
|
|
329
|
-
* @dataMethod
|
|
225
|
+
* @domain menu-management
|
|
226
|
+
* @dataMethod getData() - returns only the menu data without metadata
|
|
330
227
|
* @discoverable true
|
|
331
|
-
* @searchTerms ["
|
|
332
|
-
* @relatedEndpoints ["api.joomla.
|
|
333
|
-
* @commonPatterns ["get
|
|
334
|
-
* @param userId User ID (string) - the unique identifier for the user
|
|
335
|
-
* @param params Optional pagination parameters
|
|
336
|
-
* @param params.limit Maximum number of group memberships to return (default: 20)
|
|
337
|
-
* @param params.offset Number of memberships to skip for pagination (default: 0)
|
|
338
|
-
* @returns BaseResponse<UserGroupMembership[]> with group membership details and metadata
|
|
339
|
-
* @throws ValidationError When response is malformed
|
|
340
|
-
* @example
|
|
341
|
-
* ```typescript
|
|
342
|
-
* // Get user's groups with full response metadata
|
|
343
|
-
* const response = await api.joomla.users.groups.list('123');
|
|
344
|
-
* response.data.forEach(group => {
|
|
345
|
-
* console.log(`Group: ${group.title} (ID: ${group.groupId})`);
|
|
346
|
-
* });
|
|
347
|
-
*
|
|
348
|
-
* // Get just group memberships data without metadata
|
|
349
|
-
* const groups = await api.joomla.users.groups.listData('123');
|
|
350
|
-
* groups.forEach(group => console.log(group.title, group.groupId));
|
|
351
|
-
* ```
|
|
352
|
-
*/
|
|
353
|
-
list: (userId: string, params?: BaseGetParams) => Promise<GenericResponse>;
|
|
354
|
-
/**
|
|
355
|
-
* Get specific user group membership
|
|
356
|
-
* @description Returns detailed information about a user's membership in a specific group
|
|
357
|
-
* @param userId User ID (string)
|
|
358
|
-
* @param groupId Group ID (number or string)
|
|
359
|
-
* @returns User group membership details
|
|
360
|
-
* @throws ValidationError When response is malformed
|
|
361
|
-
* @example
|
|
362
|
-
* ```typescript
|
|
363
|
-
* const membership = await client.users.groups.get('123', 1);
|
|
364
|
-
* console.log(membership.groupTitle, membership.memberSince);
|
|
365
|
-
* ```
|
|
366
|
-
*/
|
|
367
|
-
get: (userId: string, groupId: number | string) => Promise<GenericResponse>;
|
|
368
|
-
/**
|
|
369
|
-
* Create or update user group mapping
|
|
370
|
-
* @description Adds or updates a user's membership in a group
|
|
371
|
-
* @param userId User ID (number or string)
|
|
372
|
-
* @param request Group mapping request data
|
|
373
|
-
* @returns Created or updated group mapping information
|
|
374
|
-
* @throws ValidationError When request is invalid or response is malformed
|
|
375
|
-
* @example
|
|
376
|
-
* ```typescript
|
|
377
|
-
* const mapping = await client.users.groups.createMapping(123, { groupId: 5 });
|
|
378
|
-
* console.log(mapping.created ? 'Created' : 'Updated', 'group mapping');
|
|
379
|
-
* ```
|
|
228
|
+
* @searchTerms ["menu document", "menu doc", "menu item document"]
|
|
229
|
+
* @relatedEndpoints ["api.joomla.content.doc.get"]
|
|
230
|
+
* @commonPatterns ["get menu document", "fetch menu item details"]
|
|
380
231
|
*/
|
|
381
|
-
|
|
232
|
+
get: (menuId: string) => Promise<MenuIdDocResponse>;
|
|
382
233
|
/**
|
|
383
|
-
* Get
|
|
384
|
-
* @
|
|
385
|
-
* @
|
|
386
|
-
* @
|
|
387
|
-
* @
|
|
388
|
-
* @
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
|
|
392
|
-
* Get specific user group membership (data only)
|
|
393
|
-
* @description Returns only the data from user group membership details response
|
|
394
|
-
* @param userId User ID (string)
|
|
395
|
-
* @param groupId Group ID (number or string)
|
|
396
|
-
* @returns User group membership details (data only)
|
|
397
|
-
* @throws ValidationError When response is malformed
|
|
398
|
-
*/
|
|
399
|
-
getData: (userId: string, groupId: number | string) => Promise<unknown>;
|
|
400
|
-
/**
|
|
401
|
-
* Create or update user group mapping (data only)
|
|
402
|
-
* @description Returns only the data from created/updated group mapping response
|
|
403
|
-
* @param userId User ID (number or string)
|
|
404
|
-
* @param request Group mapping request data
|
|
405
|
-
* @returns Group mapping information (data only)
|
|
406
|
-
* @throws ValidationError When request is invalid or response is malformed
|
|
234
|
+
* Get menu document data only - /menu/{id}/doc GET (data method)
|
|
235
|
+
* @fullPath api.joomla.menu.doc.getData
|
|
236
|
+
* @service joomla
|
|
237
|
+
* @domain menu-management
|
|
238
|
+
* @dataMethod getData() - returns only the menu data without metadata
|
|
239
|
+
* @discoverable true
|
|
240
|
+
* @searchTerms ["menu document data", "menu doc data", "menu item data"]
|
|
241
|
+
* @relatedEndpoints ["api.joomla.menu.doc.get"]
|
|
242
|
+
* @commonPatterns ["extract menu data", "get menu document data only"]
|
|
407
243
|
*/
|
|
408
|
-
|
|
244
|
+
getData: (menuId: string) => Promise<{
|
|
245
|
+
link: string;
|
|
246
|
+
path: string;
|
|
247
|
+
type: string;
|
|
248
|
+
id: number;
|
|
249
|
+
title: string;
|
|
250
|
+
alias: string;
|
|
251
|
+
access: number;
|
|
252
|
+
language: string;
|
|
253
|
+
ordering: number;
|
|
254
|
+
published: number;
|
|
255
|
+
parent_id: number;
|
|
256
|
+
level: number;
|
|
257
|
+
component_id: number;
|
|
258
|
+
checked_out: number;
|
|
259
|
+
checked_out_time: string;
|
|
260
|
+
browserNav: number;
|
|
261
|
+
img: string;
|
|
262
|
+
template_style_id: number;
|
|
263
|
+
lft: number;
|
|
264
|
+
rgt: number;
|
|
265
|
+
home: number;
|
|
266
|
+
client_id: number;
|
|
267
|
+
params?: Record<string, unknown> | undefined;
|
|
268
|
+
}>;
|
|
409
269
|
};
|
|
270
|
+
};
|
|
271
|
+
/**
|
|
272
|
+
* Tags endpoints - /tags
|
|
273
|
+
*/
|
|
274
|
+
tags: {
|
|
410
275
|
/**
|
|
411
|
-
*
|
|
412
|
-
* @
|
|
413
|
-
* @fullPath api.joomla.users.verifyPassword
|
|
276
|
+
* List content tags
|
|
277
|
+
* @fullPath api.joomla.tags.get
|
|
414
278
|
* @service joomla
|
|
415
|
-
* @domain
|
|
416
|
-
* @dataMethod
|
|
417
|
-
* @crossSite Supports authentication across multiple sites when called from 'augur_info' site
|
|
279
|
+
* @domain content-management
|
|
280
|
+
* @dataMethod getData() - returns only the tags array without metadata
|
|
418
281
|
* @discoverable true
|
|
419
|
-
* @searchTerms ["verify password", "authenticate", "login", "user authentication", "credentials", "sign in"]
|
|
420
|
-
* @relatedEndpoints ["api.joomla.users.get", "api.joomla.users.create", "api.customers.customer.get"]
|
|
421
|
-
* @commonPatterns ["user login", "authenticate user", "verify credentials", "password check"]
|
|
422
|
-
* @param request Authentication request containing username, password, and optional siteId
|
|
423
|
-
* @param request.username User's username for authentication
|
|
424
|
-
* @param request.password User's password for verification
|
|
425
|
-
* @param request.siteId Optional site ID for cross-site authentication (when using augur_info)
|
|
426
|
-
* @returns BaseResponse<VerifyPasswordResult> with verification status, user info, and JWT token
|
|
427
|
-
* @throws ValidationError When credentials are invalid or request is malformed
|
|
428
|
-
* @example
|
|
429
|
-
* ```typescript
|
|
430
|
-
* // Standard authentication with full response
|
|
431
|
-
* const response = await api.joomla.users.verifyPassword({
|
|
432
|
-
* username: 'johndoe',
|
|
433
|
-
* password: 'securePassword123'
|
|
434
|
-
* });
|
|
435
|
-
*
|
|
436
|
-
* if (response.data.verified) {
|
|
437
|
-
* console.log('Login successful:', response.data.username);
|
|
438
|
-
* console.log('JWT Token:', response.data.token);
|
|
439
|
-
* console.log('User ID:', response.data.userId);
|
|
440
|
-
* }
|
|
441
|
-
*
|
|
442
|
-
* // Cross-site authentication (when using augur_info site)
|
|
443
|
-
* const crossSiteAuth = await api.joomla.users.verifyPassword({
|
|
444
|
-
* username: 'johndoe',
|
|
445
|
-
* password: 'securePassword123',
|
|
446
|
-
* siteId: 'customer_site_1'
|
|
447
|
-
* });
|
|
448
|
-
*
|
|
449
|
-
* // Get just verification data without metadata
|
|
450
|
-
* const authResult = await api.joomla.users.verifyPasswordData({
|
|
451
|
-
* username: 'johndoe',
|
|
452
|
-
* password: 'securePassword123'
|
|
453
|
-
* });
|
|
454
|
-
* ```
|
|
455
282
|
*/
|
|
456
|
-
|
|
283
|
+
get: (params?: TagsParams) => Promise<TagsResponse>;
|
|
457
284
|
/**
|
|
458
|
-
*
|
|
459
|
-
* @
|
|
460
|
-
* @
|
|
285
|
+
* Get tags data only - /tags GET (data method)
|
|
286
|
+
* @fullPath api.joomla.tags.getData
|
|
287
|
+
* @service joomla
|
|
288
|
+
* @domain content-management
|
|
289
|
+
* @dataMethod getData() - returns only the tags array without metadata
|
|
290
|
+
* @discoverable true
|
|
291
|
+
* @searchTerms ["tags data", "content tags data", "get tags data only"]
|
|
292
|
+
* @relatedEndpoints ["api.joomla.tags.get"]
|
|
293
|
+
* @commonPatterns ["extract tags data", "get content tags data only"]
|
|
294
|
+
*/
|
|
295
|
+
getData: (params?: TagsParams) => Promise<{
|
|
296
|
+
path: string;
|
|
297
|
+
description: string;
|
|
298
|
+
id: number;
|
|
299
|
+
title: string;
|
|
300
|
+
alias: string;
|
|
301
|
+
access: number;
|
|
302
|
+
language: string;
|
|
303
|
+
hits: number;
|
|
304
|
+
published: number;
|
|
305
|
+
parent_id: number;
|
|
306
|
+
level: number;
|
|
307
|
+
created_user_id: number;
|
|
308
|
+
created_time: string;
|
|
309
|
+
modified_user_id: number;
|
|
310
|
+
modified_time: string;
|
|
311
|
+
images?: string | undefined;
|
|
312
|
+
urls?: string | undefined;
|
|
313
|
+
metadata?: Record<string, unknown> | undefined;
|
|
314
|
+
note?: string | undefined;
|
|
315
|
+
}[]>;
|
|
316
|
+
};
|
|
317
|
+
/**
|
|
318
|
+
* Users endpoints - /users
|
|
319
|
+
*/
|
|
320
|
+
users: {
|
|
321
|
+
/**
|
|
322
|
+
* List users - /users GET
|
|
323
|
+
* @fullPath api.joomla.users.get
|
|
324
|
+
* @service joomla
|
|
325
|
+
* @domain user-management
|
|
326
|
+
* @dataMethod getData() - returns only the users array without metadata
|
|
327
|
+
* @discoverable true
|
|
328
|
+
* @searchTerms ["users", "list users", "get users", "user management", "user list"]
|
|
329
|
+
* @relatedEndpoints ["api.joomla.users.create", "api.joomla.users.getById"]
|
|
330
|
+
* @commonPatterns ["list all users", "get user list", "user management"]
|
|
331
|
+
*/
|
|
332
|
+
get: (params?: UsersParams) => Promise<UsersResponse>;
|
|
333
|
+
/**
|
|
334
|
+
* Get users data only - /users GET (data method)
|
|
335
|
+
* @fullPath api.joomla.users.getData
|
|
461
336
|
* @service joomla
|
|
462
337
|
* @domain user-management
|
|
463
|
-
* @dataMethod
|
|
338
|
+
* @dataMethod getData() - returns only the users array without metadata
|
|
464
339
|
* @discoverable true
|
|
465
|
-
* @searchTerms ["
|
|
466
|
-
* @relatedEndpoints ["api.joomla.users.
|
|
467
|
-
* @commonPatterns ["
|
|
468
|
-
* @param request User creation request data including username, email, name, and password
|
|
469
|
-
* @param request.username Unique username for the new user (required)
|
|
470
|
-
* @param request.email Valid email address for the user (required)
|
|
471
|
-
* @param request.name Full display name for the user (required)
|
|
472
|
-
* @param request.password Secure password for the user (required, minimum 8 characters)
|
|
473
|
-
* @returns BaseResponse<User> with created user information including ID, username, and email
|
|
474
|
-
* @throws ValidationError When request is invalid or response is malformed
|
|
475
|
-
* @example
|
|
476
|
-
* ```typescript
|
|
477
|
-
* // Create new user with full response metadata
|
|
478
|
-
* const response = await api.joomla.users.create({
|
|
479
|
-
* username: 'newuser',
|
|
480
|
-
* email: 'user@example.com',
|
|
481
|
-
* name: 'New User',
|
|
482
|
-
* password: 'SecurePass123!'
|
|
483
|
-
* });
|
|
484
|
-
* console.log('Created user:', response.data.id, response.data.username);
|
|
485
|
-
* console.log('Status:', response.status, response.message);
|
|
486
|
-
*
|
|
487
|
-
* // Get just created user data without metadata
|
|
488
|
-
* const newUser = await api.joomla.users.createData({
|
|
489
|
-
* username: 'johndoe',
|
|
490
|
-
* email: 'john@example.com',
|
|
491
|
-
* name: 'John Doe',
|
|
492
|
-
* password: 'MySecurePassword123!'
|
|
493
|
-
* });
|
|
494
|
-
* console.log('New user ID:', newUser.id, 'Email:', newUser.email);
|
|
495
|
-
* ```
|
|
340
|
+
* @searchTerms ["users data", "get users data", "user list data"]
|
|
341
|
+
* @relatedEndpoints ["api.joomla.users.get"]
|
|
342
|
+
* @commonPatterns ["extract users data", "get user list data only"]
|
|
496
343
|
*/
|
|
497
|
-
|
|
344
|
+
getData: (params?: UsersParams) => Promise<{
|
|
345
|
+
params: string;
|
|
346
|
+
id: number;
|
|
347
|
+
name: string;
|
|
498
348
|
username: string;
|
|
499
349
|
email: string;
|
|
500
|
-
|
|
501
|
-
|
|
350
|
+
block: number;
|
|
351
|
+
sendEmail: number;
|
|
352
|
+
registerDate: string;
|
|
353
|
+
lastvisitDate: string | null;
|
|
354
|
+
activation: string;
|
|
502
355
|
groups?: number[] | undefined;
|
|
503
|
-
|
|
504
|
-
}
|
|
505
|
-
params: Record<string, unknown> | unknown[];
|
|
506
|
-
options: Record<string, unknown> | unknown[];
|
|
507
|
-
status: number;
|
|
508
|
-
message: string;
|
|
509
|
-
count: number;
|
|
510
|
-
total: number;
|
|
511
|
-
totalResults: number;
|
|
512
|
-
data?: unknown;
|
|
513
|
-
}>;
|
|
356
|
+
customerId?: number | undefined;
|
|
357
|
+
}[]>;
|
|
514
358
|
/**
|
|
515
|
-
*
|
|
516
|
-
* @
|
|
517
|
-
* @
|
|
518
|
-
* @
|
|
519
|
-
* @returns
|
|
520
|
-
* @
|
|
521
|
-
* @
|
|
522
|
-
*
|
|
523
|
-
*
|
|
524
|
-
* email: 'newemail@example.com',
|
|
525
|
-
* name: 'Updated Name',
|
|
526
|
-
* block: 0 // Unblock user
|
|
527
|
-
* });
|
|
528
|
-
* console.log('Updated user:', updatedUser.username, updatedUser.email);
|
|
529
|
-
* ```
|
|
359
|
+
* Create user - /users POST
|
|
360
|
+
* @fullPath api.joomla.users.create
|
|
361
|
+
* @service joomla
|
|
362
|
+
* @domain user-management
|
|
363
|
+
* @dataMethod createData() - returns only the created user data without metadata
|
|
364
|
+
* @discoverable true
|
|
365
|
+
* @searchTerms ["create user", "add user", "new user", "user creation"]
|
|
366
|
+
* @relatedEndpoints ["api.joomla.users.get", "api.joomla.users.update"]
|
|
367
|
+
* @commonPatterns ["create new user account", "add user to system", "user registration"]
|
|
530
368
|
*/
|
|
531
|
-
|
|
532
|
-
username?: string | undefined;
|
|
533
|
-
password?: string | undefined;
|
|
534
|
-
email?: string | undefined;
|
|
535
|
-
name?: string | undefined;
|
|
536
|
-
profileValues?: Record<string, string | string[]> | undefined;
|
|
537
|
-
}) => Promise<{
|
|
538
|
-
params: Record<string, unknown> | unknown[];
|
|
539
|
-
options: Record<string, unknown> | unknown[];
|
|
540
|
-
status: number;
|
|
541
|
-
message: string;
|
|
542
|
-
count: number;
|
|
543
|
-
total: number;
|
|
544
|
-
totalResults: number;
|
|
545
|
-
data?: unknown;
|
|
546
|
-
}>;
|
|
369
|
+
create: (request: UsersCreateRequest) => Promise<UsersCreateResponse>;
|
|
547
370
|
/**
|
|
548
|
-
*
|
|
549
|
-
* @
|
|
550
|
-
* @
|
|
551
|
-
* @
|
|
552
|
-
* @
|
|
553
|
-
* @
|
|
554
|
-
*
|
|
555
|
-
*
|
|
556
|
-
*
|
|
557
|
-
* console.log('User has been successfully blocked');
|
|
558
|
-
* }
|
|
559
|
-
* ```
|
|
371
|
+
* Create user data only - /users POST (data method)
|
|
372
|
+
* @fullPath api.joomla.users.createData
|
|
373
|
+
* @service joomla
|
|
374
|
+
* @domain user-management
|
|
375
|
+
* @dataMethod createData() - returns only the created user data without metadata
|
|
376
|
+
* @discoverable true
|
|
377
|
+
* @searchTerms ["create user data", "add user data", "user creation data"]
|
|
378
|
+
* @relatedEndpoints ["api.joomla.users.create"]
|
|
379
|
+
* @commonPatterns ["extract created user data", "get new user data only"]
|
|
560
380
|
*/
|
|
561
|
-
|
|
562
|
-
params: Record<string, unknown> | unknown[];
|
|
563
|
-
options: Record<string, unknown> | unknown[];
|
|
564
|
-
status: number;
|
|
381
|
+
createData: (request: UsersCreateRequest) => Promise<{
|
|
565
382
|
message: string;
|
|
566
|
-
|
|
567
|
-
|
|
568
|
-
|
|
569
|
-
|
|
383
|
+
id: number;
|
|
384
|
+
created: boolean;
|
|
385
|
+
name: string;
|
|
386
|
+
username: string;
|
|
387
|
+
email: string;
|
|
570
388
|
}>;
|
|
571
389
|
/**
|
|
572
|
-
*
|
|
573
|
-
* @
|
|
574
|
-
* @
|
|
575
|
-
* @
|
|
576
|
-
* @
|
|
577
|
-
|
|
578
|
-
|
|
579
|
-
|
|
580
|
-
*
|
|
581
|
-
* @description Returns only the data from user details response
|
|
582
|
-
* @param userId User ID (number or string)
|
|
583
|
-
* @param params Optional caching parameters
|
|
584
|
-
* @returns User details (data only)
|
|
585
|
-
* @throws ValidationError When response is malformed
|
|
586
|
-
*/
|
|
587
|
-
getData: (userId: number | string) => Promise<unknown>;
|
|
588
|
-
/**
|
|
589
|
-
* Get user documentation (data only)
|
|
590
|
-
* @description Returns only the data from enhanced user document response
|
|
591
|
-
* @param userId User ID (number or string)
|
|
592
|
-
* @returns Enhanced user document (data only)
|
|
593
|
-
* @throws ValidationError When response is malformed
|
|
594
|
-
*/
|
|
595
|
-
getDocData: (userId: number | string) => Promise<unknown>;
|
|
596
|
-
/**
|
|
597
|
-
* Get Trinity user documentation (data only)
|
|
598
|
-
* @description Returns only the data from specialized Trinity business logic document response
|
|
599
|
-
* @param userId User ID (number or string)
|
|
600
|
-
* @param params Optional filtering and pagination parameters
|
|
601
|
-
* @returns Trinity document (data only)
|
|
602
|
-
* @throws ValidationError When parameters are invalid or response is malformed
|
|
390
|
+
* Get user by ID - /users/{id} GET
|
|
391
|
+
* @fullPath api.joomla.users.getById
|
|
392
|
+
* @service joomla
|
|
393
|
+
* @domain user-management
|
|
394
|
+
* @dataMethod getByIdData() - returns only the user data without metadata
|
|
395
|
+
* @discoverable true
|
|
396
|
+
* @searchTerms ["user by id", "get user", "single user", "user details"]
|
|
397
|
+
* @relatedEndpoints ["api.joomla.users.get", "api.joomla.users.update", "api.joomla.users.delete"]
|
|
398
|
+
* @commonPatterns ["get user details", "fetch user by id", "user profile"]
|
|
603
399
|
*/
|
|
604
|
-
|
|
400
|
+
getById: (userId: number | string) => Promise<UsersIdResponse>;
|
|
605
401
|
/**
|
|
606
|
-
*
|
|
607
|
-
* @
|
|
608
|
-
* @
|
|
609
|
-
* @
|
|
402
|
+
* Get user by ID data only - /users/{id} GET (data method)
|
|
403
|
+
* @fullPath api.joomla.users.getByIdData
|
|
404
|
+
* @service joomla
|
|
405
|
+
* @domain user-management
|
|
406
|
+
* @dataMethod getByIdData() - returns only the user data without metadata
|
|
407
|
+
* @discoverable true
|
|
408
|
+
* @searchTerms ["user data by id", "get user data", "single user data"]
|
|
409
|
+
* @relatedEndpoints ["api.joomla.users.getById"]
|
|
410
|
+
* @commonPatterns ["extract user data", "get user data only"]
|
|
610
411
|
*/
|
|
611
|
-
|
|
412
|
+
getByIdData: (userId: number | string) => Promise<{
|
|
413
|
+
params: string;
|
|
612
414
|
id: number;
|
|
415
|
+
name: string;
|
|
613
416
|
username: string;
|
|
614
|
-
isVerified: boolean;
|
|
615
|
-
token: string;
|
|
616
417
|
email: string;
|
|
418
|
+
block: number;
|
|
419
|
+
sendEmail: number;
|
|
420
|
+
registerDate: string;
|
|
421
|
+
lastvisitDate: string | null;
|
|
422
|
+
activation: string;
|
|
423
|
+
lastResetTime: string | null;
|
|
424
|
+
resetCount: number;
|
|
425
|
+
otpKey: string;
|
|
426
|
+
otep: string;
|
|
427
|
+
requireReset: number;
|
|
428
|
+
authProvider?: string | undefined;
|
|
429
|
+
groups?: number[] | undefined;
|
|
430
|
+
profileValues?: Record<string, unknown> | undefined;
|
|
617
431
|
}>;
|
|
618
432
|
/**
|
|
619
|
-
*
|
|
620
|
-
* @
|
|
621
|
-
* @
|
|
622
|
-
* @
|
|
623
|
-
* @
|
|
624
|
-
|
|
625
|
-
|
|
626
|
-
|
|
627
|
-
*
|
|
628
|
-
* @description Returns only the data from updated user response
|
|
629
|
-
* @param userId User ID (number or string)
|
|
630
|
-
* @param request User update data with optional fields to modify
|
|
631
|
-
* @returns Updated user object (data only)
|
|
632
|
-
* @throws ValidationError When request is invalid or response is malformed
|
|
433
|
+
* Update user - /users/{id} PUT
|
|
434
|
+
* @fullPath api.joomla.users.update
|
|
435
|
+
* @service joomla
|
|
436
|
+
* @domain user-management
|
|
437
|
+
* @dataMethod updateData() - returns only the updated user data without metadata
|
|
438
|
+
* @discoverable true
|
|
439
|
+
* @searchTerms ["update user", "edit user", "modify user", "user update"]
|
|
440
|
+
* @relatedEndpoints ["api.joomla.users.getById", "api.joomla.users.get"]
|
|
441
|
+
* @commonPatterns ["update user profile", "edit user details", "modify user account"]
|
|
633
442
|
*/
|
|
634
|
-
|
|
443
|
+
update: (userId: number | string, request: UsersIdUpdateRequest) => Promise<UsersIdUpdateResponse>;
|
|
635
444
|
/**
|
|
636
|
-
*
|
|
637
|
-
* @
|
|
638
|
-
* @param userId User ID (number or string)
|
|
639
|
-
* @returns Blocking operation result (data only)
|
|
640
|
-
* @throws ValidationError When response is malformed
|
|
641
|
-
*/
|
|
642
|
-
blockData: (userId: number | string) => Promise<unknown>;
|
|
643
|
-
};
|
|
644
|
-
/**
|
|
645
|
-
* User Groups endpoints
|
|
646
|
-
* @description Methods for managing system-wide user groups and their hierarchy
|
|
647
|
-
*/
|
|
648
|
-
userGroups: {
|
|
649
|
-
/**
|
|
650
|
-
* Get hierarchical list of user groups
|
|
651
|
-
* @description Returns system-wide user groups with hierarchy information, filtering, and caching
|
|
652
|
-
* @fullPath api.joomla.userGroups.list
|
|
445
|
+
* Update user data only - /users/{id} PUT (data method)
|
|
446
|
+
* @fullPath api.joomla.users.updateData
|
|
653
447
|
* @service joomla
|
|
654
448
|
* @domain user-management
|
|
655
|
-
* @dataMethod
|
|
656
|
-
* @hierarchy Returns groups with level and parent relationship information
|
|
657
|
-
* @caching Supports edgeCache parameter (1-8 hours) - recommended since groups rarely change
|
|
449
|
+
* @dataMethod updateData() - returns only the updated user data without metadata
|
|
658
450
|
* @discoverable true
|
|
659
|
-
* @searchTerms ["user
|
|
660
|
-
* @relatedEndpoints ["api.joomla.users.
|
|
661
|
-
* @commonPatterns ["
|
|
662
|
-
* @param params Optional filtering, ordering, and caching parameters
|
|
663
|
-
* @param params.orderBy Sort order (e.g., 'title|ASC', 'title|DESC', 'level|ASC')
|
|
664
|
-
* @param params.parentIdList Comma-separated list of parent group IDs to filter (e.g., '1,2')
|
|
665
|
-
* @param params.edgeCache Cache duration in hours (1-8) - highly recommended since groups rarely change
|
|
666
|
-
* @returns BaseResponse<UserGroup[]> with hierarchy metadata and groups array
|
|
667
|
-
* @throws ValidationError When parameters are invalid or response is malformed
|
|
668
|
-
* @example
|
|
669
|
-
* ```typescript
|
|
670
|
-
* // Get all user groups with hierarchy information
|
|
671
|
-
* const response = await api.joomla.userGroups.list();
|
|
672
|
-
* response.data.forEach(group => {
|
|
673
|
-
* console.log(`${group.title} (Level: ${group.level}, Parent: ${group.parentId})`);
|
|
674
|
-
* });
|
|
675
|
-
*
|
|
676
|
-
* // Filter and order groups
|
|
677
|
-
* const ordered = await api.joomla.userGroups.list({
|
|
678
|
-
* orderBy: 'title|ASC',
|
|
679
|
-
* parentIdList: '1,2'
|
|
680
|
-
* });
|
|
681
|
-
*
|
|
682
|
-
* // Get just groups data without metadata
|
|
683
|
-
* const groups = await api.joomla.userGroups.listData({
|
|
684
|
-
* orderBy: 'level|ASC'
|
|
685
|
-
* });
|
|
686
|
-
*
|
|
687
|
-
* // Use long caching since groups rarely change
|
|
688
|
-
* const cachedGroups = await api.joomla.userGroups.list({
|
|
689
|
-
* edgeCache: 8, // Cache for 8 hours - groups change very infrequently
|
|
690
|
-
* orderBy: 'title|ASC'
|
|
691
|
-
* });
|
|
692
|
-
* ```
|
|
451
|
+
* @searchTerms ["update user data", "edit user data", "modify user data"]
|
|
452
|
+
* @relatedEndpoints ["api.joomla.users.update"]
|
|
453
|
+
* @commonPatterns ["extract updated user data", "get updated user data only"]
|
|
693
454
|
*/
|
|
694
|
-
|
|
455
|
+
updateData: (userId: number | string, request: UsersIdUpdateRequest) => Promise<{
|
|
456
|
+
params: string;
|
|
457
|
+
id: number;
|
|
458
|
+
name: string;
|
|
459
|
+
username: string;
|
|
460
|
+
email: string;
|
|
461
|
+
block: number;
|
|
462
|
+
sendEmail: number;
|
|
463
|
+
registerDate: string;
|
|
464
|
+
lastvisitDate: string | null;
|
|
465
|
+
activation: string;
|
|
466
|
+
lastResetTime: string | null;
|
|
467
|
+
resetCount: number;
|
|
468
|
+
otpKey: string;
|
|
469
|
+
otep: string;
|
|
470
|
+
requireReset: number;
|
|
471
|
+
authProvider?: string | undefined;
|
|
472
|
+
groups?: number[] | undefined;
|
|
473
|
+
profileValues?: Record<string, unknown> | undefined;
|
|
474
|
+
}>;
|
|
695
475
|
/**
|
|
696
|
-
*
|
|
697
|
-
* @
|
|
698
|
-
* @
|
|
699
|
-
* @
|
|
700
|
-
* @
|
|
476
|
+
* Delete user - /users/{id} DELETE
|
|
477
|
+
* @fullPath api.joomla.users.delete
|
|
478
|
+
* @service joomla
|
|
479
|
+
* @domain user-management
|
|
480
|
+
* @dataMethod deleteData() - returns only the deletion result data without metadata
|
|
481
|
+
* @discoverable true
|
|
482
|
+
* @searchTerms ["delete user", "remove user", "user deletion"]
|
|
483
|
+
* @relatedEndpoints ["api.joomla.users.getById", "api.joomla.users.get"]
|
|
484
|
+
* @commonPatterns ["delete user account", "remove user", "deactivate user"]
|
|
701
485
|
*/
|
|
702
|
-
|
|
703
|
-
};
|
|
704
|
-
/**
|
|
705
|
-
* Tags endpoints
|
|
706
|
-
* @description Methods for managing content tags and their hierarchical relationships
|
|
707
|
-
*/
|
|
708
|
-
tags: {
|
|
486
|
+
delete: (userId: number | string) => Promise<UsersIdDeleteResponse>;
|
|
709
487
|
/**
|
|
710
|
-
*
|
|
711
|
-
* @
|
|
712
|
-
* @fullPath api.joomla.tags.list
|
|
488
|
+
* Delete user data only - /users/{id} DELETE (data method)
|
|
489
|
+
* @fullPath api.joomla.users.deleteData
|
|
713
490
|
* @service joomla
|
|
714
|
-
* @domain
|
|
715
|
-
* @dataMethod
|
|
716
|
-
* @hierarchy Returns tags with level and parent relationship information
|
|
717
|
-
* @caching Supports edgeCache parameter (1-8 hours) - recommended for reference data
|
|
491
|
+
* @domain user-management
|
|
492
|
+
* @dataMethod deleteData() - returns only the deletion result data without metadata
|
|
718
493
|
* @discoverable true
|
|
719
|
-
* @searchTerms ["
|
|
720
|
-
* @relatedEndpoints ["api.joomla.
|
|
721
|
-
* @commonPatterns ["
|
|
722
|
-
* @param params Optional filtering, search, and caching parameters
|
|
723
|
-
* @param params.q Search query for filtering tags by title
|
|
724
|
-
* @param params.catId Category ID to filter tags by category
|
|
725
|
-
* @param params.limit Maximum number of tags to return (default: 20, max: 100)
|
|
726
|
-
* @param params.offset Number of tags to skip for pagination (default: 0)
|
|
727
|
-
* @param params.edgeCache Cache duration in hours (1-8) - recommended for reference data
|
|
728
|
-
* @returns BaseResponse<Tag[]> with hierarchy metadata and tags array
|
|
729
|
-
* @throws ValidationError When parameters are invalid or response is malformed
|
|
730
|
-
* @example
|
|
731
|
-
* ```typescript
|
|
732
|
-
* // Get all tags with hierarchy information
|
|
733
|
-
* const response = await api.joomla.tags.list();
|
|
734
|
-
* response.data.forEach(tag => {
|
|
735
|
-
* console.log(`${tag.title} (${tag.hits} hits, Level: ${tag.level})`);
|
|
736
|
-
* });
|
|
737
|
-
*
|
|
738
|
-
* // Search tags by keyword
|
|
739
|
-
* const searchTags = await api.joomla.tags.list({
|
|
740
|
-
* q: 'technology',
|
|
741
|
-
* catId: 1,
|
|
742
|
-
* limit: 10
|
|
743
|
-
* });
|
|
744
|
-
*
|
|
745
|
-
* // Get just tags data without metadata
|
|
746
|
-
* const tags = await api.joomla.tags.listData({
|
|
747
|
-
* limit: 50
|
|
748
|
-
* });
|
|
749
|
-
* tags.forEach(tag => console.log(tag.title, tag.alias));
|
|
750
|
-
*
|
|
751
|
-
* // Use caching for reference data (recommended)
|
|
752
|
-
* const cachedTags = await api.joomla.tags.list({
|
|
753
|
-
* edgeCache: 5, // Cache for 5 hours - tags are reference data
|
|
754
|
-
* limit: 100
|
|
755
|
-
* });
|
|
756
|
-
* ```
|
|
494
|
+
* @searchTerms ["delete user data", "remove user data", "user deletion data"]
|
|
495
|
+
* @relatedEndpoints ["api.joomla.users.delete"]
|
|
496
|
+
* @commonPatterns ["extract deletion result", "get deletion data only"]
|
|
757
497
|
*/
|
|
758
|
-
|
|
759
|
-
edgeCache?: 3 | 2 | 4 | 1 | "1" | 5 | 8 | "2" | "3" | "4" | "5" | "8" | undefined;
|
|
760
|
-
limit?: number | undefined;
|
|
761
|
-
offset?: number | undefined;
|
|
762
|
-
} | undefined) => Promise<{
|
|
763
|
-
params: Record<string, unknown> | unknown[];
|
|
764
|
-
data: unknown[];
|
|
765
|
-
options: Record<string, unknown> | unknown[];
|
|
766
|
-
status: number;
|
|
498
|
+
deleteData: (userId: number | string) => Promise<{
|
|
767
499
|
message: string;
|
|
768
|
-
|
|
769
|
-
|
|
770
|
-
totalResults: number;
|
|
500
|
+
id: number;
|
|
501
|
+
blocked: boolean;
|
|
771
502
|
}>;
|
|
772
503
|
/**
|
|
773
|
-
*
|
|
774
|
-
|
|
775
|
-
|
|
776
|
-
|
|
777
|
-
|
|
504
|
+
* User document - /users/{id}/doc
|
|
505
|
+
*/
|
|
506
|
+
doc: {
|
|
507
|
+
/**
|
|
508
|
+
* Get user document - /users/{id}/doc GET
|
|
509
|
+
* @fullPath api.joomla.users.doc.get
|
|
510
|
+
* @service joomla
|
|
511
|
+
* @domain user-management
|
|
512
|
+
* @dataMethod getData() - returns only the user document data without metadata
|
|
513
|
+
* @discoverable true
|
|
514
|
+
* @searchTerms ["user document", "user doc", "user full document"]
|
|
515
|
+
* @relatedEndpoints ["api.joomla.users.getById"]
|
|
516
|
+
* @commonPatterns ["get user document", "fetch user full details"]
|
|
517
|
+
*/
|
|
518
|
+
get: (userId: number | string) => Promise<UsersIdDocResponse>;
|
|
519
|
+
/**
|
|
520
|
+
* Get user document data only - /users/{id}/doc GET (data method)
|
|
521
|
+
* @fullPath api.joomla.users.doc.getData
|
|
522
|
+
* @service joomla
|
|
523
|
+
* @domain user-management
|
|
524
|
+
* @dataMethod getData() - returns only the user document data without metadata
|
|
525
|
+
* @discoverable true
|
|
526
|
+
* @searchTerms ["user document data", "user doc data", "user full document data"]
|
|
527
|
+
* @relatedEndpoints ["api.joomla.users.doc.get"]
|
|
528
|
+
* @commonPatterns ["extract user document data", "get user document data only"]
|
|
529
|
+
*/
|
|
530
|
+
getData: (userId: number | string) => Promise<{
|
|
531
|
+
id: number;
|
|
532
|
+
name: string;
|
|
533
|
+
username: string;
|
|
534
|
+
email: string;
|
|
535
|
+
block: number;
|
|
536
|
+
sendEmail: number;
|
|
537
|
+
registerDate: string;
|
|
538
|
+
lastvisitDate: string | null;
|
|
539
|
+
activation: string;
|
|
540
|
+
params?: Record<string, unknown> | undefined;
|
|
541
|
+
permissions?: string[] | undefined;
|
|
542
|
+
groups?: {
|
|
543
|
+
id: number;
|
|
544
|
+
title: string;
|
|
545
|
+
level: number;
|
|
546
|
+
}[] | undefined;
|
|
547
|
+
profileValues?: Record<string, unknown> | undefined;
|
|
548
|
+
customerId?: number | undefined;
|
|
549
|
+
customerInfo?: {
|
|
550
|
+
companyName?: string | undefined;
|
|
551
|
+
territory?: string | undefined;
|
|
552
|
+
role?: string | undefined;
|
|
553
|
+
} | undefined;
|
|
554
|
+
}>;
|
|
555
|
+
};
|
|
556
|
+
/**
|
|
557
|
+
* Trinity user document - /users/{id}/trinity
|
|
778
558
|
*/
|
|
779
|
-
|
|
559
|
+
trinity: {
|
|
560
|
+
/**
|
|
561
|
+
* Get trinity user document - /users/{id}/trinity GET
|
|
562
|
+
* @fullPath api.joomla.users.trinity.get
|
|
563
|
+
* @service joomla
|
|
564
|
+
* @domain user-management
|
|
565
|
+
* @dataMethod getData() - returns only the trinity user data without metadata
|
|
566
|
+
* @discoverable true
|
|
567
|
+
* @searchTerms ["trinity user", "user trinity", "trinity document"]
|
|
568
|
+
* @relatedEndpoints ["api.joomla.users.doc.get", "api.joomla.users.getById"]
|
|
569
|
+
* @commonPatterns ["get trinity user data", "fetch user trinity document"]
|
|
570
|
+
*/
|
|
571
|
+
get: (userId: number | string, params?: UsersIdTrinityParams) => Promise<UsersIdTrinityResponse>;
|
|
572
|
+
/**
|
|
573
|
+
* Get trinity user document data only - /users/{id}/trinity GET (data method)
|
|
574
|
+
* @fullPath api.joomla.users.trinity.getData
|
|
575
|
+
* @service joomla
|
|
576
|
+
* @domain user-management
|
|
577
|
+
* @dataMethod getData() - returns only the trinity user data without metadata
|
|
578
|
+
* @discoverable true
|
|
579
|
+
* @searchTerms ["trinity user data", "user trinity data", "trinity document data"]
|
|
580
|
+
* @relatedEndpoints ["api.joomla.users.trinity.get"]
|
|
581
|
+
* @commonPatterns ["extract trinity user data", "get trinity data only"]
|
|
582
|
+
*/
|
|
583
|
+
getData: (userId: number | string, params?: UsersIdTrinityParams) => Promise<{
|
|
584
|
+
id: number;
|
|
585
|
+
permissions: string[];
|
|
586
|
+
groups: {
|
|
587
|
+
id: number;
|
|
588
|
+
title: string;
|
|
589
|
+
level: number;
|
|
590
|
+
isDefault?: boolean | undefined;
|
|
591
|
+
}[];
|
|
592
|
+
profile: {
|
|
593
|
+
userId: number;
|
|
594
|
+
email: string;
|
|
595
|
+
companyName?: string | undefined;
|
|
596
|
+
territory?: string | undefined;
|
|
597
|
+
role?: string | undefined;
|
|
598
|
+
firstName?: string | undefined;
|
|
599
|
+
lastName?: string | undefined;
|
|
600
|
+
phone?: string | undefined;
|
|
601
|
+
};
|
|
602
|
+
territory?: {
|
|
603
|
+
code: string;
|
|
604
|
+
name: string;
|
|
605
|
+
region?: string | undefined;
|
|
606
|
+
} | undefined;
|
|
607
|
+
role?: {
|
|
608
|
+
level: string;
|
|
609
|
+
name: string;
|
|
610
|
+
capabilities: string[];
|
|
611
|
+
} | undefined;
|
|
612
|
+
businessLogic?: Record<string, unknown> | undefined;
|
|
613
|
+
}>;
|
|
614
|
+
};
|
|
615
|
+
/**
|
|
616
|
+
* User groups - /users/{id}/groups
|
|
617
|
+
*/
|
|
618
|
+
groups: {
|
|
619
|
+
/**
|
|
620
|
+
* List user groups - /users/{id}/groups GET
|
|
621
|
+
* @fullPath api.joomla.users.groups.get
|
|
622
|
+
* @service joomla
|
|
623
|
+
* @domain user-management
|
|
624
|
+
* @dataMethod getData() - returns only the user groups array without metadata
|
|
625
|
+
* @discoverable true
|
|
626
|
+
* @searchTerms ["user groups", "user group list", "groups for user"]
|
|
627
|
+
* @relatedEndpoints ["api.joomla.users.groups.create", "api.joomla.userGroups.get"]
|
|
628
|
+
* @commonPatterns ["get user groups", "list user group memberships"]
|
|
629
|
+
*/
|
|
630
|
+
get: (userId: string, params?: UsersIdGroupsParams) => Promise<UsersIdGroupsResponse>;
|
|
631
|
+
/**
|
|
632
|
+
* Get user groups data only - /users/{id}/groups GET (data method)
|
|
633
|
+
* @fullPath api.joomla.users.groups.getData
|
|
634
|
+
* @service joomla
|
|
635
|
+
* @domain user-management
|
|
636
|
+
* @dataMethod getData() - returns only the user groups array without metadata
|
|
637
|
+
* @discoverable true
|
|
638
|
+
* @searchTerms ["user groups data", "user group list data", "groups data"]
|
|
639
|
+
* @relatedEndpoints ["api.joomla.users.groups.get"]
|
|
640
|
+
* @commonPatterns ["extract user groups data", "get groups data only"]
|
|
641
|
+
*/
|
|
642
|
+
getData: (userId: string, params?: UsersIdGroupsParams) => Promise<{
|
|
643
|
+
parent_id: number;
|
|
644
|
+
level: number;
|
|
645
|
+
userId: number;
|
|
646
|
+
groupId: number;
|
|
647
|
+
groupTitle: string;
|
|
648
|
+
memberSince: string;
|
|
649
|
+
isActive: boolean;
|
|
650
|
+
groupDescription?: string | undefined;
|
|
651
|
+
permissions?: string[] | undefined;
|
|
652
|
+
}[]>;
|
|
653
|
+
/**
|
|
654
|
+
* Create user group mapping - /users/{id}/groups POST
|
|
655
|
+
* @fullPath api.joomla.users.groups.create
|
|
656
|
+
* @service joomla
|
|
657
|
+
* @domain user-management
|
|
658
|
+
* @dataMethod createData() - returns only the created group mapping data without metadata
|
|
659
|
+
* @discoverable true
|
|
660
|
+
* @searchTerms ["add user to group", "create user group mapping", "assign user group"]
|
|
661
|
+
* @relatedEndpoints ["api.joomla.users.groups.get", "api.joomla.users.groups.getById"]
|
|
662
|
+
* @commonPatterns ["add user to group", "assign group membership", "create group mapping"]
|
|
663
|
+
*/
|
|
664
|
+
create: (userId: number | string, request: UsersIdGroupsCreateRequest) => Promise<UsersIdGroupsCreateResponse>;
|
|
665
|
+
/**
|
|
666
|
+
* Create user group mapping data only - /users/{id}/groups POST (data method)
|
|
667
|
+
* @fullPath api.joomla.users.groups.createData
|
|
668
|
+
* @service joomla
|
|
669
|
+
* @domain user-management
|
|
670
|
+
* @dataMethod createData() - returns only the created group mapping data without metadata
|
|
671
|
+
* @discoverable true
|
|
672
|
+
* @searchTerms ["add user to group data", "create group mapping data", "assign user group data"]
|
|
673
|
+
* @relatedEndpoints ["api.joomla.users.groups.create"]
|
|
674
|
+
* @commonPatterns ["extract group mapping data", "get created mapping data only"]
|
|
675
|
+
*/
|
|
676
|
+
createData: (userId: number | string, request: UsersIdGroupsCreateRequest) => Promise<{
|
|
677
|
+
message: string;
|
|
678
|
+
created: boolean;
|
|
679
|
+
userId: number;
|
|
680
|
+
groupId: number;
|
|
681
|
+
}>;
|
|
682
|
+
/**
|
|
683
|
+
* Get specific user group - /users/{id}/groups/{groupId} GET
|
|
684
|
+
* @fullPath api.joomla.users.groups.getById
|
|
685
|
+
* @service joomla
|
|
686
|
+
* @domain user-management
|
|
687
|
+
* @dataMethod getByIdData() - returns only the user group data without metadata
|
|
688
|
+
* @discoverable true
|
|
689
|
+
* @searchTerms ["user group by id", "specific user group", "user group details"]
|
|
690
|
+
* @relatedEndpoints ["api.joomla.users.groups.get", "api.joomla.userGroups.get"]
|
|
691
|
+
* @commonPatterns ["get specific user group", "fetch user group details"]
|
|
692
|
+
*/
|
|
693
|
+
getById: (userId: string, groupId: number | string) => Promise<UsersIdGroupsGroupIdResponse>;
|
|
694
|
+
/**
|
|
695
|
+
* Get specific user group data only - /users/{id}/groups/{groupId} GET (data method)
|
|
696
|
+
* @fullPath api.joomla.users.groups.getByIdData
|
|
697
|
+
* @service joomla
|
|
698
|
+
* @domain user-management
|
|
699
|
+
* @dataMethod getByIdData() - returns only the user group data without metadata
|
|
700
|
+
* @discoverable true
|
|
701
|
+
* @searchTerms ["user group data by id", "specific user group data", "user group details data"]
|
|
702
|
+
* @relatedEndpoints ["api.joomla.users.groups.getById"]
|
|
703
|
+
* @commonPatterns ["extract user group data", "get specific group data only"]
|
|
704
|
+
*/
|
|
705
|
+
getByIdData: (userId: string, groupId: number | string) => Promise<{
|
|
706
|
+
userId: number;
|
|
707
|
+
groupId: number;
|
|
708
|
+
groupTitle: string;
|
|
709
|
+
memberSince: string;
|
|
710
|
+
isActive: boolean;
|
|
711
|
+
groupDescription?: string | undefined;
|
|
712
|
+
permissions?: string[] | undefined;
|
|
713
|
+
inheritedGroups?: {
|
|
714
|
+
id: number;
|
|
715
|
+
title: string;
|
|
716
|
+
}[] | undefined;
|
|
717
|
+
}>;
|
|
718
|
+
};
|
|
719
|
+
/**
|
|
720
|
+
* Password verification - /users/verify-password
|
|
721
|
+
*/
|
|
722
|
+
verifyPassword: {
|
|
723
|
+
/**
|
|
724
|
+
* Verify user password - /users/verify-password POST
|
|
725
|
+
* @fullPath api.joomla.users.verifyPassword.create
|
|
726
|
+
* @service joomla
|
|
727
|
+
* @domain user-management
|
|
728
|
+
* @dataMethod createData() - returns only the verification result data without metadata
|
|
729
|
+
* @discoverable true
|
|
730
|
+
* @searchTerms ["verify password", "check password", "authenticate user", "login verification"]
|
|
731
|
+
* @relatedEndpoints ["api.joomla.users.getById", "api.joomla.users.get"]
|
|
732
|
+
* @commonPatterns ["verify user password", "authenticate user", "check login credentials"]
|
|
733
|
+
*/
|
|
734
|
+
create: (request: UsersVerifyPasswordRequest) => Promise<UsersVerifyPasswordResponse>;
|
|
735
|
+
/**
|
|
736
|
+
* Verify user password data only - /users/verify-password POST (data method)
|
|
737
|
+
* @fullPath api.joomla.users.verifyPassword.createData
|
|
738
|
+
* @service joomla
|
|
739
|
+
* @domain user-management
|
|
740
|
+
* @dataMethod createData() - returns only the verification result data without metadata
|
|
741
|
+
* @discoverable true
|
|
742
|
+
* @searchTerms ["verify password data", "check password data", "authentication result data"]
|
|
743
|
+
* @relatedEndpoints ["api.joomla.users.verifyPassword.create"]
|
|
744
|
+
* @commonPatterns ["extract verification result", "get authentication data only"]
|
|
745
|
+
*/
|
|
746
|
+
createData: (request: UsersVerifyPasswordRequest) => Promise<{
|
|
747
|
+
id: number;
|
|
748
|
+
username: string;
|
|
749
|
+
email: string;
|
|
750
|
+
isVerified: boolean;
|
|
751
|
+
token: string;
|
|
752
|
+
}>;
|
|
753
|
+
};
|
|
780
754
|
};
|
|
781
755
|
/**
|
|
782
|
-
*
|
|
783
|
-
* @description Methods for accessing menu structure and navigation documentation
|
|
756
|
+
* User Groups endpoints - /usergroups
|
|
784
757
|
*/
|
|
785
|
-
|
|
758
|
+
userGroups: {
|
|
786
759
|
/**
|
|
787
|
-
*
|
|
788
|
-
* @
|
|
789
|
-
* @
|
|
790
|
-
* @
|
|
791
|
-
* @
|
|
792
|
-
* @
|
|
793
|
-
*
|
|
794
|
-
*
|
|
795
|
-
*
|
|
796
|
-
* console.log('Level:', menuDoc.data.level, 'Parent:', menuDoc.data.parentId);
|
|
797
|
-
* ```
|
|
760
|
+
* List user groups - /usergroups GET
|
|
761
|
+
* @fullPath api.joomla.userGroups.get
|
|
762
|
+
* @service joomla
|
|
763
|
+
* @domain user-management
|
|
764
|
+
* @dataMethod getData() - returns only the groups array without metadata
|
|
765
|
+
* @discoverable true
|
|
766
|
+
* @searchTerms ["user groups", "list groups", "all groups", "group management"]
|
|
767
|
+
* @relatedEndpoints ["api.joomla.users.groups.get"]
|
|
768
|
+
* @commonPatterns ["list all user groups", "get available groups", "group management"]
|
|
798
769
|
*/
|
|
799
|
-
|
|
770
|
+
get: (params?: UserGroupsParams) => Promise<UserGroupsResponse>;
|
|
800
771
|
/**
|
|
801
|
-
* Get
|
|
802
|
-
* @
|
|
803
|
-
* @
|
|
804
|
-
* @
|
|
805
|
-
* @
|
|
772
|
+
* Get user groups data only - /usergroups GET (data method)
|
|
773
|
+
* @fullPath api.joomla.userGroups.getData
|
|
774
|
+
* @service joomla
|
|
775
|
+
* @domain user-management
|
|
776
|
+
* @dataMethod getData() - returns only the groups array without metadata
|
|
777
|
+
* @discoverable true
|
|
778
|
+
* @searchTerms ["user groups data", "list groups data", "all groups data"]
|
|
779
|
+
* @relatedEndpoints ["api.joomla.userGroups.get"]
|
|
780
|
+
* @commonPatterns ["extract groups data", "get groups data only"]
|
|
806
781
|
*/
|
|
807
|
-
|
|
782
|
+
getData: (params?: UserGroupsParams) => Promise<{
|
|
783
|
+
id: number;
|
|
784
|
+
title: string;
|
|
785
|
+
created: string;
|
|
786
|
+
created_by: number;
|
|
787
|
+
modified: string;
|
|
788
|
+
modified_by: number;
|
|
789
|
+
access: number;
|
|
790
|
+
published: number;
|
|
791
|
+
parent_id: number;
|
|
792
|
+
level: number;
|
|
793
|
+
lft: number;
|
|
794
|
+
rgt: number;
|
|
795
|
+
description?: string | undefined;
|
|
796
|
+
note?: string | undefined;
|
|
797
|
+
rules?: string | undefined;
|
|
798
|
+
}[]>;
|
|
808
799
|
};
|
|
809
800
|
/**
|
|
810
|
-
*
|
|
811
|
-
* @description Monitor service availability without authentication overhead
|
|
812
|
-
* @returns Health check response with site information
|
|
813
|
-
* @throws ValidationError When response is malformed
|
|
814
|
-
* @example
|
|
815
|
-
* ```typescript
|
|
816
|
-
* const health = await client.getHealthCheck();
|
|
817
|
-
* console.log('Service health:', health.status);
|
|
818
|
-
* console.log('Site ID:', health.data.siteId);
|
|
819
|
-
* console.log('Site Hash:', health.data.siteHash);
|
|
820
|
-
* ```
|
|
821
|
-
*/
|
|
822
|
-
getHealthCheck: () => Promise<{
|
|
823
|
-
params: Record<string, unknown> | unknown[];
|
|
824
|
-
data: {
|
|
825
|
-
siteHash: string;
|
|
826
|
-
siteId: string;
|
|
827
|
-
};
|
|
828
|
-
options: Record<string, unknown> | unknown[];
|
|
829
|
-
status: number;
|
|
830
|
-
message: string;
|
|
831
|
-
count: number;
|
|
832
|
-
total: number;
|
|
833
|
-
totalResults: number;
|
|
834
|
-
}>;
|
|
835
|
-
/**
|
|
836
|
-
* Ping test (no bearer token required)
|
|
837
|
-
* @description Simple connectivity test that returns 'pong'
|
|
838
|
-
* @returns Ping response containing 'pong' string
|
|
839
|
-
* @throws ValidationError When response is malformed
|
|
840
|
-
* @example
|
|
841
|
-
* ```typescript
|
|
842
|
-
* const pingResult = await client.ping();
|
|
843
|
-
* console.log(pingResult); // 'pong'
|
|
844
|
-
* ```
|
|
801
|
+
* Ping endpoint (no bearer token required)
|
|
845
802
|
*/
|
|
846
803
|
ping: () => Promise<{
|
|
847
804
|
params: Record<string, unknown> | unknown[];
|
|
@@ -855,45 +812,13 @@ export declare class JoomlaClient extends BaseServiceClient {
|
|
|
855
812
|
}>;
|
|
856
813
|
/**
|
|
857
814
|
* Health Data Operations
|
|
858
|
-
* @description Direct access to health check data without response metadata
|
|
859
815
|
*/
|
|
860
816
|
healthData: {
|
|
861
|
-
/**
|
|
862
|
-
* Get health check data without response metadata
|
|
863
|
-
* @returns Promise<unknown> Health status data directly
|
|
864
|
-
*/
|
|
865
817
|
check: () => Promise<{
|
|
866
818
|
siteHash: string;
|
|
867
819
|
siteId: string;
|
|
868
820
|
}>;
|
|
869
|
-
/**
|
|
870
|
-
* Get ping data without response metadata
|
|
871
|
-
* @returns Promise<unknown> Ping response data directly
|
|
872
|
-
*/
|
|
873
821
|
ping: () => Promise<"pong">;
|
|
874
822
|
};
|
|
875
|
-
/**
|
|
876
|
-
* Override getDiscoveryMetadata to provide hardcoded endpoint metadata
|
|
877
|
-
* This works around the JSDoc parsing issue in compiled JavaScript
|
|
878
|
-
*/
|
|
879
|
-
getDiscoveryMetadata(): {
|
|
880
|
-
serviceName: string;
|
|
881
|
-
description: string;
|
|
882
|
-
baseUrl: string;
|
|
883
|
-
endpoints: {
|
|
884
|
-
fullPath: string;
|
|
885
|
-
service: string;
|
|
886
|
-
domain: string;
|
|
887
|
-
method: string;
|
|
888
|
-
path: string;
|
|
889
|
-
description: string;
|
|
890
|
-
searchTerms: string[];
|
|
891
|
-
relatedEndpoints: string[];
|
|
892
|
-
commonPatterns: string[];
|
|
893
|
-
dataMethod: string;
|
|
894
|
-
discoverable: boolean;
|
|
895
|
-
}[];
|
|
896
|
-
};
|
|
897
823
|
}
|
|
898
|
-
export {};
|
|
899
824
|
//# sourceMappingURL=client.d.ts.map
|