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