@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
|
@@ -3,10 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
3
3
|
exports.JoomlaClient = void 0;
|
|
4
4
|
const base_client_1 = require("../../core/base-client");
|
|
5
5
|
const schemas_1 = require("./schemas");
|
|
6
|
-
const schemas_2 = require("../../core/schemas");
|
|
7
6
|
/**
|
|
8
|
-
* Joomla API Client
|
|
9
|
-
* @description
|
|
7
|
+
* Joomla API Client - OpenAPI Compliant
|
|
8
|
+
* @description Fully compliant client following OpenAPI Path Mirroring Pattern
|
|
10
9
|
* @example
|
|
11
10
|
* ```typescript
|
|
12
11
|
* import { HTTPClient } from '@augur/api-client/core';
|
|
@@ -15,1038 +14,691 @@ const schemas_2 = require("../../core/schemas");
|
|
|
15
14
|
* const http = new HTTPClient('joomla', { siteId: 'your-site-id', bearerToken: 'your-token' });
|
|
16
15
|
* const joomla = new JoomlaClient(http);
|
|
17
16
|
*
|
|
18
|
-
* //
|
|
19
|
-
* const content = await joomla.content.
|
|
17
|
+
* // OpenAPI Path Mirroring: /content GET -> client.content.get()
|
|
18
|
+
* const content = await joomla.content.get({ limit: 10 });
|
|
20
19
|
*
|
|
21
|
-
* //
|
|
22
|
-
* const auth = await joomla.users.verifyPassword({ username: 'user', password: 'pass' });
|
|
20
|
+
* // OpenAPI Path Mirroring: /users/verify-password POST -> client.users.verifyPassword.create()
|
|
21
|
+
* const auth = await joomla.users.verifyPassword.create({ username: 'user', password: 'pass' });
|
|
23
22
|
* ```
|
|
24
23
|
*/
|
|
25
24
|
class JoomlaClient extends base_client_1.BaseServiceClient {
|
|
26
|
-
/**
|
|
27
|
-
* Create a new JoomlaClient instance
|
|
28
|
-
* @param http Configured HTTPClient instance
|
|
29
|
-
* @param baseUrl Base URL for the Joomla API (default: https://joomla.augur-api.com)
|
|
30
|
-
*/
|
|
31
25
|
constructor(http, baseUrl = 'https://joomla.augur-api.com') {
|
|
32
26
|
super('joomla', http, baseUrl);
|
|
33
27
|
/**
|
|
34
|
-
* Content endpoints
|
|
35
|
-
* @description Methods for content management including articles, documents, and metadata
|
|
28
|
+
* Content endpoints - /content
|
|
36
29
|
*/
|
|
37
30
|
this.content = {
|
|
38
31
|
/**
|
|
39
|
-
*
|
|
40
|
-
* @
|
|
41
|
-
* @fullPath api.joomla.content.list
|
|
32
|
+
* List content items - /content GET
|
|
33
|
+
* @fullPath api.joomla.content.get
|
|
42
34
|
* @service joomla
|
|
43
35
|
* @domain content-management
|
|
44
|
-
* @dataMethod
|
|
45
|
-
* @pagination Uses count, total, totalResults for pagination metadata. Supports limit/offset parameters.
|
|
46
|
-
* @caching Supports edgeCache parameter (1-8 hours) for improved performance on content that changes infrequently
|
|
36
|
+
* @dataMethod getData() - returns only the content array without metadata
|
|
47
37
|
* @discoverable true
|
|
48
|
-
* @searchTerms ["content", "articles", "list content", "cms content"
|
|
49
|
-
* @relatedEndpoints ["api.joomla.content.get", "api.joomla.content.
|
|
50
|
-
* @commonPatterns ["list articles", "get content", "
|
|
51
|
-
* @param params Optional filtering, pagination, and caching parameters
|
|
52
|
-
* @param params.categoryIdList Comma-separated list of category IDs to filter content (e.g., '1,2,3')
|
|
53
|
-
* @param params.q Search query for filtering content by title/text
|
|
54
|
-
* @param params.limit Maximum number of content items to return (default: 20, max: 100)
|
|
55
|
-
* @param params.offset Number of items to skip for pagination (default: 0)
|
|
56
|
-
* @param params.edgeCache Cache duration in hours (1, 2, 3, 4, 5, 8) - recommended for content
|
|
57
|
-
* @returns BaseResponse<ContentItem[]> with pagination metadata and content array
|
|
58
|
-
* @throws ValidationError When parameters are invalid or response is malformed
|
|
59
|
-
* @example
|
|
60
|
-
* ```typescript
|
|
61
|
-
* // Get all content with full response metadata
|
|
62
|
-
* const response = await api.joomla.content.list();
|
|
63
|
-
* console.log(`Found ${response.total} articles, showing ${response.data.length}`);
|
|
64
|
-
*
|
|
65
|
-
* // Filter content by categories with search
|
|
66
|
-
* const filtered = await api.joomla.content.list({
|
|
67
|
-
* categoryIdList: '1,2,3',
|
|
68
|
-
* q: 'product review',
|
|
69
|
-
* limit: 10
|
|
70
|
-
* });
|
|
71
|
-
*
|
|
72
|
-
* // Get just content data without metadata
|
|
73
|
-
* const articles = await api.joomla.content.listData({
|
|
74
|
-
* categoryIdList: '5',
|
|
75
|
-
* limit: 20
|
|
76
|
-
* });
|
|
77
|
-
* articles.forEach(article => console.log(article.title, article.alias));
|
|
78
|
-
*
|
|
79
|
-
* // Use aggressive caching for content (recommended)
|
|
80
|
-
* const cachedContent = await api.joomla.content.list({
|
|
81
|
-
* edgeCache: 4, // Cache for 4 hours - content changes infrequently
|
|
82
|
-
* categoryIdList: '1,2,3'
|
|
83
|
-
* });
|
|
84
|
-
* ```
|
|
38
|
+
* @searchTerms ["content", "articles", "list content", "cms content"]
|
|
39
|
+
* @relatedEndpoints ["api.joomla.content.get", "api.joomla.content.doc.get"]
|
|
40
|
+
* @commonPatterns ["list articles", "get content", "cms articles"]
|
|
85
41
|
*/
|
|
86
|
-
|
|
42
|
+
get: async (params) => {
|
|
43
|
+
return this.executeRequest({
|
|
44
|
+
method: 'GET',
|
|
45
|
+
path: '/content',
|
|
46
|
+
paramsSchema: schemas_1.ContentParamsSchema,
|
|
47
|
+
responseSchema: schemas_1.ContentResponseSchema,
|
|
48
|
+
}, params);
|
|
49
|
+
},
|
|
87
50
|
/**
|
|
88
|
-
* Get content
|
|
89
|
-
* @
|
|
90
|
-
* @fullPath api.joomla.content.get
|
|
51
|
+
* Get content data only - /content GET (data method)
|
|
52
|
+
* @fullPath api.joomla.content.getData
|
|
91
53
|
* @service joomla
|
|
92
54
|
* @domain content-management
|
|
93
|
-
* @dataMethod getData(
|
|
94
|
-
* @caching Supports edgeCache parameter (1-8 hours) for improved performance
|
|
95
|
-
* @aliasLookup Supports alias-based lookup by using contentId=0 with params.alias
|
|
55
|
+
* @dataMethod getData() - returns only the content array without metadata
|
|
96
56
|
* @discoverable true
|
|
97
|
-
* @searchTerms ["
|
|
98
|
-
* @relatedEndpoints ["api.joomla.content.
|
|
99
|
-
* @commonPatterns ["get content
|
|
100
|
-
* @param contentId Content ID (number) or use 0 for alias lookup
|
|
101
|
-
* @param params Optional parameters for alias lookup and caching
|
|
102
|
-
* @param params.alias Content alias for lookup when contentId is 0
|
|
103
|
-
* @param params.catid Category ID for alias lookup specificity
|
|
104
|
-
* @param params.edgeCache Cache duration in hours (1, 2, 3, 4, 5, 8) for improved performance
|
|
105
|
-
* @returns BaseResponse<ContentItem> with complete content details and metadata
|
|
106
|
-
* @throws ValidationError When parameters are invalid or response is malformed
|
|
107
|
-
* @example
|
|
108
|
-
* ```typescript
|
|
109
|
-
* // Get content by ID with full response metadata
|
|
110
|
-
* const response = await api.joomla.content.get(123);
|
|
111
|
-
* console.log('Article:', response.data.title, 'Status:', response.status);
|
|
112
|
-
*
|
|
113
|
-
* // Get content by alias
|
|
114
|
-
* const byAlias = await api.joomla.content.get(0, {
|
|
115
|
-
* alias: 'my-article',
|
|
116
|
-
* catid: 45
|
|
117
|
-
* });
|
|
118
|
-
*
|
|
119
|
-
* // Get just content data without metadata
|
|
120
|
-
* const article = await api.joomla.content.getData(123);
|
|
121
|
-
* console.log(article.title, article.introtext, article.fulltext);
|
|
122
|
-
*
|
|
123
|
-
* // Use edge caching for frequently accessed content
|
|
124
|
-
* const cachedContent = await api.joomla.content.get(123, { edgeCache: 8 });
|
|
125
|
-
* ```
|
|
57
|
+
* @searchTerms ["content data", "articles data", "get content data", "cms content data"]
|
|
58
|
+
* @relatedEndpoints ["api.joomla.content.get"]
|
|
59
|
+
* @commonPatterns ["get content data only", "extract article data"]
|
|
126
60
|
*/
|
|
127
|
-
|
|
61
|
+
getData: async (params) => {
|
|
62
|
+
const response = await this.content.get(params);
|
|
63
|
+
return response.data;
|
|
64
|
+
},
|
|
65
|
+
/**
|
|
66
|
+
* Get content by ID - /content/{id} GET
|
|
67
|
+
* @fullPath api.joomla.content.getById
|
|
68
|
+
* @service joomla
|
|
69
|
+
* @domain content-management
|
|
70
|
+
* @dataMethod getByIdData() - returns only the content object without metadata
|
|
71
|
+
* @discoverable true
|
|
72
|
+
* @searchTerms ["content by id", "single article", "get article by id"]
|
|
73
|
+
* @relatedEndpoints ["api.joomla.content.get", "api.joomla.content.doc.get"]
|
|
74
|
+
* @commonPatterns ["get article details", "fetch content item"]
|
|
75
|
+
*/
|
|
76
|
+
getById: async (contentId, params) => {
|
|
128
77
|
return this.executeRequest({
|
|
129
78
|
method: 'GET',
|
|
130
79
|
path: '/content/{id}',
|
|
131
|
-
paramsSchema:
|
|
132
|
-
responseSchema: schemas_1.
|
|
80
|
+
paramsSchema: schemas_1.ContentIdParamsSchema,
|
|
81
|
+
responseSchema: schemas_1.ContentIdResponseSchema,
|
|
133
82
|
}, params, { id: String(contentId) });
|
|
134
83
|
},
|
|
135
84
|
/**
|
|
136
|
-
* Get content
|
|
137
|
-
* @
|
|
138
|
-
* @
|
|
139
|
-
* @
|
|
140
|
-
* @
|
|
141
|
-
* @
|
|
142
|
-
*
|
|
143
|
-
*
|
|
144
|
-
*
|
|
145
|
-
* ```
|
|
146
|
-
*/
|
|
147
|
-
getDoc: this.createDocMethod('/content/{id}/doc', schemas_1.GenericResponseSchema),
|
|
148
|
-
/**
|
|
149
|
-
* Retrieve a paginated list of content items (data only)
|
|
150
|
-
* @description Returns only the data array from content items response
|
|
151
|
-
* @param params Optional filtering, pagination, and caching parameters
|
|
152
|
-
* @returns Array of content items (data only)
|
|
153
|
-
* @throws ValidationError When parameters are invalid or response is malformed
|
|
154
|
-
*/
|
|
155
|
-
listData: async (params) => {
|
|
156
|
-
const response = await this.content.list(params);
|
|
157
|
-
return response.data;
|
|
158
|
-
},
|
|
159
|
-
/**
|
|
160
|
-
* Get content details by ID (data only)
|
|
161
|
-
* @description Returns only the data from content item details response
|
|
162
|
-
* @param contentId Content ID (number) or alias lookup (use 0 with params.alias)
|
|
163
|
-
* @param params Optional parameters for alias lookup and caching
|
|
164
|
-
* @returns Content item details (data only)
|
|
165
|
-
* @throws ValidationError When parameters are invalid or response is malformed
|
|
85
|
+
* Get content by ID data only - /content/{id} GET (data method)
|
|
86
|
+
* @fullPath api.joomla.content.getByIdData
|
|
87
|
+
* @service joomla
|
|
88
|
+
* @domain content-management
|
|
89
|
+
* @dataMethod getByIdData() - returns only the content object without metadata
|
|
90
|
+
* @discoverable true
|
|
91
|
+
* @searchTerms ["content data by id", "article data", "single content data"]
|
|
92
|
+
* @relatedEndpoints ["api.joomla.content.getById"]
|
|
93
|
+
* @commonPatterns ["extract article data", "get content data only"]
|
|
166
94
|
*/
|
|
167
|
-
|
|
168
|
-
const response = await this.content.
|
|
95
|
+
getByIdData: async (contentId, params) => {
|
|
96
|
+
const response = await this.content.getById(contentId, params);
|
|
169
97
|
return response.data;
|
|
170
98
|
},
|
|
171
99
|
/**
|
|
172
|
-
*
|
|
173
|
-
* @description Returns only the data from enhanced content document response
|
|
174
|
-
* @param contentId Content ID (number) or alias lookup (use 0 with query params)
|
|
175
|
-
* @returns Enhanced content document (data only)
|
|
176
|
-
* @throws ValidationError When response is malformed
|
|
100
|
+
* Content document endpoints - /content/{id}/doc
|
|
177
101
|
*/
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
102
|
+
doc: {
|
|
103
|
+
/**
|
|
104
|
+
* Get content document - /content/{id}/doc GET
|
|
105
|
+
* @fullPath api.joomla.content.doc.get
|
|
106
|
+
* @service joomla
|
|
107
|
+
* @domain content-management
|
|
108
|
+
* @dataMethod getData() - returns only the document data without metadata
|
|
109
|
+
* @discoverable true
|
|
110
|
+
* @searchTerms ["content document", "article document", "content doc", "full content"]
|
|
111
|
+
* @relatedEndpoints ["api.joomla.content.getById"]
|
|
112
|
+
* @commonPatterns ["get full content document", "fetch article with metadata"]
|
|
113
|
+
*/
|
|
114
|
+
get: async (contentId, params) => {
|
|
115
|
+
return this.executeRequest({
|
|
116
|
+
method: 'GET',
|
|
117
|
+
path: '/content/{id}/doc',
|
|
118
|
+
paramsSchema: schemas_1.ContentIdDocParamsSchema,
|
|
119
|
+
responseSchema: schemas_1.ContentIdDocResponseSchema,
|
|
120
|
+
}, params, { id: String(contentId) });
|
|
121
|
+
},
|
|
122
|
+
/**
|
|
123
|
+
* Get content document data only - /content/{id}/doc GET (data method)
|
|
124
|
+
* @fullPath api.joomla.content.doc.getData
|
|
125
|
+
* @service joomla
|
|
126
|
+
* @domain content-management
|
|
127
|
+
* @dataMethod getData() - returns only the document data without metadata
|
|
128
|
+
* @discoverable true
|
|
129
|
+
* @searchTerms ["content document data", "article doc data", "full content data"]
|
|
130
|
+
* @relatedEndpoints ["api.joomla.content.doc.get"]
|
|
131
|
+
* @commonPatterns ["extract document data", "get full content data only"]
|
|
132
|
+
*/
|
|
133
|
+
getData: async (contentId, params) => {
|
|
134
|
+
const response = await this.content.doc.get(contentId, params);
|
|
135
|
+
return response.data;
|
|
136
|
+
},
|
|
181
137
|
},
|
|
182
138
|
};
|
|
183
139
|
/**
|
|
184
|
-
*
|
|
185
|
-
* @description Methods for user management including authentication, CRUD operations, and group management
|
|
140
|
+
* Health check endpoint - /health-check
|
|
186
141
|
*/
|
|
187
|
-
this.
|
|
142
|
+
this.healthCheck = {
|
|
188
143
|
/**
|
|
189
|
-
*
|
|
190
|
-
* @
|
|
191
|
-
* @fullPath api.joomla.users.list
|
|
144
|
+
* Service health check
|
|
145
|
+
* @fullPath api.joomla.healthCheck.get
|
|
192
146
|
* @service joomla
|
|
193
|
-
* @domain
|
|
194
|
-
* @dataMethod
|
|
195
|
-
* @pagination Uses count, total, totalResults for pagination metadata. Supports limit/offset parameters.
|
|
196
|
-
* @caching Supports edgeCache parameter (1-8 hours) for improved performance
|
|
147
|
+
* @domain system
|
|
148
|
+
* @dataMethod getData() - returns only the health data without metadata
|
|
197
149
|
* @discoverable true
|
|
198
|
-
* @searchTerms ["users", "list users", "get users", "user management", "accounts", "profiles"]
|
|
199
|
-
* @relatedEndpoints ["api.joomla.userGroups.list", "api.customers.customer.list", "api.joomla.users.get"]
|
|
200
|
-
* @commonPatterns ["list all users", "search users", "paginate users", "filter users"]
|
|
201
|
-
* @param params Optional filtering, pagination, and caching parameters
|
|
202
|
-
* @param params.q Search query for filtering users by username/email (optional)
|
|
203
|
-
* @param params.limit Maximum number of users to return (default: 20, max: 100)
|
|
204
|
-
* @param params.offset Number of users to skip for pagination (default: 0)
|
|
205
|
-
* @param params.edgeCache Cache duration in hours (1, 2, 3, 4, 5, 8) for improved performance
|
|
206
|
-
* @returns BaseResponse<User[]> with pagination metadata and user array
|
|
207
|
-
* @throws ValidationError When parameters are invalid or response is malformed
|
|
208
|
-
* @example
|
|
209
|
-
* ```typescript
|
|
210
|
-
* // Get all users without search filter
|
|
211
|
-
* const response = await api.joomla.users.list();
|
|
212
|
-
* console.log(`Found ${response.total} users, showing ${response.data.length}`);
|
|
213
|
-
* console.log('Pagination:', { count: response.count, total: response.total });
|
|
214
|
-
*
|
|
215
|
-
* // Search users with specific query and pagination
|
|
216
|
-
* const searchResults = await api.joomla.users.list({
|
|
217
|
-
* q: 'simple',
|
|
218
|
-
* limit: 10,
|
|
219
|
-
* offset: 0
|
|
220
|
-
* });
|
|
221
|
-
*
|
|
222
|
-
* // Get just user data without metadata (using data method)
|
|
223
|
-
* const users = await api.joomla.users.listData({ limit: 20 });
|
|
224
|
-
* users.forEach(user => console.log(user.username, user.email));
|
|
225
|
-
*
|
|
226
|
-
* // Use edge caching for performance
|
|
227
|
-
* const cachedUsers = await api.joomla.users.list({
|
|
228
|
-
* edgeCache: 2, // Cache for 2 hours
|
|
229
|
-
* limit: 50
|
|
230
|
-
* });
|
|
231
|
-
* ```
|
|
232
150
|
*/
|
|
233
|
-
|
|
234
|
-
/**
|
|
235
|
-
* Get user details by ID
|
|
236
|
-
* @description Returns detailed information for a specific user including profile data and metadata
|
|
237
|
-
* @fullPath api.joomla.users.get
|
|
238
|
-
* @service joomla
|
|
239
|
-
* @domain user-management
|
|
240
|
-
* @dataMethod getData(userId, params) - returns only the user object without metadata
|
|
241
|
-
* @caching Supports edgeCache parameter (1-8 hours) for improved performance
|
|
242
|
-
* @discoverable true
|
|
243
|
-
* @searchTerms ["get user", "user details", "user profile", "user by id", "single user"]
|
|
244
|
-
* @relatedEndpoints ["api.joomla.users.list", "api.joomla.users.getDoc", "api.joomla.users.getTrinityDoc"]
|
|
245
|
-
* @commonPatterns ["get user by id", "fetch user profile", "user details lookup"]
|
|
246
|
-
* @param userId User ID (number or string) - the unique identifier for the user
|
|
247
|
-
* @param params Optional caching parameters
|
|
248
|
-
* @param params.edgeCache Cache duration in hours (1, 2, 3, 4, 5, 8) for improved performance
|
|
249
|
-
* @returns BaseResponse<User> with complete user details and metadata
|
|
250
|
-
* @throws ValidationError When userId is invalid or response is malformed
|
|
251
|
-
* @example
|
|
252
|
-
* ```typescript
|
|
253
|
-
* // Get user with full response metadata
|
|
254
|
-
* const response = await api.joomla.users.get(123);
|
|
255
|
-
* console.log('User:', response.data.username, response.data.email);
|
|
256
|
-
* console.log('Status:', response.status, response.message);
|
|
257
|
-
*
|
|
258
|
-
* // Get just user data without metadata
|
|
259
|
-
* const user = await api.joomla.users.getData(123);
|
|
260
|
-
* console.log(user.username, user.email, user.registerDate);
|
|
261
|
-
*
|
|
262
|
-
* // Use edge caching for frequently accessed users
|
|
263
|
-
* const cachedUser = await api.joomla.users.get(123, { edgeCache: 1 });
|
|
264
|
-
* ```
|
|
265
|
-
*/
|
|
266
|
-
get: async (userId) => {
|
|
267
|
-
return this.executeRequest({
|
|
268
|
-
method: 'GET',
|
|
269
|
-
path: '/users/{id}',
|
|
270
|
-
responseSchema: schemas_1.GenericResponseSchema,
|
|
271
|
-
}, undefined, { id: String(userId) });
|
|
272
|
-
},
|
|
273
|
-
/**
|
|
274
|
-
* Get user documentation
|
|
275
|
-
* @description Returns enhanced user document with profile values, customer information, and metadata
|
|
276
|
-
* @param userId User ID (number or string)
|
|
277
|
-
* @returns Enhanced user document with profile data
|
|
278
|
-
* @throws ValidationError When response is malformed
|
|
279
|
-
* @example
|
|
280
|
-
* ```typescript
|
|
281
|
-
* const userDoc = await client.users.getDoc(123);
|
|
282
|
-
* console.log(userDoc.username, userDoc.email, userDoc.customerId);
|
|
283
|
-
* console.log(userDoc.profileValues?.['simpleweb_customer.simpleweb_customer_companyname']);
|
|
284
|
-
* ```
|
|
285
|
-
*/
|
|
286
|
-
getDoc: async (userId) => {
|
|
151
|
+
get: async () => {
|
|
287
152
|
return this.executeRequest({
|
|
288
153
|
method: 'GET',
|
|
289
|
-
path: '/
|
|
290
|
-
responseSchema: schemas_1.
|
|
291
|
-
}
|
|
154
|
+
path: '/health-check',
|
|
155
|
+
responseSchema: schemas_1.HealthCheckResponseSchema,
|
|
156
|
+
});
|
|
292
157
|
},
|
|
293
158
|
/**
|
|
294
|
-
* Get
|
|
295
|
-
* @
|
|
296
|
-
* @
|
|
297
|
-
* @
|
|
298
|
-
* @
|
|
299
|
-
* @
|
|
300
|
-
* @
|
|
301
|
-
*
|
|
302
|
-
*
|
|
303
|
-
* console.log(trinity.profile.companyName, trinity.territory, trinity.role);
|
|
304
|
-
*
|
|
305
|
-
* // With filtering
|
|
306
|
-
* const filtered = await client.users.getTrinityDoc(123, { q: 'search', limit: 5 });
|
|
307
|
-
* ```
|
|
159
|
+
* Get service health data only - /health-check GET (data method)
|
|
160
|
+
* @fullPath api.joomla.healthCheck.getData
|
|
161
|
+
* @service joomla
|
|
162
|
+
* @domain system
|
|
163
|
+
* @dataMethod getData() - returns only the health data without metadata
|
|
164
|
+
* @discoverable true
|
|
165
|
+
* @searchTerms ["health data", "service health data", "health check data"]
|
|
166
|
+
* @relatedEndpoints ["api.joomla.healthCheck.get"]
|
|
167
|
+
* @commonPatterns ["extract health data", "get health status only"]
|
|
308
168
|
*/
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
path: '/users/{id}/trinity',
|
|
313
|
-
paramsSchema: schemas_2.BaseGetParamsSchema,
|
|
314
|
-
responseSchema: schemas_1.GenericResponseSchema,
|
|
315
|
-
}, params, { id: String(userId) });
|
|
169
|
+
getData: async () => {
|
|
170
|
+
const response = await this.healthCheck.get();
|
|
171
|
+
return response.data;
|
|
316
172
|
},
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
173
|
+
};
|
|
174
|
+
/**
|
|
175
|
+
* Menu endpoints - /menu/{id}/doc
|
|
176
|
+
*/
|
|
177
|
+
this.menu = {
|
|
178
|
+
doc: {
|
|
322
179
|
/**
|
|
323
|
-
* Get
|
|
324
|
-
* @
|
|
325
|
-
* @fullPath api.joomla.users.groups.list
|
|
180
|
+
* Get menu document - /menu/{id}/doc GET
|
|
181
|
+
* @fullPath api.joomla.menu.doc.get
|
|
326
182
|
* @service joomla
|
|
327
|
-
* @domain
|
|
328
|
-
* @dataMethod
|
|
183
|
+
* @domain menu-management
|
|
184
|
+
* @dataMethod getData() - returns only the menu data without metadata
|
|
329
185
|
* @discoverable true
|
|
330
|
-
* @searchTerms ["
|
|
331
|
-
* @relatedEndpoints ["api.joomla.
|
|
332
|
-
* @commonPatterns ["get
|
|
333
|
-
* @param userId User ID (string) - the unique identifier for the user
|
|
334
|
-
* @param params Optional pagination parameters
|
|
335
|
-
* @param params.limit Maximum number of group memberships to return (default: 20)
|
|
336
|
-
* @param params.offset Number of memberships to skip for pagination (default: 0)
|
|
337
|
-
* @returns BaseResponse<UserGroupMembership[]> with group membership details and metadata
|
|
338
|
-
* @throws ValidationError When response is malformed
|
|
339
|
-
* @example
|
|
340
|
-
* ```typescript
|
|
341
|
-
* // Get user's groups with full response metadata
|
|
342
|
-
* const response = await api.joomla.users.groups.list('123');
|
|
343
|
-
* response.data.forEach(group => {
|
|
344
|
-
* console.log(`Group: ${group.title} (ID: ${group.groupId})`);
|
|
345
|
-
* });
|
|
346
|
-
*
|
|
347
|
-
* // Get just group memberships data without metadata
|
|
348
|
-
* const groups = await api.joomla.users.groups.listData('123');
|
|
349
|
-
* groups.forEach(group => console.log(group.title, group.groupId));
|
|
350
|
-
* ```
|
|
351
|
-
*/
|
|
352
|
-
list: async (userId, params) => {
|
|
353
|
-
return this.executeRequest({
|
|
354
|
-
method: 'GET',
|
|
355
|
-
path: '/users/{id}/groups',
|
|
356
|
-
paramsSchema: schemas_2.BaseGetParamsSchema,
|
|
357
|
-
responseSchema: schemas_1.GenericResponseSchema,
|
|
358
|
-
}, params, { id: userId });
|
|
359
|
-
},
|
|
360
|
-
/**
|
|
361
|
-
* Get specific user group membership
|
|
362
|
-
* @description Returns detailed information about a user's membership in a specific group
|
|
363
|
-
* @param userId User ID (string)
|
|
364
|
-
* @param groupId Group ID (number or string)
|
|
365
|
-
* @returns User group membership details
|
|
366
|
-
* @throws ValidationError When response is malformed
|
|
367
|
-
* @example
|
|
368
|
-
* ```typescript
|
|
369
|
-
* const membership = await client.users.groups.get('123', 1);
|
|
370
|
-
* console.log(membership.groupTitle, membership.memberSince);
|
|
371
|
-
* ```
|
|
186
|
+
* @searchTerms ["menu document", "menu doc", "menu item document"]
|
|
187
|
+
* @relatedEndpoints ["api.joomla.content.doc.get"]
|
|
188
|
+
* @commonPatterns ["get menu document", "fetch menu item details"]
|
|
372
189
|
*/
|
|
373
|
-
get: async (
|
|
190
|
+
get: async (menuId) => {
|
|
374
191
|
return this.executeRequest({
|
|
375
192
|
method: 'GET',
|
|
376
|
-
path: '/
|
|
377
|
-
responseSchema: schemas_1.
|
|
378
|
-
}, undefined, { id:
|
|
193
|
+
path: '/menu/{id}/doc',
|
|
194
|
+
responseSchema: schemas_1.MenuIdDocResponseSchema,
|
|
195
|
+
}, undefined, { id: menuId });
|
|
379
196
|
},
|
|
380
197
|
/**
|
|
381
|
-
*
|
|
382
|
-
* @
|
|
383
|
-
* @
|
|
384
|
-
* @
|
|
385
|
-
* @returns
|
|
386
|
-
* @
|
|
387
|
-
* @
|
|
388
|
-
*
|
|
389
|
-
*
|
|
390
|
-
* console.log(mapping.created ? 'Created' : 'Updated', 'group mapping');
|
|
391
|
-
* ```
|
|
392
|
-
*/
|
|
393
|
-
createMapping: async (userId, request) => {
|
|
394
|
-
return this.executeRequest({
|
|
395
|
-
method: 'POST',
|
|
396
|
-
path: '/users/{id}/groups',
|
|
397
|
-
responseSchema: schemas_1.GenericResponseSchema,
|
|
398
|
-
}, request, { id: String(userId) });
|
|
399
|
-
},
|
|
400
|
-
/**
|
|
401
|
-
* Get user's groups (data only)
|
|
402
|
-
* @description Returns only the data array from user group memberships response
|
|
403
|
-
* @param userId User ID (string)
|
|
404
|
-
* @param params Optional pagination parameters
|
|
405
|
-
* @returns Array of user group memberships (data only)
|
|
406
|
-
* @throws ValidationError When response is malformed
|
|
407
|
-
*/
|
|
408
|
-
listData: async (userId, params) => {
|
|
409
|
-
const response = await this.users.groups.list(userId, params);
|
|
410
|
-
return response.data;
|
|
411
|
-
},
|
|
412
|
-
/**
|
|
413
|
-
* Get specific user group membership (data only)
|
|
414
|
-
* @description Returns only the data from user group membership details response
|
|
415
|
-
* @param userId User ID (string)
|
|
416
|
-
* @param groupId Group ID (number or string)
|
|
417
|
-
* @returns User group membership details (data only)
|
|
418
|
-
* @throws ValidationError When response is malformed
|
|
419
|
-
*/
|
|
420
|
-
getData: async (userId, groupId) => {
|
|
421
|
-
const response = await this.users.groups.get(userId, groupId);
|
|
422
|
-
return response.data;
|
|
423
|
-
},
|
|
424
|
-
/**
|
|
425
|
-
* Create or update user group mapping (data only)
|
|
426
|
-
* @description Returns only the data from created/updated group mapping response
|
|
427
|
-
* @param userId User ID (number or string)
|
|
428
|
-
* @param request Group mapping request data
|
|
429
|
-
* @returns Group mapping information (data only)
|
|
430
|
-
* @throws ValidationError When request is invalid or response is malformed
|
|
198
|
+
* Get menu document data only - /menu/{id}/doc GET (data method)
|
|
199
|
+
* @fullPath api.joomla.menu.doc.getData
|
|
200
|
+
* @service joomla
|
|
201
|
+
* @domain menu-management
|
|
202
|
+
* @dataMethod getData() - returns only the menu data without metadata
|
|
203
|
+
* @discoverable true
|
|
204
|
+
* @searchTerms ["menu document data", "menu doc data", "menu item data"]
|
|
205
|
+
* @relatedEndpoints ["api.joomla.menu.doc.get"]
|
|
206
|
+
* @commonPatterns ["extract menu data", "get menu document data only"]
|
|
431
207
|
*/
|
|
432
|
-
|
|
433
|
-
const response = await this.
|
|
208
|
+
getData: async (menuId) => {
|
|
209
|
+
const response = await this.menu.doc.get(menuId);
|
|
434
210
|
return response.data;
|
|
435
211
|
},
|
|
436
212
|
},
|
|
213
|
+
};
|
|
214
|
+
/**
|
|
215
|
+
* Tags endpoints - /tags
|
|
216
|
+
*/
|
|
217
|
+
this.tags = {
|
|
437
218
|
/**
|
|
438
|
-
*
|
|
439
|
-
* @
|
|
440
|
-
* @fullPath api.joomla.users.verifyPassword
|
|
219
|
+
* List content tags
|
|
220
|
+
* @fullPath api.joomla.tags.get
|
|
441
221
|
* @service joomla
|
|
442
|
-
* @domain
|
|
443
|
-
* @dataMethod
|
|
444
|
-
* @crossSite Supports authentication across multiple sites when called from 'augur_info' site
|
|
222
|
+
* @domain content-management
|
|
223
|
+
* @dataMethod getData() - returns only the tags array without metadata
|
|
445
224
|
* @discoverable true
|
|
446
|
-
* @searchTerms ["verify password", "authenticate", "login", "user authentication", "credentials", "sign in"]
|
|
447
|
-
* @relatedEndpoints ["api.joomla.users.get", "api.joomla.users.create", "api.customers.customer.get"]
|
|
448
|
-
* @commonPatterns ["user login", "authenticate user", "verify credentials", "password check"]
|
|
449
|
-
* @param request Authentication request containing username, password, and optional siteId
|
|
450
|
-
* @param request.username User's username for authentication
|
|
451
|
-
* @param request.password User's password for verification
|
|
452
|
-
* @param request.siteId Optional site ID for cross-site authentication (when using augur_info)
|
|
453
|
-
* @returns BaseResponse<VerifyPasswordResult> with verification status, user info, and JWT token
|
|
454
|
-
* @throws ValidationError When credentials are invalid or request is malformed
|
|
455
|
-
* @example
|
|
456
|
-
* ```typescript
|
|
457
|
-
* // Standard authentication with full response
|
|
458
|
-
* const response = await api.joomla.users.verifyPassword({
|
|
459
|
-
* username: 'johndoe',
|
|
460
|
-
* password: 'securePassword123'
|
|
461
|
-
* });
|
|
462
|
-
*
|
|
463
|
-
* if (response.data.verified) {
|
|
464
|
-
* console.log('Login successful:', response.data.username);
|
|
465
|
-
* console.log('JWT Token:', response.data.token);
|
|
466
|
-
* console.log('User ID:', response.data.userId);
|
|
467
|
-
* }
|
|
468
|
-
*
|
|
469
|
-
* // Cross-site authentication (when using augur_info site)
|
|
470
|
-
* const crossSiteAuth = await api.joomla.users.verifyPassword({
|
|
471
|
-
* username: 'johndoe',
|
|
472
|
-
* password: 'securePassword123',
|
|
473
|
-
* siteId: 'customer_site_1'
|
|
474
|
-
* });
|
|
475
|
-
*
|
|
476
|
-
* // Get just verification data without metadata
|
|
477
|
-
* const authResult = await api.joomla.users.verifyPasswordData({
|
|
478
|
-
* username: 'johndoe',
|
|
479
|
-
* password: 'securePassword123'
|
|
480
|
-
* });
|
|
481
|
-
* ```
|
|
482
225
|
*/
|
|
483
|
-
|
|
226
|
+
get: async (params) => {
|
|
484
227
|
return this.executeRequest({
|
|
485
|
-
method: '
|
|
486
|
-
path: '/
|
|
487
|
-
paramsSchema: schemas_1.
|
|
488
|
-
responseSchema: schemas_1.
|
|
489
|
-
},
|
|
228
|
+
method: 'GET',
|
|
229
|
+
path: '/tags',
|
|
230
|
+
paramsSchema: schemas_1.TagsParamsSchema,
|
|
231
|
+
responseSchema: schemas_1.TagsResponseSchema,
|
|
232
|
+
}, params);
|
|
490
233
|
},
|
|
491
234
|
/**
|
|
492
|
-
*
|
|
493
|
-
* @
|
|
494
|
-
* @fullPath api.joomla.users.create
|
|
235
|
+
* Get tags data only - /tags GET (data method)
|
|
236
|
+
* @fullPath api.joomla.tags.getData
|
|
495
237
|
* @service joomla
|
|
496
|
-
* @domain
|
|
497
|
-
* @dataMethod
|
|
238
|
+
* @domain content-management
|
|
239
|
+
* @dataMethod getData() - returns only the tags array without metadata
|
|
498
240
|
* @discoverable true
|
|
499
|
-
* @searchTerms ["
|
|
500
|
-
* @relatedEndpoints ["api.joomla.
|
|
501
|
-
* @commonPatterns ["
|
|
502
|
-
* @param request User creation request data including username, email, name, and password
|
|
503
|
-
* @param request.username Unique username for the new user (required)
|
|
504
|
-
* @param request.email Valid email address for the user (required)
|
|
505
|
-
* @param request.name Full display name for the user (required)
|
|
506
|
-
* @param request.password Secure password for the user (required, minimum 8 characters)
|
|
507
|
-
* @returns BaseResponse<User> with created user information including ID, username, and email
|
|
508
|
-
* @throws ValidationError When request is invalid or response is malformed
|
|
509
|
-
* @example
|
|
510
|
-
* ```typescript
|
|
511
|
-
* // Create new user with full response metadata
|
|
512
|
-
* const response = await api.joomla.users.create({
|
|
513
|
-
* username: 'newuser',
|
|
514
|
-
* email: 'user@example.com',
|
|
515
|
-
* name: 'New User',
|
|
516
|
-
* password: 'SecurePass123!'
|
|
517
|
-
* });
|
|
518
|
-
* console.log('Created user:', response.data.id, response.data.username);
|
|
519
|
-
* console.log('Status:', response.status, response.message);
|
|
520
|
-
*
|
|
521
|
-
* // Get just created user data without metadata
|
|
522
|
-
* const newUser = await api.joomla.users.createData({
|
|
523
|
-
* username: 'johndoe',
|
|
524
|
-
* email: 'john@example.com',
|
|
525
|
-
* name: 'John Doe',
|
|
526
|
-
* password: 'MySecurePassword123!'
|
|
527
|
-
* });
|
|
528
|
-
* console.log('New user ID:', newUser.id, 'Email:', newUser.email);
|
|
529
|
-
* ```
|
|
530
|
-
*/
|
|
531
|
-
create: this.createCreateMethod('/users', schemas_1.CreateUserRequestSchema, schemas_1.GenericResponseSchema),
|
|
532
|
-
/**
|
|
533
|
-
* Update an existing user
|
|
534
|
-
* @description Updates user information for an existing user account
|
|
535
|
-
* @param userId User ID (number or string)
|
|
536
|
-
* @param request User update data with optional fields to modify
|
|
537
|
-
* @returns Updated user object with all current information
|
|
538
|
-
* @throws ValidationError When request is invalid or response is malformed
|
|
539
|
-
* @example
|
|
540
|
-
* ```typescript
|
|
541
|
-
* const updatedUser = await client.users.update(123, {
|
|
542
|
-
* email: 'newemail@example.com',
|
|
543
|
-
* name: 'Updated Name',
|
|
544
|
-
* block: 0 // Unblock user
|
|
545
|
-
* });
|
|
546
|
-
* console.log('Updated user:', updatedUser.username, updatedUser.email);
|
|
547
|
-
* ```
|
|
241
|
+
* @searchTerms ["tags data", "content tags data", "get tags data only"]
|
|
242
|
+
* @relatedEndpoints ["api.joomla.tags.get"]
|
|
243
|
+
* @commonPatterns ["extract tags data", "get content tags data only"]
|
|
548
244
|
*/
|
|
549
|
-
|
|
245
|
+
getData: async (params) => {
|
|
246
|
+
const response = await this.tags.get(params);
|
|
247
|
+
return response.data;
|
|
248
|
+
},
|
|
249
|
+
};
|
|
250
|
+
/**
|
|
251
|
+
* Users endpoints - /users
|
|
252
|
+
*/
|
|
253
|
+
this.users = {
|
|
550
254
|
/**
|
|
551
|
-
*
|
|
552
|
-
* @
|
|
553
|
-
* @
|
|
554
|
-
* @
|
|
555
|
-
* @
|
|
556
|
-
* @
|
|
557
|
-
*
|
|
558
|
-
*
|
|
559
|
-
*
|
|
560
|
-
* console.log('User has been successfully blocked');
|
|
561
|
-
* }
|
|
562
|
-
* ```
|
|
255
|
+
* List users - /users GET
|
|
256
|
+
* @fullPath api.joomla.users.get
|
|
257
|
+
* @service joomla
|
|
258
|
+
* @domain user-management
|
|
259
|
+
* @dataMethod getData() - returns only the users array without metadata
|
|
260
|
+
* @discoverable true
|
|
261
|
+
* @searchTerms ["users", "list users", "get users", "user management", "user list"]
|
|
262
|
+
* @relatedEndpoints ["api.joomla.users.create", "api.joomla.users.getById"]
|
|
263
|
+
* @commonPatterns ["list all users", "get user list", "user management"]
|
|
563
264
|
*/
|
|
564
|
-
|
|
265
|
+
get: async (params) => {
|
|
266
|
+
return this.executeRequest({
|
|
267
|
+
method: 'GET',
|
|
268
|
+
path: '/users',
|
|
269
|
+
paramsSchema: schemas_1.UsersParamsSchema,
|
|
270
|
+
responseSchema: schemas_1.UsersResponseSchema,
|
|
271
|
+
}, params);
|
|
272
|
+
},
|
|
565
273
|
/**
|
|
566
|
-
*
|
|
567
|
-
* @
|
|
568
|
-
* @
|
|
569
|
-
* @
|
|
570
|
-
* @
|
|
274
|
+
* Get users data only - /users GET (data method)
|
|
275
|
+
* @fullPath api.joomla.users.getData
|
|
276
|
+
* @service joomla
|
|
277
|
+
* @domain user-management
|
|
278
|
+
* @dataMethod getData() - returns only the users array without metadata
|
|
279
|
+
* @discoverable true
|
|
280
|
+
* @searchTerms ["users data", "get users data", "user list data"]
|
|
281
|
+
* @relatedEndpoints ["api.joomla.users.get"]
|
|
282
|
+
* @commonPatterns ["extract users data", "get user list data only"]
|
|
571
283
|
*/
|
|
572
|
-
|
|
573
|
-
const response = await this.users.
|
|
284
|
+
getData: async (params) => {
|
|
285
|
+
const response = await this.users.get(params);
|
|
574
286
|
return response.data;
|
|
575
287
|
},
|
|
576
288
|
/**
|
|
577
|
-
*
|
|
578
|
-
* @
|
|
579
|
-
* @
|
|
580
|
-
* @
|
|
581
|
-
* @returns
|
|
582
|
-
* @
|
|
289
|
+
* Create user - /users POST
|
|
290
|
+
* @fullPath api.joomla.users.create
|
|
291
|
+
* @service joomla
|
|
292
|
+
* @domain user-management
|
|
293
|
+
* @dataMethod createData() - returns only the created user data without metadata
|
|
294
|
+
* @discoverable true
|
|
295
|
+
* @searchTerms ["create user", "add user", "new user", "user creation"]
|
|
296
|
+
* @relatedEndpoints ["api.joomla.users.get", "api.joomla.users.update"]
|
|
297
|
+
* @commonPatterns ["create new user account", "add user to system", "user registration"]
|
|
583
298
|
*/
|
|
584
|
-
|
|
585
|
-
|
|
586
|
-
|
|
299
|
+
create: async (request) => {
|
|
300
|
+
return this.executeRequest({
|
|
301
|
+
method: 'POST',
|
|
302
|
+
path: '/users',
|
|
303
|
+
paramsSchema: schemas_1.UsersCreateRequestSchema,
|
|
304
|
+
responseSchema: schemas_1.UsersCreateResponseSchema,
|
|
305
|
+
}, request);
|
|
587
306
|
},
|
|
588
307
|
/**
|
|
589
|
-
*
|
|
590
|
-
* @
|
|
591
|
-
* @
|
|
592
|
-
* @
|
|
593
|
-
* @
|
|
308
|
+
* Create user data only - /users POST (data method)
|
|
309
|
+
* @fullPath api.joomla.users.createData
|
|
310
|
+
* @service joomla
|
|
311
|
+
* @domain user-management
|
|
312
|
+
* @dataMethod createData() - returns only the created user data without metadata
|
|
313
|
+
* @discoverable true
|
|
314
|
+
* @searchTerms ["create user data", "add user data", "user creation data"]
|
|
315
|
+
* @relatedEndpoints ["api.joomla.users.create"]
|
|
316
|
+
* @commonPatterns ["extract created user data", "get new user data only"]
|
|
594
317
|
*/
|
|
595
|
-
|
|
596
|
-
const response = await this.users.
|
|
318
|
+
createData: async (request) => {
|
|
319
|
+
const response = await this.users.create(request);
|
|
597
320
|
return response.data;
|
|
598
321
|
},
|
|
599
322
|
/**
|
|
600
|
-
* Get
|
|
601
|
-
* @
|
|
602
|
-
* @
|
|
603
|
-
* @
|
|
604
|
-
* @returns
|
|
605
|
-
* @
|
|
323
|
+
* Get user by ID - /users/{id} GET
|
|
324
|
+
* @fullPath api.joomla.users.getById
|
|
325
|
+
* @service joomla
|
|
326
|
+
* @domain user-management
|
|
327
|
+
* @dataMethod getByIdData() - returns only the user data without metadata
|
|
328
|
+
* @discoverable true
|
|
329
|
+
* @searchTerms ["user by id", "get user", "single user", "user details"]
|
|
330
|
+
* @relatedEndpoints ["api.joomla.users.get", "api.joomla.users.update", "api.joomla.users.delete"]
|
|
331
|
+
* @commonPatterns ["get user details", "fetch user by id", "user profile"]
|
|
606
332
|
*/
|
|
607
|
-
|
|
608
|
-
|
|
609
|
-
|
|
333
|
+
getById: async (userId) => {
|
|
334
|
+
return this.executeRequest({
|
|
335
|
+
method: 'GET',
|
|
336
|
+
path: '/users/{id}',
|
|
337
|
+
responseSchema: schemas_1.UsersIdResponseSchema,
|
|
338
|
+
}, undefined, { id: String(userId) });
|
|
610
339
|
},
|
|
611
340
|
/**
|
|
612
|
-
*
|
|
613
|
-
* @
|
|
614
|
-
* @
|
|
615
|
-
* @
|
|
341
|
+
* Get user by ID data only - /users/{id} GET (data method)
|
|
342
|
+
* @fullPath api.joomla.users.getByIdData
|
|
343
|
+
* @service joomla
|
|
344
|
+
* @domain user-management
|
|
345
|
+
* @dataMethod getByIdData() - returns only the user data without metadata
|
|
346
|
+
* @discoverable true
|
|
347
|
+
* @searchTerms ["user data by id", "get user data", "single user data"]
|
|
348
|
+
* @relatedEndpoints ["api.joomla.users.getById"]
|
|
349
|
+
* @commonPatterns ["extract user data", "get user data only"]
|
|
616
350
|
*/
|
|
617
|
-
|
|
618
|
-
const response = await this.users.
|
|
351
|
+
getByIdData: async (userId) => {
|
|
352
|
+
const response = await this.users.getById(userId);
|
|
619
353
|
return response.data;
|
|
620
354
|
},
|
|
621
355
|
/**
|
|
622
|
-
*
|
|
623
|
-
* @
|
|
624
|
-
* @
|
|
625
|
-
* @
|
|
626
|
-
* @
|
|
356
|
+
* Update user - /users/{id} PUT
|
|
357
|
+
* @fullPath api.joomla.users.update
|
|
358
|
+
* @service joomla
|
|
359
|
+
* @domain user-management
|
|
360
|
+
* @dataMethod updateData() - returns only the updated user data without metadata
|
|
361
|
+
* @discoverable true
|
|
362
|
+
* @searchTerms ["update user", "edit user", "modify user", "user update"]
|
|
363
|
+
* @relatedEndpoints ["api.joomla.users.getById", "api.joomla.users.get"]
|
|
364
|
+
* @commonPatterns ["update user profile", "edit user details", "modify user account"]
|
|
627
365
|
*/
|
|
628
|
-
|
|
629
|
-
|
|
630
|
-
|
|
366
|
+
update: async (userId, request) => {
|
|
367
|
+
return this.executeRequest({
|
|
368
|
+
method: 'PUT',
|
|
369
|
+
path: '/users/{id}',
|
|
370
|
+
paramsSchema: schemas_1.UsersIdUpdateRequestSchema,
|
|
371
|
+
responseSchema: schemas_1.UsersIdUpdateResponseSchema,
|
|
372
|
+
}, request, { id: String(userId) });
|
|
631
373
|
},
|
|
632
374
|
/**
|
|
633
|
-
* Update
|
|
634
|
-
* @
|
|
635
|
-
* @
|
|
636
|
-
* @
|
|
637
|
-
* @returns
|
|
638
|
-
* @
|
|
375
|
+
* Update user data only - /users/{id} PUT (data method)
|
|
376
|
+
* @fullPath api.joomla.users.updateData
|
|
377
|
+
* @service joomla
|
|
378
|
+
* @domain user-management
|
|
379
|
+
* @dataMethod updateData() - returns only the updated user data without metadata
|
|
380
|
+
* @discoverable true
|
|
381
|
+
* @searchTerms ["update user data", "edit user data", "modify user data"]
|
|
382
|
+
* @relatedEndpoints ["api.joomla.users.update"]
|
|
383
|
+
* @commonPatterns ["extract updated user data", "get updated user data only"]
|
|
639
384
|
*/
|
|
640
385
|
updateData: async (userId, request) => {
|
|
641
386
|
const response = await this.users.update(userId, request);
|
|
642
387
|
return response.data;
|
|
643
388
|
},
|
|
644
389
|
/**
|
|
645
|
-
*
|
|
646
|
-
* @
|
|
647
|
-
* @
|
|
648
|
-
* @
|
|
649
|
-
* @
|
|
390
|
+
* Delete user - /users/{id} DELETE
|
|
391
|
+
* @fullPath api.joomla.users.delete
|
|
392
|
+
* @service joomla
|
|
393
|
+
* @domain user-management
|
|
394
|
+
* @dataMethod deleteData() - returns only the deletion result data without metadata
|
|
395
|
+
* @discoverable true
|
|
396
|
+
* @searchTerms ["delete user", "remove user", "user deletion"]
|
|
397
|
+
* @relatedEndpoints ["api.joomla.users.getById", "api.joomla.users.get"]
|
|
398
|
+
* @commonPatterns ["delete user account", "remove user", "deactivate user"]
|
|
650
399
|
*/
|
|
651
|
-
|
|
652
|
-
|
|
653
|
-
|
|
400
|
+
delete: async (userId) => {
|
|
401
|
+
return this.executeRequest({
|
|
402
|
+
method: 'DELETE',
|
|
403
|
+
path: '/users/{id}',
|
|
404
|
+
responseSchema: schemas_1.UsersIdDeleteResponseSchema,
|
|
405
|
+
}, undefined, { id: String(userId) });
|
|
654
406
|
},
|
|
655
|
-
};
|
|
656
|
-
/**
|
|
657
|
-
* User Groups endpoints
|
|
658
|
-
* @description Methods for managing system-wide user groups and their hierarchy
|
|
659
|
-
*/
|
|
660
|
-
this.userGroups = {
|
|
661
407
|
/**
|
|
662
|
-
*
|
|
663
|
-
* @
|
|
664
|
-
* @fullPath api.joomla.userGroups.list
|
|
408
|
+
* Delete user data only - /users/{id} DELETE (data method)
|
|
409
|
+
* @fullPath api.joomla.users.deleteData
|
|
665
410
|
* @service joomla
|
|
666
411
|
* @domain user-management
|
|
667
|
-
* @dataMethod
|
|
668
|
-
* @hierarchy Returns groups with level and parent relationship information
|
|
669
|
-
* @caching Supports edgeCache parameter (1-8 hours) - recommended since groups rarely change
|
|
412
|
+
* @dataMethod deleteData() - returns only the deletion result data without metadata
|
|
670
413
|
* @discoverable true
|
|
671
|
-
* @searchTerms ["user
|
|
672
|
-
* @relatedEndpoints ["api.joomla.users.
|
|
673
|
-
* @commonPatterns ["
|
|
674
|
-
* @param params Optional filtering, ordering, and caching parameters
|
|
675
|
-
* @param params.orderBy Sort order (e.g., 'title|ASC', 'title|DESC', 'level|ASC')
|
|
676
|
-
* @param params.parentIdList Comma-separated list of parent group IDs to filter (e.g., '1,2')
|
|
677
|
-
* @param params.edgeCache Cache duration in hours (1-8) - highly recommended since groups rarely change
|
|
678
|
-
* @returns BaseResponse<UserGroup[]> with hierarchy metadata and groups array
|
|
679
|
-
* @throws ValidationError When parameters are invalid or response is malformed
|
|
680
|
-
* @example
|
|
681
|
-
* ```typescript
|
|
682
|
-
* // Get all user groups with hierarchy information
|
|
683
|
-
* const response = await api.joomla.userGroups.list();
|
|
684
|
-
* response.data.forEach(group => {
|
|
685
|
-
* console.log(`${group.title} (Level: ${group.level}, Parent: ${group.parentId})`);
|
|
686
|
-
* });
|
|
687
|
-
*
|
|
688
|
-
* // Filter and order groups
|
|
689
|
-
* const ordered = await api.joomla.userGroups.list({
|
|
690
|
-
* orderBy: 'title|ASC',
|
|
691
|
-
* parentIdList: '1,2'
|
|
692
|
-
* });
|
|
693
|
-
*
|
|
694
|
-
* // Get just groups data without metadata
|
|
695
|
-
* const groups = await api.joomla.userGroups.listData({
|
|
696
|
-
* orderBy: 'level|ASC'
|
|
697
|
-
* });
|
|
698
|
-
*
|
|
699
|
-
* // Use long caching since groups rarely change
|
|
700
|
-
* const cachedGroups = await api.joomla.userGroups.list({
|
|
701
|
-
* edgeCache: 8, // Cache for 8 hours - groups change very infrequently
|
|
702
|
-
* orderBy: 'title|ASC'
|
|
703
|
-
* });
|
|
704
|
-
* ```
|
|
414
|
+
* @searchTerms ["delete user data", "remove user data", "user deletion data"]
|
|
415
|
+
* @relatedEndpoints ["api.joomla.users.delete"]
|
|
416
|
+
* @commonPatterns ["extract deletion result", "get deletion data only"]
|
|
705
417
|
*/
|
|
706
|
-
|
|
707
|
-
|
|
708
|
-
|
|
709
|
-
path: '/usergroups',
|
|
710
|
-
paramsSchema: schemas_2.BaseGetParamsSchema,
|
|
711
|
-
responseSchema: schemas_1.GenericResponseSchema,
|
|
712
|
-
}, params);
|
|
418
|
+
deleteData: async (userId) => {
|
|
419
|
+
const response = await this.users.delete(userId);
|
|
420
|
+
return response.data;
|
|
713
421
|
},
|
|
714
422
|
/**
|
|
715
|
-
*
|
|
716
|
-
* @description Returns only the data array from user groups response
|
|
717
|
-
* @param params Optional filtering, ordering, and caching parameters
|
|
718
|
-
* @returns Array of user groups (data only)
|
|
719
|
-
* @throws ValidationError When parameters are invalid or response is malformed
|
|
423
|
+
* User document - /users/{id}/doc
|
|
720
424
|
*/
|
|
721
|
-
|
|
722
|
-
|
|
723
|
-
|
|
425
|
+
doc: {
|
|
426
|
+
/**
|
|
427
|
+
* Get user document - /users/{id}/doc GET
|
|
428
|
+
* @fullPath api.joomla.users.doc.get
|
|
429
|
+
* @service joomla
|
|
430
|
+
* @domain user-management
|
|
431
|
+
* @dataMethod getData() - returns only the user document data without metadata
|
|
432
|
+
* @discoverable true
|
|
433
|
+
* @searchTerms ["user document", "user doc", "user full document"]
|
|
434
|
+
* @relatedEndpoints ["api.joomla.users.getById"]
|
|
435
|
+
* @commonPatterns ["get user document", "fetch user full details"]
|
|
436
|
+
*/
|
|
437
|
+
get: async (userId) => {
|
|
438
|
+
return this.executeRequest({
|
|
439
|
+
method: 'GET',
|
|
440
|
+
path: '/users/{id}/doc',
|
|
441
|
+
responseSchema: schemas_1.UsersIdDocResponseSchema,
|
|
442
|
+
}, undefined, { id: String(userId) });
|
|
443
|
+
},
|
|
444
|
+
/**
|
|
445
|
+
* Get user document data only - /users/{id}/doc GET (data method)
|
|
446
|
+
* @fullPath api.joomla.users.doc.getData
|
|
447
|
+
* @service joomla
|
|
448
|
+
* @domain user-management
|
|
449
|
+
* @dataMethod getData() - returns only the user document data without metadata
|
|
450
|
+
* @discoverable true
|
|
451
|
+
* @searchTerms ["user document data", "user doc data", "user full document data"]
|
|
452
|
+
* @relatedEndpoints ["api.joomla.users.doc.get"]
|
|
453
|
+
* @commonPatterns ["extract user document data", "get user document data only"]
|
|
454
|
+
*/
|
|
455
|
+
getData: async (userId) => {
|
|
456
|
+
const response = await this.users.doc.get(userId);
|
|
457
|
+
return response.data;
|
|
458
|
+
},
|
|
724
459
|
},
|
|
725
|
-
};
|
|
726
|
-
/**
|
|
727
|
-
* Tags endpoints
|
|
728
|
-
* @description Methods for managing content tags and their hierarchical relationships
|
|
729
|
-
*/
|
|
730
|
-
this.tags = {
|
|
731
460
|
/**
|
|
732
|
-
*
|
|
733
|
-
* @description Returns content tags with hierarchy, usage information, filtering, search, and edge caching
|
|
734
|
-
* @fullPath api.joomla.tags.list
|
|
735
|
-
* @service joomla
|
|
736
|
-
* @domain content-management
|
|
737
|
-
* @dataMethod listData(params) - returns only the tags array without metadata
|
|
738
|
-
* @hierarchy Returns tags with level and parent relationship information
|
|
739
|
-
* @caching Supports edgeCache parameter (1-8 hours) - recommended for reference data
|
|
740
|
-
* @discoverable true
|
|
741
|
-
* @searchTerms ["tags", "content tags", "taxonomy", "categories", "tag hierarchy"]
|
|
742
|
-
* @relatedEndpoints ["api.joomla.content.list", "api.joomla.content.get", "api.joomla.userGroups.list"]
|
|
743
|
-
* @commonPatterns ["list tags", "get tags", "search tags", "content taxonomy", "tag filtering"]
|
|
744
|
-
* @param params Optional filtering, search, and caching parameters
|
|
745
|
-
* @param params.q Search query for filtering tags by title
|
|
746
|
-
* @param params.catId Category ID to filter tags by category
|
|
747
|
-
* @param params.limit Maximum number of tags to return (default: 20, max: 100)
|
|
748
|
-
* @param params.offset Number of tags to skip for pagination (default: 0)
|
|
749
|
-
* @param params.edgeCache Cache duration in hours (1-8) - recommended for reference data
|
|
750
|
-
* @returns BaseResponse<Tag[]> with hierarchy metadata and tags array
|
|
751
|
-
* @throws ValidationError When parameters are invalid or response is malformed
|
|
752
|
-
* @example
|
|
753
|
-
* ```typescript
|
|
754
|
-
* // Get all tags with hierarchy information
|
|
755
|
-
* const response = await api.joomla.tags.list();
|
|
756
|
-
* response.data.forEach(tag => {
|
|
757
|
-
* console.log(`${tag.title} (${tag.hits} hits, Level: ${tag.level})`);
|
|
758
|
-
* });
|
|
759
|
-
*
|
|
760
|
-
* // Search tags by keyword
|
|
761
|
-
* const searchTags = await api.joomla.tags.list({
|
|
762
|
-
* q: 'technology',
|
|
763
|
-
* catId: 1,
|
|
764
|
-
* limit: 10
|
|
765
|
-
* });
|
|
766
|
-
*
|
|
767
|
-
* // Get just tags data without metadata
|
|
768
|
-
* const tags = await api.joomla.tags.listData({
|
|
769
|
-
* limit: 50
|
|
770
|
-
* });
|
|
771
|
-
* tags.forEach(tag => console.log(tag.title, tag.alias));
|
|
772
|
-
*
|
|
773
|
-
* // Use caching for reference data (recommended)
|
|
774
|
-
* const cachedTags = await api.joomla.tags.list({
|
|
775
|
-
* edgeCache: 5, // Cache for 5 hours - tags are reference data
|
|
776
|
-
* limit: 100
|
|
777
|
-
* });
|
|
778
|
-
* ```
|
|
461
|
+
* Trinity user document - /users/{id}/trinity
|
|
779
462
|
*/
|
|
780
|
-
|
|
463
|
+
trinity: {
|
|
464
|
+
/**
|
|
465
|
+
* Get trinity user document - /users/{id}/trinity GET
|
|
466
|
+
* @fullPath api.joomla.users.trinity.get
|
|
467
|
+
* @service joomla
|
|
468
|
+
* @domain user-management
|
|
469
|
+
* @dataMethod getData() - returns only the trinity user data without metadata
|
|
470
|
+
* @discoverable true
|
|
471
|
+
* @searchTerms ["trinity user", "user trinity", "trinity document"]
|
|
472
|
+
* @relatedEndpoints ["api.joomla.users.doc.get", "api.joomla.users.getById"]
|
|
473
|
+
* @commonPatterns ["get trinity user data", "fetch user trinity document"]
|
|
474
|
+
*/
|
|
475
|
+
get: async (userId, params) => {
|
|
476
|
+
return this.executeRequest({
|
|
477
|
+
method: 'GET',
|
|
478
|
+
path: '/users/{id}/trinity',
|
|
479
|
+
paramsSchema: schemas_1.UsersIdTrinityParamsSchema,
|
|
480
|
+
responseSchema: schemas_1.UsersIdTrinityResponseSchema,
|
|
481
|
+
}, params, { id: String(userId) });
|
|
482
|
+
},
|
|
483
|
+
/**
|
|
484
|
+
* Get trinity user document data only - /users/{id}/trinity GET (data method)
|
|
485
|
+
* @fullPath api.joomla.users.trinity.getData
|
|
486
|
+
* @service joomla
|
|
487
|
+
* @domain user-management
|
|
488
|
+
* @dataMethod getData() - returns only the trinity user data without metadata
|
|
489
|
+
* @discoverable true
|
|
490
|
+
* @searchTerms ["trinity user data", "user trinity data", "trinity document data"]
|
|
491
|
+
* @relatedEndpoints ["api.joomla.users.trinity.get"]
|
|
492
|
+
* @commonPatterns ["extract trinity user data", "get trinity data only"]
|
|
493
|
+
*/
|
|
494
|
+
getData: async (userId, params) => {
|
|
495
|
+
const response = await this.users.trinity.get(userId, params);
|
|
496
|
+
return response.data;
|
|
497
|
+
},
|
|
498
|
+
},
|
|
781
499
|
/**
|
|
782
|
-
*
|
|
783
|
-
* @description Returns only the data array from tags response
|
|
784
|
-
* @param params Optional filtering, search, and caching parameters
|
|
785
|
-
* @returns Array of tags (data only)
|
|
786
|
-
* @throws ValidationError When parameters are invalid or response is malformed
|
|
500
|
+
* User groups - /users/{id}/groups
|
|
787
501
|
*/
|
|
788
|
-
|
|
789
|
-
|
|
790
|
-
|
|
502
|
+
groups: {
|
|
503
|
+
/**
|
|
504
|
+
* List user groups - /users/{id}/groups GET
|
|
505
|
+
* @fullPath api.joomla.users.groups.get
|
|
506
|
+
* @service joomla
|
|
507
|
+
* @domain user-management
|
|
508
|
+
* @dataMethod getData() - returns only the user groups array without metadata
|
|
509
|
+
* @discoverable true
|
|
510
|
+
* @searchTerms ["user groups", "user group list", "groups for user"]
|
|
511
|
+
* @relatedEndpoints ["api.joomla.users.groups.create", "api.joomla.userGroups.get"]
|
|
512
|
+
* @commonPatterns ["get user groups", "list user group memberships"]
|
|
513
|
+
*/
|
|
514
|
+
get: async (userId, params) => {
|
|
515
|
+
return this.executeRequest({
|
|
516
|
+
method: 'GET',
|
|
517
|
+
path: '/users/{id}/groups',
|
|
518
|
+
paramsSchema: schemas_1.UsersIdGroupsParamsSchema,
|
|
519
|
+
responseSchema: schemas_1.UsersIdGroupsResponseSchema,
|
|
520
|
+
}, params, { id: userId });
|
|
521
|
+
},
|
|
522
|
+
/**
|
|
523
|
+
* Get user groups data only - /users/{id}/groups GET (data method)
|
|
524
|
+
* @fullPath api.joomla.users.groups.getData
|
|
525
|
+
* @service joomla
|
|
526
|
+
* @domain user-management
|
|
527
|
+
* @dataMethod getData() - returns only the user groups array without metadata
|
|
528
|
+
* @discoverable true
|
|
529
|
+
* @searchTerms ["user groups data", "user group list data", "groups data"]
|
|
530
|
+
* @relatedEndpoints ["api.joomla.users.groups.get"]
|
|
531
|
+
* @commonPatterns ["extract user groups data", "get groups data only"]
|
|
532
|
+
*/
|
|
533
|
+
getData: async (userId, params) => {
|
|
534
|
+
const response = await this.users.groups.get(userId, params);
|
|
535
|
+
return response.data;
|
|
536
|
+
},
|
|
537
|
+
/**
|
|
538
|
+
* Create user group mapping - /users/{id}/groups POST
|
|
539
|
+
* @fullPath api.joomla.users.groups.create
|
|
540
|
+
* @service joomla
|
|
541
|
+
* @domain user-management
|
|
542
|
+
* @dataMethod createData() - returns only the created group mapping data without metadata
|
|
543
|
+
* @discoverable true
|
|
544
|
+
* @searchTerms ["add user to group", "create user group mapping", "assign user group"]
|
|
545
|
+
* @relatedEndpoints ["api.joomla.users.groups.get", "api.joomla.users.groups.getById"]
|
|
546
|
+
* @commonPatterns ["add user to group", "assign group membership", "create group mapping"]
|
|
547
|
+
*/
|
|
548
|
+
create: async (userId, request) => {
|
|
549
|
+
return this.executeRequest({
|
|
550
|
+
method: 'POST',
|
|
551
|
+
path: '/users/{id}/groups',
|
|
552
|
+
paramsSchema: schemas_1.UsersIdGroupsCreateRequestSchema,
|
|
553
|
+
responseSchema: schemas_1.UsersIdGroupsCreateResponseSchema,
|
|
554
|
+
}, request, { id: String(userId) });
|
|
555
|
+
},
|
|
556
|
+
/**
|
|
557
|
+
* Create user group mapping data only - /users/{id}/groups POST (data method)
|
|
558
|
+
* @fullPath api.joomla.users.groups.createData
|
|
559
|
+
* @service joomla
|
|
560
|
+
* @domain user-management
|
|
561
|
+
* @dataMethod createData() - returns only the created group mapping data without metadata
|
|
562
|
+
* @discoverable true
|
|
563
|
+
* @searchTerms ["add user to group data", "create group mapping data", "assign user group data"]
|
|
564
|
+
* @relatedEndpoints ["api.joomla.users.groups.create"]
|
|
565
|
+
* @commonPatterns ["extract group mapping data", "get created mapping data only"]
|
|
566
|
+
*/
|
|
567
|
+
createData: async (userId, request) => {
|
|
568
|
+
const response = await this.users.groups.create(userId, request);
|
|
569
|
+
return response.data;
|
|
570
|
+
},
|
|
571
|
+
/**
|
|
572
|
+
* Get specific user group - /users/{id}/groups/{groupId} GET
|
|
573
|
+
* @fullPath api.joomla.users.groups.getById
|
|
574
|
+
* @service joomla
|
|
575
|
+
* @domain user-management
|
|
576
|
+
* @dataMethod getByIdData() - returns only the user group data without metadata
|
|
577
|
+
* @discoverable true
|
|
578
|
+
* @searchTerms ["user group by id", "specific user group", "user group details"]
|
|
579
|
+
* @relatedEndpoints ["api.joomla.users.groups.get", "api.joomla.userGroups.get"]
|
|
580
|
+
* @commonPatterns ["get specific user group", "fetch user group details"]
|
|
581
|
+
*/
|
|
582
|
+
getById: async (userId, groupId) => {
|
|
583
|
+
return this.executeRequest({
|
|
584
|
+
method: 'GET',
|
|
585
|
+
path: '/users/{id}/groups/{groupId}',
|
|
586
|
+
responseSchema: schemas_1.UsersIdGroupsGroupIdResponseSchema,
|
|
587
|
+
}, undefined, { id: userId, groupId: String(groupId) });
|
|
588
|
+
},
|
|
589
|
+
/**
|
|
590
|
+
* Get specific user group data only - /users/{id}/groups/{groupId} GET (data method)
|
|
591
|
+
* @fullPath api.joomla.users.groups.getByIdData
|
|
592
|
+
* @service joomla
|
|
593
|
+
* @domain user-management
|
|
594
|
+
* @dataMethod getByIdData() - returns only the user group data without metadata
|
|
595
|
+
* @discoverable true
|
|
596
|
+
* @searchTerms ["user group data by id", "specific user group data", "user group details data"]
|
|
597
|
+
* @relatedEndpoints ["api.joomla.users.groups.getById"]
|
|
598
|
+
* @commonPatterns ["extract user group data", "get specific group data only"]
|
|
599
|
+
*/
|
|
600
|
+
getByIdData: async (userId, groupId) => {
|
|
601
|
+
const response = await this.users.groups.getById(userId, groupId);
|
|
602
|
+
return response.data;
|
|
603
|
+
},
|
|
604
|
+
},
|
|
605
|
+
/**
|
|
606
|
+
* Password verification - /users/verify-password
|
|
607
|
+
*/
|
|
608
|
+
verifyPassword: {
|
|
609
|
+
/**
|
|
610
|
+
* Verify user password - /users/verify-password POST
|
|
611
|
+
* @fullPath api.joomla.users.verifyPassword.create
|
|
612
|
+
* @service joomla
|
|
613
|
+
* @domain user-management
|
|
614
|
+
* @dataMethod createData() - returns only the verification result data without metadata
|
|
615
|
+
* @discoverable true
|
|
616
|
+
* @searchTerms ["verify password", "check password", "authenticate user", "login verification"]
|
|
617
|
+
* @relatedEndpoints ["api.joomla.users.getById", "api.joomla.users.get"]
|
|
618
|
+
* @commonPatterns ["verify user password", "authenticate user", "check login credentials"]
|
|
619
|
+
*/
|
|
620
|
+
create: async (request) => {
|
|
621
|
+
return this.executeRequest({
|
|
622
|
+
method: 'POST',
|
|
623
|
+
path: '/users/verify-password',
|
|
624
|
+
paramsSchema: schemas_1.UsersVerifyPasswordRequestSchema,
|
|
625
|
+
responseSchema: schemas_1.UsersVerifyPasswordResponseSchema,
|
|
626
|
+
}, request);
|
|
627
|
+
},
|
|
628
|
+
/**
|
|
629
|
+
* Verify user password data only - /users/verify-password POST (data method)
|
|
630
|
+
* @fullPath api.joomla.users.verifyPassword.createData
|
|
631
|
+
* @service joomla
|
|
632
|
+
* @domain user-management
|
|
633
|
+
* @dataMethod createData() - returns only the verification result data without metadata
|
|
634
|
+
* @discoverable true
|
|
635
|
+
* @searchTerms ["verify password data", "check password data", "authentication result data"]
|
|
636
|
+
* @relatedEndpoints ["api.joomla.users.verifyPassword.create"]
|
|
637
|
+
* @commonPatterns ["extract verification result", "get authentication data only"]
|
|
638
|
+
*/
|
|
639
|
+
createData: async (request) => {
|
|
640
|
+
const response = await this.users.verifyPassword.create(request);
|
|
641
|
+
return response.data;
|
|
642
|
+
},
|
|
791
643
|
},
|
|
792
644
|
};
|
|
793
645
|
/**
|
|
794
|
-
*
|
|
795
|
-
* @description Methods for accessing menu structure and navigation documentation
|
|
646
|
+
* User Groups endpoints - /usergroups
|
|
796
647
|
*/
|
|
797
|
-
this.
|
|
648
|
+
this.userGroups = {
|
|
798
649
|
/**
|
|
799
|
-
*
|
|
800
|
-
* @
|
|
801
|
-
* @
|
|
802
|
-
* @
|
|
803
|
-
* @
|
|
804
|
-
* @
|
|
805
|
-
*
|
|
806
|
-
*
|
|
807
|
-
*
|
|
808
|
-
* console.log('Level:', menuDoc.data.level, 'Parent:', menuDoc.data.parentId);
|
|
809
|
-
* ```
|
|
650
|
+
* List user groups - /usergroups GET
|
|
651
|
+
* @fullPath api.joomla.userGroups.get
|
|
652
|
+
* @service joomla
|
|
653
|
+
* @domain user-management
|
|
654
|
+
* @dataMethod getData() - returns only the groups array without metadata
|
|
655
|
+
* @discoverable true
|
|
656
|
+
* @searchTerms ["user groups", "list groups", "all groups", "group management"]
|
|
657
|
+
* @relatedEndpoints ["api.joomla.users.groups.get"]
|
|
658
|
+
* @commonPatterns ["list all user groups", "get available groups", "group management"]
|
|
810
659
|
*/
|
|
811
|
-
|
|
660
|
+
get: async (params) => {
|
|
812
661
|
return this.executeRequest({
|
|
813
662
|
method: 'GET',
|
|
814
|
-
path: '/
|
|
815
|
-
|
|
816
|
-
|
|
663
|
+
path: '/usergroups',
|
|
664
|
+
paramsSchema: schemas_1.UserGroupsParamsSchema,
|
|
665
|
+
responseSchema: schemas_1.UserGroupsResponseSchema,
|
|
666
|
+
}, params);
|
|
817
667
|
},
|
|
818
668
|
/**
|
|
819
|
-
* Get
|
|
820
|
-
* @
|
|
821
|
-
* @
|
|
822
|
-
* @
|
|
823
|
-
* @
|
|
669
|
+
* Get user groups data only - /usergroups GET (data method)
|
|
670
|
+
* @fullPath api.joomla.userGroups.getData
|
|
671
|
+
* @service joomla
|
|
672
|
+
* @domain user-management
|
|
673
|
+
* @dataMethod getData() - returns only the groups array without metadata
|
|
674
|
+
* @discoverable true
|
|
675
|
+
* @searchTerms ["user groups data", "list groups data", "all groups data"]
|
|
676
|
+
* @relatedEndpoints ["api.joomla.userGroups.get"]
|
|
677
|
+
* @commonPatterns ["extract groups data", "get groups data only"]
|
|
824
678
|
*/
|
|
825
|
-
|
|
826
|
-
const response = await this.
|
|
679
|
+
getData: async (params) => {
|
|
680
|
+
const response = await this.userGroups.get(params);
|
|
827
681
|
return response.data;
|
|
828
682
|
},
|
|
829
683
|
};
|
|
830
684
|
/**
|
|
831
|
-
*
|
|
832
|
-
* @description Monitor service availability without authentication overhead
|
|
833
|
-
* @returns Health check response with site information
|
|
834
|
-
* @throws ValidationError When response is malformed
|
|
835
|
-
* @example
|
|
836
|
-
* ```typescript
|
|
837
|
-
* const health = await client.getHealthCheck();
|
|
838
|
-
* console.log('Service health:', health.status);
|
|
839
|
-
* console.log('Site ID:', health.data.siteId);
|
|
840
|
-
* console.log('Site Hash:', health.data.siteHash);
|
|
841
|
-
* ```
|
|
842
|
-
*/
|
|
843
|
-
this.getHealthCheck = this.createHealthCheckMethod(schemas_1.HealthCheckResponseSchema);
|
|
844
|
-
/**
|
|
845
|
-
* Ping test (no bearer token required)
|
|
846
|
-
* @description Simple connectivity test that returns 'pong'
|
|
847
|
-
* @returns Ping response containing 'pong' string
|
|
848
|
-
* @throws ValidationError When response is malformed
|
|
849
|
-
* @example
|
|
850
|
-
* ```typescript
|
|
851
|
-
* const pingResult = await client.ping();
|
|
852
|
-
* console.log(pingResult); // 'pong'
|
|
853
|
-
* ```
|
|
685
|
+
* Ping endpoint (no bearer token required)
|
|
854
686
|
*/
|
|
855
687
|
this.ping = this.createPingMethod(schemas_1.PingResponseSchema);
|
|
856
688
|
/**
|
|
857
689
|
* Health Data Operations
|
|
858
|
-
* @description Direct access to health check data without response metadata
|
|
859
690
|
*/
|
|
860
691
|
this.healthData = {
|
|
861
|
-
/**
|
|
862
|
-
* Get health check data without response metadata
|
|
863
|
-
* @returns Promise<unknown> Health status data directly
|
|
864
|
-
*/
|
|
865
692
|
check: async () => {
|
|
866
|
-
const response = await this.
|
|
693
|
+
const response = await this.healthCheck.get();
|
|
867
694
|
return response.data;
|
|
868
695
|
},
|
|
869
|
-
/**
|
|
870
|
-
* Get ping data without response metadata
|
|
871
|
-
* @returns Promise<unknown> Ping response data directly
|
|
872
|
-
*/
|
|
873
696
|
ping: async () => {
|
|
874
697
|
const response = await this.ping();
|
|
875
698
|
return response.data;
|
|
876
699
|
},
|
|
877
700
|
};
|
|
878
701
|
}
|
|
879
|
-
/**
|
|
880
|
-
* Override getDiscoveryMetadata to provide hardcoded endpoint metadata
|
|
881
|
-
* This works around the JSDoc parsing issue in compiled JavaScript
|
|
882
|
-
*/
|
|
883
|
-
getDiscoveryMetadata() {
|
|
884
|
-
return {
|
|
885
|
-
serviceName: this.serviceName,
|
|
886
|
-
description: this.getServiceDescription(),
|
|
887
|
-
baseUrl: this.baseUrl,
|
|
888
|
-
endpoints: [
|
|
889
|
-
{
|
|
890
|
-
fullPath: 'api.joomla.users.list',
|
|
891
|
-
service: 'joomla',
|
|
892
|
-
domain: 'user-management',
|
|
893
|
-
method: 'GET',
|
|
894
|
-
path: '/users',
|
|
895
|
-
description: 'Retrieve a paginated list of users',
|
|
896
|
-
searchTerms: [
|
|
897
|
-
'users',
|
|
898
|
-
'list users',
|
|
899
|
-
'get users',
|
|
900
|
-
'user management',
|
|
901
|
-
'accounts',
|
|
902
|
-
'profiles',
|
|
903
|
-
],
|
|
904
|
-
relatedEndpoints: [
|
|
905
|
-
'api.joomla.userGroups.list',
|
|
906
|
-
'api.customers.customer.list',
|
|
907
|
-
'api.joomla.users.get',
|
|
908
|
-
],
|
|
909
|
-
commonPatterns: ['list all users', 'search users', 'paginate users', 'filter users'],
|
|
910
|
-
dataMethod: 'listData()',
|
|
911
|
-
discoverable: true,
|
|
912
|
-
},
|
|
913
|
-
{
|
|
914
|
-
fullPath: 'api.joomla.users.get',
|
|
915
|
-
service: 'joomla',
|
|
916
|
-
domain: 'user-management',
|
|
917
|
-
method: 'GET',
|
|
918
|
-
path: '/users/{id}',
|
|
919
|
-
description: 'Get user details by ID',
|
|
920
|
-
searchTerms: ['get user', 'user details', 'user profile', 'user by id', 'single user'],
|
|
921
|
-
relatedEndpoints: [
|
|
922
|
-
'api.joomla.users.list',
|
|
923
|
-
'api.joomla.users.getDoc',
|
|
924
|
-
'api.joomla.users.getTrinityDoc',
|
|
925
|
-
],
|
|
926
|
-
commonPatterns: ['get user by id', 'fetch user profile', 'user details lookup'],
|
|
927
|
-
dataMethod: 'getData(userId, params)',
|
|
928
|
-
discoverable: true,
|
|
929
|
-
},
|
|
930
|
-
{
|
|
931
|
-
fullPath: 'api.joomla.users.verifyPassword',
|
|
932
|
-
service: 'joomla',
|
|
933
|
-
domain: 'authentication',
|
|
934
|
-
method: 'POST',
|
|
935
|
-
path: '/users/verify-password',
|
|
936
|
-
description: 'Verify user credentials and authenticate',
|
|
937
|
-
searchTerms: [
|
|
938
|
-
'verify password',
|
|
939
|
-
'authenticate',
|
|
940
|
-
'login',
|
|
941
|
-
'user authentication',
|
|
942
|
-
'credentials',
|
|
943
|
-
'sign in',
|
|
944
|
-
],
|
|
945
|
-
relatedEndpoints: [
|
|
946
|
-
'api.joomla.users.get',
|
|
947
|
-
'api.joomla.users.create',
|
|
948
|
-
'api.customers.customer.get',
|
|
949
|
-
],
|
|
950
|
-
commonPatterns: [
|
|
951
|
-
'user login',
|
|
952
|
-
'authenticate user',
|
|
953
|
-
'verify credentials',
|
|
954
|
-
'password check',
|
|
955
|
-
],
|
|
956
|
-
dataMethod: 'verifyPasswordData(request)',
|
|
957
|
-
discoverable: true,
|
|
958
|
-
},
|
|
959
|
-
{
|
|
960
|
-
fullPath: 'api.joomla.users.create',
|
|
961
|
-
service: 'joomla',
|
|
962
|
-
domain: 'user-management',
|
|
963
|
-
method: 'POST',
|
|
964
|
-
path: '/users',
|
|
965
|
-
description: 'Create a new user account',
|
|
966
|
-
searchTerms: [
|
|
967
|
-
'create user',
|
|
968
|
-
'new user',
|
|
969
|
-
'user registration',
|
|
970
|
-
'add user',
|
|
971
|
-
'register user',
|
|
972
|
-
],
|
|
973
|
-
relatedEndpoints: [
|
|
974
|
-
'api.joomla.users.list',
|
|
975
|
-
'api.joomla.users.get',
|
|
976
|
-
'api.joomla.users.verifyPassword',
|
|
977
|
-
],
|
|
978
|
-
commonPatterns: [
|
|
979
|
-
'register new user',
|
|
980
|
-
'create account',
|
|
981
|
-
'add user account',
|
|
982
|
-
'user signup',
|
|
983
|
-
],
|
|
984
|
-
dataMethod: 'createData(request)',
|
|
985
|
-
discoverable: true,
|
|
986
|
-
},
|
|
987
|
-
{
|
|
988
|
-
fullPath: 'api.joomla.content.list',
|
|
989
|
-
service: 'joomla',
|
|
990
|
-
domain: 'content-management',
|
|
991
|
-
method: 'GET',
|
|
992
|
-
path: '/content',
|
|
993
|
-
description: 'Retrieve a paginated list of content items',
|
|
994
|
-
searchTerms: [
|
|
995
|
-
'content',
|
|
996
|
-
'articles',
|
|
997
|
-
'list content',
|
|
998
|
-
'cms content',
|
|
999
|
-
'documents',
|
|
1000
|
-
'blog posts',
|
|
1001
|
-
],
|
|
1002
|
-
relatedEndpoints: [
|
|
1003
|
-
'api.joomla.content.get',
|
|
1004
|
-
'api.joomla.content.getDoc',
|
|
1005
|
-
'api.joomla.tags.list',
|
|
1006
|
-
],
|
|
1007
|
-
commonPatterns: [
|
|
1008
|
-
'list articles',
|
|
1009
|
-
'get content',
|
|
1010
|
-
'blog content',
|
|
1011
|
-
'cms articles',
|
|
1012
|
-
'filter content',
|
|
1013
|
-
],
|
|
1014
|
-
dataMethod: 'listData()',
|
|
1015
|
-
discoverable: true,
|
|
1016
|
-
},
|
|
1017
|
-
{
|
|
1018
|
-
fullPath: 'api.joomla.userGroups.list',
|
|
1019
|
-
service: 'joomla',
|
|
1020
|
-
domain: 'user-management',
|
|
1021
|
-
method: 'GET',
|
|
1022
|
-
path: '/usergroups',
|
|
1023
|
-
description: 'Get hierarchical list of user groups',
|
|
1024
|
-
searchTerms: [
|
|
1025
|
-
'user groups',
|
|
1026
|
-
'groups',
|
|
1027
|
-
'permissions',
|
|
1028
|
-
'roles',
|
|
1029
|
-
'group hierarchy',
|
|
1030
|
-
'user roles',
|
|
1031
|
-
],
|
|
1032
|
-
relatedEndpoints: [
|
|
1033
|
-
'api.joomla.users.groups.list',
|
|
1034
|
-
'api.joomla.users.list',
|
|
1035
|
-
'api.joomla.users.groups.createMapping',
|
|
1036
|
-
],
|
|
1037
|
-
commonPatterns: [
|
|
1038
|
-
'list user groups',
|
|
1039
|
-
'get groups',
|
|
1040
|
-
'group permissions',
|
|
1041
|
-
'user roles',
|
|
1042
|
-
'group hierarchy',
|
|
1043
|
-
],
|
|
1044
|
-
dataMethod: 'listData(params)',
|
|
1045
|
-
discoverable: true,
|
|
1046
|
-
},
|
|
1047
|
-
],
|
|
1048
|
-
};
|
|
1049
|
-
}
|
|
1050
702
|
}
|
|
1051
703
|
exports.JoomlaClient = JoomlaClient;
|
|
1052
704
|
//# sourceMappingURL=client.js.map
|