@salesforce/b2c-tooling-sdk 0.0.1 → 0.0.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/README.md +158 -29
- package/data/script-api/TopLevel.APIException.md +119 -0
- package/data/script-api/TopLevel.Array.md +732 -0
- package/data/script-api/TopLevel.ArrayBuffer.md +97 -0
- package/data/script-api/TopLevel.BigInt.md +154 -0
- package/data/script-api/TopLevel.Boolean.md +83 -0
- package/data/script-api/TopLevel.ConversionError.md +51 -0
- package/data/script-api/TopLevel.DataView.md +271 -0
- package/data/script-api/TopLevel.Date.md +688 -0
- package/data/script-api/TopLevel.ES6Iterator.md +47 -0
- package/data/script-api/TopLevel.Error.md +124 -0
- package/data/script-api/TopLevel.EvalError.md +47 -0
- package/data/script-api/TopLevel.Fault.md +133 -0
- package/data/script-api/TopLevel.Float32Array.md +186 -0
- package/data/script-api/TopLevel.Float64Array.md +186 -0
- package/data/script-api/TopLevel.Function.md +114 -0
- package/data/script-api/TopLevel.Generator.md +132 -0
- package/data/script-api/TopLevel.IOError.md +98 -0
- package/data/script-api/TopLevel.Int16Array.md +186 -0
- package/data/script-api/TopLevel.Int32Array.md +186 -0
- package/data/script-api/TopLevel.Int8Array.md +186 -0
- package/data/script-api/TopLevel.InternalError.md +47 -0
- package/data/script-api/TopLevel.Iterable.md +44 -0
- package/data/script-api/TopLevel.Iterator.md +89 -0
- package/data/script-api/TopLevel.JSON.md +173 -0
- package/data/script-api/TopLevel.Map.md +189 -0
- package/data/script-api/TopLevel.Math.md +948 -0
- package/data/script-api/TopLevel.Module.md +152 -0
- package/data/script-api/TopLevel.Namespace.md +152 -0
- package/data/script-api/TopLevel.Number.md +404 -0
- package/data/script-api/TopLevel.Object.md +472 -0
- package/data/script-api/TopLevel.QName.md +147 -0
- package/data/script-api/TopLevel.RangeError.md +47 -0
- package/data/script-api/TopLevel.ReferenceError.md +47 -0
- package/data/script-api/TopLevel.RegExp.md +155 -0
- package/data/script-api/TopLevel.Set.md +150 -0
- package/data/script-api/TopLevel.StopIteration.md +36 -0
- package/data/script-api/TopLevel.String.md +1060 -0
- package/data/script-api/TopLevel.Symbol.md +196 -0
- package/data/script-api/TopLevel.SyntaxError.md +47 -0
- package/data/script-api/TopLevel.SystemError.md +99 -0
- package/data/script-api/TopLevel.TypeError.md +47 -0
- package/data/script-api/TopLevel.URIError.md +47 -0
- package/data/script-api/TopLevel.Uint16Array.md +186 -0
- package/data/script-api/TopLevel.Uint32Array.md +186 -0
- package/data/script-api/TopLevel.Uint8Array.md +186 -0
- package/data/script-api/TopLevel.Uint8ClampedArray.md +186 -0
- package/data/script-api/TopLevel.WeakMap.md +135 -0
- package/data/script-api/TopLevel.WeakSet.md +96 -0
- package/data/script-api/TopLevel.XML.md +922 -0
- package/data/script-api/TopLevel.XMLList.md +418 -0
- package/data/script-api/TopLevel.XMLStreamError.md +115 -0
- package/data/script-api/TopLevel.arguments.md +56 -0
- package/data/script-api/TopLevel.global.md +539 -0
- package/data/script-api/TopLevel.md +58 -0
- package/data/script-api/dw.alert.Alert.md +175 -0
- package/data/script-api/dw.alert.Alerts.md +256 -0
- package/data/script-api/dw.alert.md +7 -0
- package/data/script-api/dw.campaign.ABTest.md +63 -0
- package/data/script-api/dw.campaign.ABTestMgr.md +76 -0
- package/data/script-api/dw.campaign.ABTestSegment.md +107 -0
- package/data/script-api/dw.campaign.AmountDiscount.md +70 -0
- package/data/script-api/dw.campaign.ApproachingDiscount.md +157 -0
- package/data/script-api/dw.campaign.BonusChoiceDiscount.md +190 -0
- package/data/script-api/dw.campaign.BonusDiscount.md +59 -0
- package/data/script-api/dw.campaign.Campaign.md +346 -0
- package/data/script-api/dw.campaign.CampaignMgr.md +436 -0
- package/data/script-api/dw.campaign.CampaignStatusCodes.md +103 -0
- package/data/script-api/dw.campaign.Coupon.md +324 -0
- package/data/script-api/dw.campaign.CouponMgr.md +137 -0
- package/data/script-api/dw.campaign.CouponRedemption.md +87 -0
- package/data/script-api/dw.campaign.CouponStatusCodes.md +130 -0
- package/data/script-api/dw.campaign.Discount.md +271 -0
- package/data/script-api/dw.campaign.DiscountPlan.md +322 -0
- package/data/script-api/dw.campaign.FixedPriceDiscount.md +74 -0
- package/data/script-api/dw.campaign.FixedPriceShippingDiscount.md +74 -0
- package/data/script-api/dw.campaign.FreeDiscount.md +24 -0
- package/data/script-api/dw.campaign.FreeShippingDiscount.md +24 -0
- package/data/script-api/dw.campaign.PercentageDiscount.md +74 -0
- package/data/script-api/dw.campaign.PercentageOptionDiscount.md +59 -0
- package/data/script-api/dw.campaign.PriceBookPriceDiscount.md +56 -0
- package/data/script-api/dw.campaign.Promotion.md +939 -0
- package/data/script-api/dw.campaign.PromotionMgr.md +478 -0
- package/data/script-api/dw.campaign.PromotionPlan.md +378 -0
- package/data/script-api/dw.campaign.SlotContent.md +131 -0
- package/data/script-api/dw.campaign.SourceCodeGroup.md +83 -0
- package/data/script-api/dw.campaign.SourceCodeInfo.md +167 -0
- package/data/script-api/dw.campaign.SourceCodeStatusCodes.md +61 -0
- package/data/script-api/dw.campaign.TotalFixedPriceDiscount.md +56 -0
- package/data/script-api/dw.campaign.md +36 -0
- package/data/script-api/dw.catalog.Catalog.md +158 -0
- package/data/script-api/dw.catalog.CatalogMgr.md +155 -0
- package/data/script-api/dw.catalog.Category.md +1212 -0
- package/data/script-api/dw.catalog.CategoryAssignment.md +179 -0
- package/data/script-api/dw.catalog.CategoryLink.md +142 -0
- package/data/script-api/dw.catalog.PriceBook.md +215 -0
- package/data/script-api/dw.catalog.PriceBookMgr.md +176 -0
- package/data/script-api/dw.catalog.Product.md +2492 -0
- package/data/script-api/dw.catalog.ProductActiveData.md +1244 -0
- package/data/script-api/dw.catalog.ProductAttributeModel.md +409 -0
- package/data/script-api/dw.catalog.ProductAvailabilityLevels.md +125 -0
- package/data/script-api/dw.catalog.ProductAvailabilityModel.md +516 -0
- package/data/script-api/dw.catalog.ProductInventoryList.md +136 -0
- package/data/script-api/dw.catalog.ProductInventoryMgr.md +132 -0
- package/data/script-api/dw.catalog.ProductInventoryRecord.md +638 -0
- package/data/script-api/dw.catalog.ProductLink.md +166 -0
- package/data/script-api/dw.catalog.ProductMgr.md +136 -0
- package/data/script-api/dw.catalog.ProductOption.md +189 -0
- package/data/script-api/dw.catalog.ProductOptionModel.md +209 -0
- package/data/script-api/dw.catalog.ProductOptionValue.md +132 -0
- package/data/script-api/dw.catalog.ProductPriceInfo.md +170 -0
- package/data/script-api/dw.catalog.ProductPriceModel.md +988 -0
- package/data/script-api/dw.catalog.ProductPriceTable.md +121 -0
- package/data/script-api/dw.catalog.ProductSearchHit.md +702 -0
- package/data/script-api/dw.catalog.ProductSearchModel.md +1894 -0
- package/data/script-api/dw.catalog.ProductSearchRefinementDefinition.md +99 -0
- package/data/script-api/dw.catalog.ProductSearchRefinementValue.md +80 -0
- package/data/script-api/dw.catalog.ProductSearchRefinements.md +265 -0
- package/data/script-api/dw.catalog.ProductVariationAttribute.md +107 -0
- package/data/script-api/dw.catalog.ProductVariationAttributeValue.md +215 -0
- package/data/script-api/dw.catalog.ProductVariationModel.md +1010 -0
- package/data/script-api/dw.catalog.Recommendation.md +327 -0
- package/data/script-api/dw.catalog.SearchModel.md +769 -0
- package/data/script-api/dw.catalog.SearchRefinementDefinition.md +145 -0
- package/data/script-api/dw.catalog.SearchRefinementValue.md +194 -0
- package/data/script-api/dw.catalog.SearchRefinements.md +238 -0
- package/data/script-api/dw.catalog.SortingOption.md +120 -0
- package/data/script-api/dw.catalog.SortingRule.md +53 -0
- package/data/script-api/dw.catalog.Store.md +484 -0
- package/data/script-api/dw.catalog.StoreGroup.md +95 -0
- package/data/script-api/dw.catalog.StoreInventoryFilter.md +112 -0
- package/data/script-api/dw.catalog.StoreInventoryFilterValue.md +111 -0
- package/data/script-api/dw.catalog.StoreMgr.md +223 -0
- package/data/script-api/dw.catalog.Variant.md +1000 -0
- package/data/script-api/dw.catalog.VariationGroup.md +869 -0
- package/data/script-api/dw.catalog.md +50 -0
- package/data/script-api/dw.content.Content.md +481 -0
- package/data/script-api/dw.content.ContentMgr.md +147 -0
- package/data/script-api/dw.content.ContentSearchModel.md +618 -0
- package/data/script-api/dw.content.ContentSearchRefinementDefinition.md +61 -0
- package/data/script-api/dw.content.ContentSearchRefinementValue.md +22 -0
- package/data/script-api/dw.content.ContentSearchRefinements.md +218 -0
- package/data/script-api/dw.content.Folder.md +432 -0
- package/data/script-api/dw.content.Library.md +124 -0
- package/data/script-api/dw.content.MarkupText.md +150 -0
- package/data/script-api/dw.content.MediaFile.md +367 -0
- package/data/script-api/dw.content.md +15 -0
- package/data/script-api/dw.crypto.CertificateRef.md +59 -0
- package/data/script-api/dw.crypto.CertificateUtils.md +162 -0
- package/data/script-api/dw.crypto.Cipher.md +1230 -0
- package/data/script-api/dw.crypto.Encoding.md +193 -0
- package/data/script-api/dw.crypto.JWE.md +245 -0
- package/data/script-api/dw.crypto.JWEHeader.md +147 -0
- package/data/script-api/dw.crypto.JWS.md +260 -0
- package/data/script-api/dw.crypto.JWSHeader.md +128 -0
- package/data/script-api/dw.crypto.KeyRef.md +77 -0
- package/data/script-api/dw.crypto.Mac.md +191 -0
- package/data/script-api/dw.crypto.MessageDigest.md +243 -0
- package/data/script-api/dw.crypto.SecureRandom.md +161 -0
- package/data/script-api/dw.crypto.Signature.md +241 -0
- package/data/script-api/dw.crypto.WeakCipher.md +725 -0
- package/data/script-api/dw.crypto.WeakMac.md +163 -0
- package/data/script-api/dw.crypto.WeakMessageDigest.md +220 -0
- package/data/script-api/dw.crypto.WeakSignature.md +208 -0
- package/data/script-api/dw.crypto.X509Certificate.md +180 -0
- package/data/script-api/dw.crypto.md +23 -0
- package/data/script-api/dw.customer.AddressBook.md +158 -0
- package/data/script-api/dw.customer.AgentUserMgr.md +94 -0
- package/data/script-api/dw.customer.AgentUserStatusCodes.md +164 -0
- package/data/script-api/dw.customer.AuthenticationStatus.md +157 -0
- package/data/script-api/dw.customer.Credentials.md +524 -0
- package/data/script-api/dw.customer.Customer.md +488 -0
- package/data/script-api/dw.customer.CustomerActiveData.md +563 -0
- package/data/script-api/dw.customer.CustomerAddress.md +666 -0
- package/data/script-api/dw.customer.CustomerCDPData.md +70 -0
- package/data/script-api/dw.customer.CustomerContextMgr.md +62 -0
- package/data/script-api/dw.customer.CustomerGroup.md +146 -0
- package/data/script-api/dw.customer.CustomerList.md +76 -0
- package/data/script-api/dw.customer.CustomerMgr.md +1046 -0
- package/data/script-api/dw.customer.CustomerPasswordConstraints.md +125 -0
- package/data/script-api/dw.customer.CustomerPaymentInstrument.md +161 -0
- package/data/script-api/dw.customer.CustomerStatusCodes.md +55 -0
- package/data/script-api/dw.customer.EncryptedObject.md +34 -0
- package/data/script-api/dw.customer.ExternalProfile.md +154 -0
- package/data/script-api/dw.customer.OrderHistory.md +167 -0
- package/data/script-api/dw.customer.ProductList.md +870 -0
- package/data/script-api/dw.customer.ProductListItem.md +469 -0
- package/data/script-api/dw.customer.ProductListItemPurchase.md +139 -0
- package/data/script-api/dw.customer.ProductListMgr.md +350 -0
- package/data/script-api/dw.customer.ProductListRegistrant.md +165 -0
- package/data/script-api/dw.customer.Profile.md +895 -0
- package/data/script-api/dw.customer.Wallet.md +136 -0
- package/data/script-api/dw.customer.md +31 -0
- package/data/script-api/dw.customer.oauth.OAuthAccessTokenResponse.md +171 -0
- package/data/script-api/dw.customer.oauth.OAuthFinalizedResponse.md +75 -0
- package/data/script-api/dw.customer.oauth.OAuthLoginFlowMgr.md +165 -0
- package/data/script-api/dw.customer.oauth.OAuthUserInfoResponse.md +84 -0
- package/data/script-api/dw.customer.oauth.md +9 -0
- package/data/script-api/dw.customer.shoppercontext.ShopperContext.md +369 -0
- package/data/script-api/dw.customer.shoppercontext.ShopperContextErrorCodes.md +111 -0
- package/data/script-api/dw.customer.shoppercontext.ShopperContextException.md +77 -0
- package/data/script-api/dw.customer.shoppercontext.ShopperContextMgr.md +209 -0
- package/data/script-api/dw.customer.shoppercontext.md +9 -0
- package/data/script-api/dw.experience.AspectAttributeValidationException.md +25 -0
- package/data/script-api/dw.experience.Component.md +166 -0
- package/data/script-api/dw.experience.ComponentRenderSettings.md +130 -0
- package/data/script-api/dw.experience.ComponentScriptContext.md +148 -0
- package/data/script-api/dw.experience.CustomEditor.md +146 -0
- package/data/script-api/dw.experience.CustomEditorResources.md +100 -0
- package/data/script-api/dw.experience.Page.md +467 -0
- package/data/script-api/dw.experience.PageMgr.md +549 -0
- package/data/script-api/dw.experience.PageScriptContext.md +200 -0
- package/data/script-api/dw.experience.Region.md +119 -0
- package/data/script-api/dw.experience.RegionRenderSettings.md +207 -0
- package/data/script-api/dw.experience.cms.CMSRecord.md +125 -0
- package/data/script-api/dw.experience.cms.md +6 -0
- package/data/script-api/dw.experience.image.FocalPoint.md +71 -0
- package/data/script-api/dw.experience.image.Image.md +101 -0
- package/data/script-api/dw.experience.image.ImageMetaData.md +71 -0
- package/data/script-api/dw.experience.image.md +8 -0
- package/data/script-api/dw.experience.md +16 -0
- package/data/script-api/dw.extensions.applepay.ApplePayHookResult.md +254 -0
- package/data/script-api/dw.extensions.applepay.ApplePayHooks.md +572 -0
- package/data/script-api/dw.extensions.applepay.md +7 -0
- package/data/script-api/dw.extensions.facebook.FacebookFeedHooks.md +102 -0
- package/data/script-api/dw.extensions.facebook.FacebookProduct.md +1343 -0
- package/data/script-api/dw.extensions.facebook.md +7 -0
- package/data/script-api/dw.extensions.paymentapi.PaymentApiHooks.md +136 -0
- package/data/script-api/dw.extensions.paymentapi.md +6 -0
- package/data/script-api/dw.extensions.paymentrequest.PaymentRequestHookResult.md +149 -0
- package/data/script-api/dw.extensions.paymentrequest.PaymentRequestHooks.md +356 -0
- package/data/script-api/dw.extensions.paymentrequest.md +7 -0
- package/data/script-api/dw.extensions.payments.SalesforceAdyenPaymentIntent.md +134 -0
- package/data/script-api/dw.extensions.payments.SalesforceAdyenSavedPaymentMethod.md +283 -0
- package/data/script-api/dw.extensions.payments.SalesforceBancontactPaymentDetails.md +88 -0
- package/data/script-api/dw.extensions.payments.SalesforceCardPaymentDetails.md +107 -0
- package/data/script-api/dw.extensions.payments.SalesforceEpsPaymentDetails.md +63 -0
- package/data/script-api/dw.extensions.payments.SalesforceIdealPaymentDetails.md +63 -0
- package/data/script-api/dw.extensions.payments.SalesforceKlarnaPaymentDetails.md +63 -0
- package/data/script-api/dw.extensions.payments.SalesforcePayPalOrder.md +263 -0
- package/data/script-api/dw.extensions.payments.SalesforcePayPalOrderAddress.md +171 -0
- package/data/script-api/dw.extensions.payments.SalesforcePayPalOrderPayer.md +110 -0
- package/data/script-api/dw.extensions.payments.SalesforcePayPalPaymentDetails.md +88 -0
- package/data/script-api/dw.extensions.payments.SalesforcePaymentDetails.md +83 -0
- package/data/script-api/dw.extensions.payments.SalesforcePaymentIntent.md +273 -0
- package/data/script-api/dw.extensions.payments.SalesforcePaymentMethod.md +368 -0
- package/data/script-api/dw.extensions.payments.SalesforcePaymentRequest.md +1077 -0
- package/data/script-api/dw.extensions.payments.SalesforcePaymentsHooks.md +166 -0
- package/data/script-api/dw.extensions.payments.SalesforcePaymentsMerchantAccount.md +151 -0
- package/data/script-api/dw.extensions.payments.SalesforcePaymentsMerchantAccountPaymentMethod.md +98 -0
- package/data/script-api/dw.extensions.payments.SalesforcePaymentsMgr.md +941 -0
- package/data/script-api/dw.extensions.payments.SalesforcePaymentsSiteConfiguration.md +126 -0
- package/data/script-api/dw.extensions.payments.SalesforcePaymentsZone.md +393 -0
- package/data/script-api/dw.extensions.payments.SalesforceSepaDebitPaymentDetails.md +63 -0
- package/data/script-api/dw.extensions.payments.SalesforceVenmoPaymentDetails.md +88 -0
- package/data/script-api/dw.extensions.payments.md +28 -0
- package/data/script-api/dw.extensions.pinterest.PinterestAvailability.md +85 -0
- package/data/script-api/dw.extensions.pinterest.PinterestFeedHooks.md +118 -0
- package/data/script-api/dw.extensions.pinterest.PinterestOrder.md +263 -0
- package/data/script-api/dw.extensions.pinterest.PinterestOrderHooks.md +89 -0
- package/data/script-api/dw.extensions.pinterest.PinterestProduct.md +677 -0
- package/data/script-api/dw.extensions.pinterest.md +10 -0
- package/data/script-api/dw.io.CSVStreamReader.md +128 -0
- package/data/script-api/dw.io.CSVStreamWriter.md +92 -0
- package/data/script-api/dw.io.File.md +729 -0
- package/data/script-api/dw.io.FileReader.md +70 -0
- package/data/script-api/dw.io.FileWriter.md +159 -0
- package/data/script-api/dw.io.InputStream.md +35 -0
- package/data/script-api/dw.io.OutputStream.md +38 -0
- package/data/script-api/dw.io.PrintWriter.md +66 -0
- package/data/script-api/dw.io.RandomAccessFileReader.md +183 -0
- package/data/script-api/dw.io.Reader.md +284 -0
- package/data/script-api/dw.io.StringWriter.md +89 -0
- package/data/script-api/dw.io.Writer.md +96 -0
- package/data/script-api/dw.io.XMLIndentingStreamWriter.md +121 -0
- package/data/script-api/dw.io.XMLStreamConstants.md +172 -0
- package/data/script-api/dw.io.XMLStreamReader.md +1181 -0
- package/data/script-api/dw.io.XMLStreamWriter.md +478 -0
- package/data/script-api/dw.io.md +21 -0
- package/data/script-api/dw.job.JobExecution.md +111 -0
- package/data/script-api/dw.job.JobStepExecution.md +136 -0
- package/data/script-api/dw.job.md +7 -0
- package/data/script-api/dw.net.FTPClient.md +621 -0
- package/data/script-api/dw.net.FTPFileInfo.md +132 -0
- package/data/script-api/dw.net.HTTPClient.md +775 -0
- package/data/script-api/dw.net.HTTPClientLoggingConfig.md +363 -0
- package/data/script-api/dw.net.HTTPRequestPart.md +296 -0
- package/data/script-api/dw.net.Mail.md +487 -0
- package/data/script-api/dw.net.SFTPClient.md +535 -0
- package/data/script-api/dw.net.SFTPFileInfo.md +128 -0
- package/data/script-api/dw.net.WebDAVClient.md +762 -0
- package/data/script-api/dw.net.WebDAVFileInfo.md +163 -0
- package/data/script-api/dw.net.md +15 -0
- package/data/script-api/dw.object.ActiveData.md +86 -0
- package/data/script-api/dw.object.CustomAttributes.md +122 -0
- package/data/script-api/dw.object.CustomObject.md +82 -0
- package/data/script-api/dw.object.CustomObjectMgr.md +478 -0
- package/data/script-api/dw.object.Extensible.md +71 -0
- package/data/script-api/dw.object.ExtensibleObject.md +85 -0
- package/data/script-api/dw.object.Note.md +118 -0
- package/data/script-api/dw.object.ObjectAttributeDefinition.md +542 -0
- package/data/script-api/dw.object.ObjectAttributeGroup.md +160 -0
- package/data/script-api/dw.object.ObjectAttributeValueDefinition.md +78 -0
- package/data/script-api/dw.object.ObjectTypeDefinition.md +239 -0
- package/data/script-api/dw.object.PersistentObject.md +92 -0
- package/data/script-api/dw.object.SimpleExtensible.md +53 -0
- package/data/script-api/dw.object.SystemObjectMgr.md +520 -0
- package/data/script-api/dw.object.md +19 -0
- package/data/script-api/dw.order.AbstractItem.md +220 -0
- package/data/script-api/dw.order.AbstractItemCtnr.md +219 -0
- package/data/script-api/dw.order.Appeasement.md +398 -0
- package/data/script-api/dw.order.AppeasementItem.md +104 -0
- package/data/script-api/dw.order.Basket.md +867 -0
- package/data/script-api/dw.order.BasketMgr.md +673 -0
- package/data/script-api/dw.order.BonusDiscountLineItem.md +309 -0
- package/data/script-api/dw.order.CouponLineItem.md +289 -0
- package/data/script-api/dw.order.CreateAgentBasketLimitExceededException.md +35 -0
- package/data/script-api/dw.order.CreateBasketFromOrderException.md +54 -0
- package/data/script-api/dw.order.CreateCouponLineItemException.md +67 -0
- package/data/script-api/dw.order.CreateOrderException.md +23 -0
- package/data/script-api/dw.order.CreateTemporaryBasketLimitExceededException.md +35 -0
- package/data/script-api/dw.order.GiftCertificate.md +530 -0
- package/data/script-api/dw.order.GiftCertificateLineItem.md +292 -0
- package/data/script-api/dw.order.GiftCertificateMgr.md +228 -0
- package/data/script-api/dw.order.GiftCertificateStatusCodes.md +108 -0
- package/data/script-api/dw.order.Invoice.md +571 -0
- package/data/script-api/dw.order.InvoiceItem.md +199 -0
- package/data/script-api/dw.order.LineItem.md +489 -0
- package/data/script-api/dw.order.LineItemCtnr.md +2399 -0
- package/data/script-api/dw.order.Order.md +2770 -0
- package/data/script-api/dw.order.OrderAddress.md +624 -0
- package/data/script-api/dw.order.OrderItem.md +613 -0
- package/data/script-api/dw.order.OrderMgr.md +1494 -0
- package/data/script-api/dw.order.OrderPaymentInstrument.md +231 -0
- package/data/script-api/dw.order.OrderProcessStatusCodes.md +146 -0
- package/data/script-api/dw.order.PaymentCard.md +220 -0
- package/data/script-api/dw.order.PaymentInstrument.md +1416 -0
- package/data/script-api/dw.order.PaymentMethod.md +257 -0
- package/data/script-api/dw.order.PaymentMgr.md +138 -0
- package/data/script-api/dw.order.PaymentProcessor.md +106 -0
- package/data/script-api/dw.order.PaymentStatusCodes.md +70 -0
- package/data/script-api/dw.order.PaymentTransaction.md +291 -0
- package/data/script-api/dw.order.PriceAdjustment.md +745 -0
- package/data/script-api/dw.order.PriceAdjustmentLimitTypes.md +61 -0
- package/data/script-api/dw.order.ProductLineItem.md +1749 -0
- package/data/script-api/dw.order.ProductShippingCost.md +101 -0
- package/data/script-api/dw.order.ProductShippingLineItem.md +336 -0
- package/data/script-api/dw.order.ProductShippingModel.md +143 -0
- package/data/script-api/dw.order.Return.md +396 -0
- package/data/script-api/dw.order.ReturnCase.md +463 -0
- package/data/script-api/dw.order.ReturnCaseItem.md +372 -0
- package/data/script-api/dw.order.ReturnItem.md +335 -0
- package/data/script-api/dw.order.Shipment.md +1124 -0
- package/data/script-api/dw.order.ShipmentShippingCost.md +54 -0
- package/data/script-api/dw.order.ShipmentShippingModel.md +203 -0
- package/data/script-api/dw.order.ShippingLineItem.md +315 -0
- package/data/script-api/dw.order.ShippingLocation.md +313 -0
- package/data/script-api/dw.order.ShippingMethod.md +251 -0
- package/data/script-api/dw.order.ShippingMgr.md +173 -0
- package/data/script-api/dw.order.ShippingOrder.md +630 -0
- package/data/script-api/dw.order.ShippingOrderItem.md +425 -0
- package/data/script-api/dw.order.SumItem.md +158 -0
- package/data/script-api/dw.order.TaxGroup.md +128 -0
- package/data/script-api/dw.order.TaxItem.md +74 -0
- package/data/script-api/dw.order.TaxMgr.md +260 -0
- package/data/script-api/dw.order.TrackingInfo.md +261 -0
- package/data/script-api/dw.order.TrackingRef.md +108 -0
- package/data/script-api/dw.order.hooks.BasketMergeHooks.md +87 -0
- package/data/script-api/dw.order.hooks.CalculateHooks.md +139 -0
- package/data/script-api/dw.order.hooks.CheckoutHooks.md +88 -0
- package/data/script-api/dw.order.hooks.OrderHooks.md +96 -0
- package/data/script-api/dw.order.hooks.PaymentHooks.md +325 -0
- package/data/script-api/dw.order.hooks.ReturnHooks.md +395 -0
- package/data/script-api/dw.order.hooks.ShippingOrderHooks.md +426 -0
- package/data/script-api/dw.order.hooks.md +12 -0
- package/data/script-api/dw.order.md +64 -0
- package/data/script-api/dw.rpc.SOAPUtil.md +736 -0
- package/data/script-api/dw.rpc.Stub.md +373 -0
- package/data/script-api/dw.rpc.WebReference.md +133 -0
- package/data/script-api/dw.rpc.md +8 -0
- package/data/script-api/dw.sitemap.SitemapFile.md +137 -0
- package/data/script-api/dw.sitemap.SitemapMgr.md +142 -0
- package/data/script-api/dw.sitemap.md +7 -0
- package/data/script-api/dw.suggest.BrandSuggestions.md +34 -0
- package/data/script-api/dw.suggest.CategorySuggestions.md +76 -0
- package/data/script-api/dw.suggest.ContentSuggestions.md +76 -0
- package/data/script-api/dw.suggest.CustomSuggestions.md +34 -0
- package/data/script-api/dw.suggest.ProductSuggestions.md +76 -0
- package/data/script-api/dw.suggest.SearchPhraseSuggestions.md +126 -0
- package/data/script-api/dw.suggest.SuggestModel.md +471 -0
- package/data/script-api/dw.suggest.SuggestedCategory.md +51 -0
- package/data/script-api/dw.suggest.SuggestedContent.md +51 -0
- package/data/script-api/dw.suggest.SuggestedPhrase.md +70 -0
- package/data/script-api/dw.suggest.SuggestedProduct.md +55 -0
- package/data/script-api/dw.suggest.SuggestedTerm.md +143 -0
- package/data/script-api/dw.suggest.SuggestedTerms.md +144 -0
- package/data/script-api/dw.suggest.Suggestions.md +206 -0
- package/data/script-api/dw.suggest.md +19 -0
- package/data/script-api/dw.svc.FTPService.md +140 -0
- package/data/script-api/dw.svc.FTPServiceDefinition.md +97 -0
- package/data/script-api/dw.svc.HTTPFormService.md +32 -0
- package/data/script-api/dw.svc.HTTPFormServiceDefinition.md +36 -0
- package/data/script-api/dw.svc.HTTPService.md +370 -0
- package/data/script-api/dw.svc.HTTPServiceDefinition.md +290 -0
- package/data/script-api/dw.svc.LocalServiceRegistry.md +63 -0
- package/data/script-api/dw.svc.Result.md +320 -0
- package/data/script-api/dw.svc.SOAPService.md +104 -0
- package/data/script-api/dw.svc.SOAPServiceDefinition.md +32 -0
- package/data/script-api/dw.svc.Service.md +276 -0
- package/data/script-api/dw.svc.ServiceCallback.md +282 -0
- package/data/script-api/dw.svc.ServiceConfig.md +114 -0
- package/data/script-api/dw.svc.ServiceCredential.md +162 -0
- package/data/script-api/dw.svc.ServiceDefinition.md +211 -0
- package/data/script-api/dw.svc.ServiceProfile.md +152 -0
- package/data/script-api/dw.svc.ServiceRegistry.md +118 -0
- package/data/script-api/dw.svc.md +22 -0
- package/data/script-api/dw.system.AgentUserStatusCodes.md +41 -0
- package/data/script-api/dw.system.Cache.md +126 -0
- package/data/script-api/dw.system.CacheMgr.md +70 -0
- package/data/script-api/dw.system.HookMgr.md +78 -0
- package/data/script-api/dw.system.InternalObject.md +47 -0
- package/data/script-api/dw.system.JobProcessMonitor.md +103 -0
- package/data/script-api/dw.system.Log.md +198 -0
- package/data/script-api/dw.system.LogNDC.md +75 -0
- package/data/script-api/dw.system.Logger.md +216 -0
- package/data/script-api/dw.system.OrganizationPreferences.md +53 -0
- package/data/script-api/dw.system.Pipeline.md +94 -0
- package/data/script-api/dw.system.PipelineDictionary.md +42 -0
- package/data/script-api/dw.system.RESTErrorResponse.md +102 -0
- package/data/script-api/dw.system.RESTResponseMgr.md +243 -0
- package/data/script-api/dw.system.RESTSuccessResponse.md +62 -0
- package/data/script-api/dw.system.RemoteInclude.md +146 -0
- package/data/script-api/dw.system.Request.md +781 -0
- package/data/script-api/dw.system.RequestHooks.md +112 -0
- package/data/script-api/dw.system.Response.md +612 -0
- package/data/script-api/dw.system.SearchStatus.md +187 -0
- package/data/script-api/dw.system.Session.md +469 -0
- package/data/script-api/dw.system.Site.md +570 -0
- package/data/script-api/dw.system.SitePreferences.md +90 -0
- package/data/script-api/dw.system.Status.md +330 -0
- package/data/script-api/dw.system.StatusItem.md +273 -0
- package/data/script-api/dw.system.System.md +224 -0
- package/data/script-api/dw.system.Transaction.md +107 -0
- package/data/script-api/dw.system.md +32 -0
- package/data/script-api/dw.template.ISML.md +127 -0
- package/data/script-api/dw.template.Velocity.md +168 -0
- package/data/script-api/dw.template.md +7 -0
- package/data/script-api/dw.util.ArrayList.md +99 -0
- package/data/script-api/dw.util.Assert.md +341 -0
- package/data/script-api/dw.util.BigInteger.md +283 -0
- package/data/script-api/dw.util.Bytes.md +278 -0
- package/data/script-api/dw.util.Calendar.md +1051 -0
- package/data/script-api/dw.util.Collection.md +272 -0
- package/data/script-api/dw.util.Currency.md +147 -0
- package/data/script-api/dw.util.DateUtils.md +82 -0
- package/data/script-api/dw.util.Decimal.md +386 -0
- package/data/script-api/dw.util.FilteringCollection.md +140 -0
- package/data/script-api/dw.util.Geolocation.md +293 -0
- package/data/script-api/dw.util.HashMap.md +50 -0
- package/data/script-api/dw.util.HashSet.md +65 -0
- package/data/script-api/dw.util.Iterator.md +86 -0
- package/data/script-api/dw.util.LinkedHashMap.md +52 -0
- package/data/script-api/dw.util.LinkedHashSet.md +68 -0
- package/data/script-api/dw.util.List.md +429 -0
- package/data/script-api/dw.util.Locale.md +274 -0
- package/data/script-api/dw.util.Map.md +251 -0
- package/data/script-api/dw.util.MapEntry.md +68 -0
- package/data/script-api/dw.util.MappingKey.md +96 -0
- package/data/script-api/dw.util.MappingMgr.md +113 -0
- package/data/script-api/dw.util.PropertyComparator.md +122 -0
- package/data/script-api/dw.util.SecureEncoder.md +582 -0
- package/data/script-api/dw.util.SecureFilter.md +572 -0
- package/data/script-api/dw.util.SeekableIterator.md +187 -0
- package/data/script-api/dw.util.Set.md +39 -0
- package/data/script-api/dw.util.SortedMap.md +148 -0
- package/data/script-api/dw.util.SortedSet.md +173 -0
- package/data/script-api/dw.util.StringUtils.md +655 -0
- package/data/script-api/dw.util.Template.md +141 -0
- package/data/script-api/dw.util.UUIDUtils.md +34 -0
- package/data/script-api/dw.util.md +37 -0
- package/data/script-api/dw.value.EnumValue.md +105 -0
- package/data/script-api/dw.value.MimeEncodedText.md +131 -0
- package/data/script-api/dw.value.Money.md +526 -0
- package/data/script-api/dw.value.Quantity.md +299 -0
- package/data/script-api/dw.value.md +9 -0
- package/data/script-api/dw.web.CSRFProtection.md +105 -0
- package/data/script-api/dw.web.ClickStream.md +177 -0
- package/data/script-api/dw.web.ClickStreamEntry.md +255 -0
- package/data/script-api/dw.web.Cookie.md +360 -0
- package/data/script-api/dw.web.Cookies.md +59 -0
- package/data/script-api/dw.web.Form.md +84 -0
- package/data/script-api/dw.web.FormAction.md +195 -0
- package/data/script-api/dw.web.FormElement.md +211 -0
- package/data/script-api/dw.web.FormElementValidationResult.md +170 -0
- package/data/script-api/dw.web.FormField.md +642 -0
- package/data/script-api/dw.web.FormFieldOption.md +211 -0
- package/data/script-api/dw.web.FormFieldOptions.md +49 -0
- package/data/script-api/dw.web.FormGroup.md +222 -0
- package/data/script-api/dw.web.FormList.md +134 -0
- package/data/script-api/dw.web.FormListItem.md +57 -0
- package/data/script-api/dw.web.Forms.md +25 -0
- package/data/script-api/dw.web.HttpParameter.md +462 -0
- package/data/script-api/dw.web.HttpParameterMap.md +194 -0
- package/data/script-api/dw.web.LoopIterator.md +231 -0
- package/data/script-api/dw.web.PageMetaData.md +197 -0
- package/data/script-api/dw.web.PageMetaTag.md +149 -0
- package/data/script-api/dw.web.PagingModel.md +407 -0
- package/data/script-api/dw.web.Resource.md +147 -0
- package/data/script-api/dw.web.URL.md +174 -0
- package/data/script-api/dw.web.URLAction.md +95 -0
- package/data/script-api/dw.web.URLParameter.md +52 -0
- package/data/script-api/dw.web.URLRedirect.md +72 -0
- package/data/script-api/dw.web.URLRedirectMgr.md +86 -0
- package/data/script-api/dw.web.URLUtils.md +1357 -0
- package/data/script-api/dw.web.md +34 -0
- package/data/script-api/dw.ws.Port.md +126 -0
- package/data/script-api/dw.ws.WSUtil.md +728 -0
- package/data/script-api/dw.ws.WebReference2.md +137 -0
- package/data/script-api/dw.ws.md +8 -0
- package/data/script-api/index.json +3085 -0
- package/data/script-api/index.md +39 -0
- package/data/xsd/abtest.xsd +347 -0
- package/data/xsd/abtestparticipants.xsd +58 -0
- package/data/xsd/assignment.xsd +158 -0
- package/data/xsd/bmext.xsd +262 -0
- package/data/xsd/cachesettings.xsd +75 -0
- package/data/xsd/catalog.xsd +1363 -0
- package/data/xsd/coupon.xsd +206 -0
- package/data/xsd/couponredemption.xsd +58 -0
- package/data/xsd/csrfwhitelists.xsd +81 -0
- package/data/xsd/customer.xsd +411 -0
- package/data/xsd/customeractivedata.xsd +75 -0
- package/data/xsd/customercdnsettings.xsd +36 -0
- package/data/xsd/customergroup.xsd +276 -0
- package/data/xsd/customerlist.xsd +72 -0
- package/data/xsd/customerlist2.xsd +52 -0
- package/data/xsd/customerpaymentinstrument.xsd +189 -0
- package/data/xsd/customobject.xsd +68 -0
- package/data/xsd/dcext.xsd +391 -0
- package/data/xsd/feed.xsd +76 -0
- package/data/xsd/form.xsd +262 -0
- package/data/xsd/geolocation.xsd +68 -0
- package/data/xsd/giftcertificate.xsd +186 -0
- package/data/xsd/index.json +222 -0
- package/data/xsd/inventory.xsd +174 -0
- package/data/xsd/jobs.xsd +408 -0
- package/data/xsd/library.xsd +547 -0
- package/data/xsd/locales.xsd +172 -0
- package/data/xsd/metadata.xsd +315 -0
- package/data/xsd/oauth.xsd +60 -0
- package/data/xsd/order.xsd +1253 -0
- package/data/xsd/pagemetatag.xsd +110 -0
- package/data/xsd/paymentmethod.xsd +216 -0
- package/data/xsd/paymentprocessor.xsd +86 -0
- package/data/xsd/preferences.xsd +74 -0
- package/data/xsd/priceadjustmentlimits.xsd +74 -0
- package/data/xsd/pricebook.xsd +166 -0
- package/data/xsd/productlist.xsd +246 -0
- package/data/xsd/promotion.xsd +1019 -0
- package/data/xsd/redirecturl.xsd +120 -0
- package/data/xsd/returnimportfeed.xsd +82 -0
- package/data/xsd/schedules.xsd +246 -0
- package/data/xsd/search.xsd +333 -0
- package/data/xsd/search2.xsd +439 -0
- package/data/xsd/services.xsd +139 -0
- package/data/xsd/shipping.xsd +487 -0
- package/data/xsd/shippingorderupdatefeed.xsd +125 -0
- package/data/xsd/site.xsd +89 -0
- package/data/xsd/sitemapconfiguration.xsd +230 -0
- package/data/xsd/slot.xsd +292 -0
- package/data/xsd/sort.xsd +298 -0
- package/data/xsd/sourcecode.xsd +188 -0
- package/data/xsd/store.xsd +194 -0
- package/data/xsd/tax.xsd +112 -0
- package/data/xsd/urlrules.xsd +273 -0
- package/data/xsd/xml.xsd +54 -0
- package/dist/cjs/auth/api-key.d.ts +28 -0
- package/dist/cjs/auth/api-key.js +44 -0
- package/dist/cjs/auth/api-key.js.map +1 -0
- package/dist/cjs/auth/basic.d.ts +7 -0
- package/dist/cjs/auth/basic.js +18 -0
- package/dist/cjs/auth/basic.js.map +1 -0
- package/dist/cjs/auth/index.d.ts +65 -0
- package/dist/cjs/auth/index.js +69 -0
- package/dist/cjs/auth/index.js.map +1 -0
- package/dist/cjs/auth/oauth-implicit.d.ts +74 -0
- package/dist/cjs/auth/oauth-implicit.js +330 -0
- package/dist/cjs/auth/oauth-implicit.js.map +1 -0
- package/dist/cjs/auth/oauth.d.ts +48 -0
- package/dist/cjs/auth/oauth.js +178 -0
- package/dist/cjs/auth/oauth.js.map +1 -0
- package/dist/cjs/auth/resolve.d.ts +100 -0
- package/dist/cjs/auth/resolve.js +173 -0
- package/dist/cjs/auth/resolve.js.map +1 -0
- package/dist/cjs/auth/types.d.ts +101 -0
- package/dist/cjs/auth/types.js +3 -0
- package/dist/cjs/auth/types.js.map +1 -0
- package/dist/cjs/cli/base-command.d.ts +98 -0
- package/dist/cjs/cli/base-command.js +331 -0
- package/dist/cjs/cli/base-command.js.map +1 -0
- package/dist/cjs/cli/cartridge-command.d.ts +65 -0
- package/dist/cjs/cli/cartridge-command.js +142 -0
- package/dist/cjs/cli/cartridge-command.js.map +1 -0
- package/dist/cjs/cli/cartridge-providers.d.ts +149 -0
- package/dist/cjs/cli/cartridge-providers.js +103 -0
- package/dist/cjs/cli/cartridge-providers.js.map +1 -0
- package/dist/cjs/cli/config.d.ts +75 -0
- package/dist/cjs/cli/config.js +65 -0
- package/dist/cjs/cli/config.js.map +1 -0
- package/dist/cjs/cli/hooks.d.ts +231 -0
- package/dist/cjs/cli/hooks.js +3 -0
- package/dist/cjs/cli/hooks.js.map +1 -0
- package/dist/cjs/cli/index.d.ts +103 -0
- package/dist/cjs/cli/index.js +106 -0
- package/dist/cjs/cli/index.js.map +1 -0
- package/dist/cjs/cli/instance-command.d.ts +121 -0
- package/dist/cjs/cli/instance-command.js +213 -0
- package/dist/cjs/cli/instance-command.js.map +1 -0
- package/dist/cjs/cli/job-command.d.ts +32 -0
- package/dist/cjs/cli/job-command.js +60 -0
- package/dist/cjs/cli/job-command.js.map +1 -0
- package/dist/cjs/cli/lifecycle.d.ts +189 -0
- package/dist/cjs/cli/lifecycle.js +130 -0
- package/dist/cjs/cli/lifecycle.js.map +1 -0
- package/dist/cjs/cli/mrt-command.d.ts +61 -0
- package/dist/cjs/cli/mrt-command.js +113 -0
- package/dist/cjs/cli/mrt-command.js.map +1 -0
- package/dist/cjs/cli/oauth-command.d.ts +70 -0
- package/dist/cjs/cli/oauth-command.js +173 -0
- package/dist/cjs/cli/oauth-command.js.map +1 -0
- package/dist/cjs/cli/ods-command.d.ts +70 -0
- package/dist/cjs/cli/ods-command.js +79 -0
- package/dist/cjs/cli/ods-command.js.map +1 -0
- package/dist/cjs/cli/table.d.ts +113 -0
- package/dist/cjs/cli/table.js +175 -0
- package/dist/cjs/cli/table.js.map +1 -0
- package/dist/cjs/cli/webdav-command.d.ts +100 -0
- package/dist/cjs/cli/webdav-command.js +106 -0
- package/dist/cjs/cli/webdav-command.js.map +1 -0
- package/dist/cjs/clients/custom-apis.d.ts +137 -0
- package/dist/cjs/clients/custom-apis.generated.d.ts +202 -0
- package/dist/cjs/clients/custom-apis.generated.js +6 -0
- package/dist/cjs/clients/custom-apis.generated.js.map +1 -0
- package/dist/cjs/clients/custom-apis.js +124 -0
- package/dist/cjs/clients/custom-apis.js.map +1 -0
- package/dist/cjs/clients/index.d.ts +127 -0
- package/dist/cjs/clients/index.js +125 -0
- package/dist/cjs/clients/index.js.map +1 -0
- package/dist/cjs/clients/middleware-registry.d.ts +184 -0
- package/dist/cjs/clients/middleware-registry.js +104 -0
- package/dist/cjs/clients/middleware-registry.js.map +1 -0
- package/dist/cjs/clients/middleware.d.ts +85 -0
- package/dist/cjs/clients/middleware.js +210 -0
- package/dist/cjs/clients/middleware.js.map +1 -0
- package/dist/cjs/clients/mrt.d.ts +120 -0
- package/dist/cjs/clients/mrt.generated.d.ts +2774 -0
- package/dist/cjs/clients/mrt.generated.js +6 -0
- package/dist/cjs/clients/mrt.generated.js.map +1 -0
- package/dist/cjs/clients/mrt.js +88 -0
- package/dist/cjs/clients/mrt.js.map +1 -0
- package/dist/cjs/clients/ocapi.d.ts +108 -0
- package/dist/cjs/clients/ocapi.generated.d.ts +26052 -0
- package/dist/cjs/clients/ocapi.generated.js +6 -0
- package/dist/cjs/clients/ocapi.generated.js.map +1 -0
- package/dist/cjs/clients/ocapi.js +80 -0
- package/dist/cjs/clients/ocapi.js.map +1 -0
- package/dist/cjs/clients/ods.d.ts +133 -0
- package/dist/cjs/clients/ods.generated.d.ts +2548 -0
- package/dist/cjs/clients/ods.generated.js +6 -0
- package/dist/cjs/clients/ods.generated.js.map +1 -0
- package/dist/cjs/clients/ods.js +103 -0
- package/dist/cjs/clients/ods.js.map +1 -0
- package/dist/cjs/clients/slas-admin.d.ts +104 -0
- package/dist/cjs/clients/slas-admin.generated.d.ts +1434 -0
- package/dist/cjs/clients/slas-admin.generated.js +6 -0
- package/dist/cjs/clients/slas-admin.generated.js.map +1 -0
- package/dist/cjs/clients/slas-admin.js +79 -0
- package/dist/cjs/clients/slas-admin.js.map +1 -0
- package/dist/cjs/clients/webdav.d.ts +157 -0
- package/dist/cjs/clients/webdav.js +337 -0
- package/dist/cjs/clients/webdav.js.map +1 -0
- package/dist/cjs/config/dw-json.d.ts +114 -0
- package/dist/cjs/config/dw-json.js +142 -0
- package/dist/cjs/config/dw-json.js.map +1 -0
- package/dist/cjs/config/index.d.ts +96 -0
- package/dist/cjs/config/index.js +103 -0
- package/dist/cjs/config/index.js.map +1 -0
- package/dist/cjs/config/mapping.d.ts +143 -0
- package/dist/cjs/config/mapping.js +212 -0
- package/dist/cjs/config/mapping.js.map +1 -0
- package/dist/cjs/config/resolved-config.d.ts +31 -0
- package/dist/cjs/config/resolved-config.js +84 -0
- package/dist/cjs/config/resolved-config.js.map +1 -0
- package/dist/cjs/config/resolver.d.ts +190 -0
- package/dist/cjs/config/resolver.js +323 -0
- package/dist/cjs/config/resolver.js.map +1 -0
- package/dist/cjs/config/sources/dw-json-source.d.ts +10 -0
- package/dist/cjs/config/sources/dw-json-source.js +38 -0
- package/dist/cjs/config/sources/dw-json-source.js.map +1 -0
- package/dist/cjs/config/sources/index.d.ts +7 -0
- package/dist/cjs/config/sources/index.js +13 -0
- package/dist/cjs/config/sources/index.js.map +1 -0
- package/dist/cjs/config/sources/mobify-source.d.ts +24 -0
- package/dist/cjs/config/sources/mobify-source.js +79 -0
- package/dist/cjs/config/sources/mobify-source.js.map +1 -0
- package/dist/cjs/config/types.d.ts +270 -0
- package/dist/cjs/config/types.js +2 -0
- package/dist/cjs/config/types.js.map +1 -0
- package/dist/cjs/defaults.d.ts +22 -0
- package/dist/cjs/defaults.js +28 -0
- package/dist/cjs/defaults.js.map +1 -0
- package/dist/cjs/discovery/detector.d.ts +75 -0
- package/dist/cjs/discovery/detector.js +108 -0
- package/dist/cjs/discovery/detector.js.map +1 -0
- package/dist/cjs/discovery/index.d.ts +63 -0
- package/dist/cjs/discovery/index.js +70 -0
- package/dist/cjs/discovery/index.js.map +1 -0
- package/dist/cjs/discovery/patterns/cartridges.d.ts +16 -0
- package/dist/cjs/discovery/patterns/cartridges.js +16 -0
- package/dist/cjs/discovery/patterns/cartridges.js.map +1 -0
- package/dist/cjs/discovery/patterns/index.d.ts +21 -0
- package/dist/cjs/discovery/patterns/index.js +16 -0
- package/dist/cjs/discovery/patterns/index.js.map +1 -0
- package/dist/cjs/discovery/patterns/pwa-kit.d.ts +15 -0
- package/dist/cjs/discovery/patterns/pwa-kit.js +26 -0
- package/dist/cjs/discovery/patterns/pwa-kit.js.map +1 -0
- package/dist/cjs/discovery/patterns/sfra.d.ts +34 -0
- package/dist/cjs/discovery/patterns/sfra.js +50 -0
- package/dist/cjs/discovery/patterns/sfra.js.map +1 -0
- package/dist/cjs/discovery/patterns/storefront-next.d.ts +14 -0
- package/dist/cjs/discovery/patterns/storefront-next.js +20 -0
- package/dist/cjs/discovery/patterns/storefront-next.js.map +1 -0
- package/dist/cjs/discovery/types.d.ts +47 -0
- package/dist/cjs/discovery/types.js +12 -0
- package/dist/cjs/discovery/types.js.map +1 -0
- package/dist/cjs/discovery/utils.d.ts +44 -0
- package/dist/cjs/discovery/utils.js +82 -0
- package/dist/cjs/discovery/utils.js.map +1 -0
- package/dist/cjs/errors/http-error.d.ts +34 -0
- package/dist/cjs/errors/http-error.js +45 -0
- package/dist/cjs/errors/http-error.js.map +1 -0
- package/dist/cjs/errors/index.d.ts +6 -0
- package/dist/cjs/errors/index.js +12 -0
- package/dist/cjs/errors/index.js.map +1 -0
- package/dist/cjs/i18n/index.d.ts +144 -0
- package/dist/cjs/i18n/index.js +242 -0
- package/dist/cjs/i18n/index.js.map +1 -0
- package/dist/cjs/i18n/locales/de.d.ts +13 -0
- package/dist/cjs/i18n/locales/de.js +19 -0
- package/dist/cjs/i18n/locales/de.js.map +1 -0
- package/dist/cjs/i18n/locales/index.d.ts +28 -0
- package/dist/cjs/i18n/locales/index.js +25 -0
- package/dist/cjs/i18n/locales/index.js.map +1 -0
- package/dist/cjs/index.d.ts +25 -0
- package/dist/cjs/index.js +31 -0
- package/dist/cjs/index.js.map +1 -0
- package/dist/cjs/instance/index.d.ts +132 -0
- package/dist/cjs/instance/index.js +124 -0
- package/dist/cjs/instance/index.js.map +1 -0
- package/dist/cjs/logger.d.ts +66 -0
- package/dist/cjs/logger.js +80 -0
- package/dist/cjs/logger.js.map +1 -0
- package/dist/cjs/logging/index.d.ts +116 -0
- package/dist/cjs/logging/index.js +121 -0
- package/dist/cjs/logging/index.js.map +1 -0
- package/dist/cjs/logging/logger.d.ts +9 -0
- package/dist/cjs/logging/logger.js +111 -0
- package/dist/cjs/logging/logger.js.map +1 -0
- package/dist/cjs/logging/types.d.ts +36 -0
- package/dist/cjs/logging/types.js +10 -0
- package/dist/cjs/logging/types.js.map +1 -0
- package/dist/cjs/operations/code/cartridges.d.ts +46 -0
- package/dist/cjs/operations/code/cartridges.js +59 -0
- package/dist/cjs/operations/code/cartridges.js.map +1 -0
- package/dist/cjs/operations/code/deploy.d.ts +101 -0
- package/dist/cjs/operations/code/deploy.js +218 -0
- package/dist/cjs/operations/code/deploy.js.map +1 -0
- package/dist/cjs/operations/code/index.d.ts +66 -0
- package/dist/cjs/operations/code/index.js +72 -0
- package/dist/cjs/operations/code/index.js.map +1 -0
- package/dist/cjs/operations/code/versions.d.ts +99 -0
- package/dist/cjs/operations/code/versions.js +156 -0
- package/dist/cjs/operations/code/versions.js.map +1 -0
- package/dist/cjs/operations/code/watch.d.ts +58 -0
- package/dist/cjs/operations/code/watch.js +226 -0
- package/dist/cjs/operations/code/watch.js.map +1 -0
- package/dist/cjs/operations/docs/download.d.ts +45 -0
- package/dist/cjs/operations/docs/download.js +96 -0
- package/dist/cjs/operations/docs/download.js.map +1 -0
- package/dist/cjs/operations/docs/index.d.ts +44 -0
- package/dist/cjs/operations/docs/index.js +12 -0
- package/dist/cjs/operations/docs/index.js.map +1 -0
- package/dist/cjs/operations/docs/schema.d.ts +24 -0
- package/dist/cjs/operations/docs/schema.js +92 -0
- package/dist/cjs/operations/docs/schema.js.map +1 -0
- package/dist/cjs/operations/docs/search.d.ts +67 -0
- package/dist/cjs/operations/docs/search.js +128 -0
- package/dist/cjs/operations/docs/search.js.map +1 -0
- package/dist/cjs/operations/docs/types.d.ts +64 -0
- package/dist/cjs/operations/docs/types.js +15 -0
- package/dist/cjs/operations/docs/types.js.map +1 -0
- package/dist/cjs/operations/jobs/index.d.ts +66 -0
- package/dist/cjs/operations/jobs/index.js +72 -0
- package/dist/cjs/operations/jobs/index.js.map +1 -0
- package/dist/cjs/operations/jobs/run.d.ts +224 -0
- package/dist/cjs/operations/jobs/run.js +322 -0
- package/dist/cjs/operations/jobs/run.js.map +1 -0
- package/dist/cjs/operations/jobs/site-archive.d.ts +224 -0
- package/dist/cjs/operations/jobs/site-archive.js +354 -0
- package/dist/cjs/operations/jobs/site-archive.js.map +1 -0
- package/dist/cjs/operations/mrt/bundle.d.ts +114 -0
- package/dist/cjs/operations/mrt/bundle.js +166 -0
- package/dist/cjs/operations/mrt/bundle.js.map +1 -0
- package/dist/cjs/operations/mrt/env-var.d.ts +176 -0
- package/dist/cjs/operations/mrt/env-var.js +231 -0
- package/dist/cjs/operations/mrt/env-var.js.map +1 -0
- package/dist/cjs/operations/mrt/env.d.ts +256 -0
- package/dist/cjs/operations/mrt/env.js +233 -0
- package/dist/cjs/operations/mrt/env.js.map +1 -0
- package/dist/cjs/operations/mrt/index.d.ts +49 -0
- package/dist/cjs/operations/mrt/index.js +55 -0
- package/dist/cjs/operations/mrt/index.js.map +1 -0
- package/dist/cjs/operations/mrt/push.d.ts +109 -0
- package/dist/cjs/operations/mrt/push.js +149 -0
- package/dist/cjs/operations/mrt/push.js.map +1 -0
- package/dist/cjs/operations/sites/index.d.ts +56 -0
- package/dist/cjs/operations/sites/index.js +19 -0
- package/dist/cjs/operations/sites/index.js.map +1 -0
- package/dist/cjs/package.json +1 -0
- package/dist/cjs/platform/index.d.ts +38 -0
- package/dist/cjs/platform/index.js +42 -0
- package/dist/cjs/platform/index.js.map +1 -0
- package/dist/cjs/platform/mrt.d.ts +19 -0
- package/dist/cjs/platform/mrt.js +22 -0
- package/dist/cjs/platform/mrt.js.map +1 -0
- package/dist/cjs/platform/ods.d.ts +17 -0
- package/dist/cjs/platform/ods.js +22 -0
- package/dist/cjs/platform/ods.js.map +1 -0
- package/dist/esm/auth/api-key.d.ts +28 -0
- package/dist/esm/auth/api-key.js +44 -0
- package/dist/esm/auth/api-key.js.map +1 -0
- package/dist/esm/auth/basic.d.ts +7 -0
- package/dist/esm/auth/basic.js +18 -0
- package/dist/esm/auth/basic.js.map +1 -0
- package/dist/esm/auth/index.d.ts +65 -0
- package/dist/esm/auth/index.js +69 -0
- package/dist/esm/auth/index.js.map +1 -0
- package/dist/esm/auth/oauth-implicit.d.ts +74 -0
- package/dist/esm/auth/oauth-implicit.js +330 -0
- package/dist/esm/auth/oauth-implicit.js.map +1 -0
- package/dist/esm/auth/oauth.d.ts +48 -0
- package/dist/esm/auth/oauth.js +178 -0
- package/dist/esm/auth/oauth.js.map +1 -0
- package/dist/esm/auth/resolve.d.ts +100 -0
- package/dist/esm/auth/resolve.js +173 -0
- package/dist/esm/auth/resolve.js.map +1 -0
- package/dist/esm/auth/types.d.ts +101 -0
- package/dist/esm/auth/types.js +3 -0
- package/dist/esm/auth/types.js.map +1 -0
- package/dist/esm/cli/base-command.d.ts +98 -0
- package/dist/esm/cli/base-command.js +331 -0
- package/dist/esm/cli/base-command.js.map +1 -0
- package/dist/esm/cli/cartridge-command.d.ts +65 -0
- package/dist/esm/cli/cartridge-command.js +142 -0
- package/dist/esm/cli/cartridge-command.js.map +1 -0
- package/dist/esm/cli/cartridge-providers.d.ts +149 -0
- package/dist/esm/cli/cartridge-providers.js +103 -0
- package/dist/esm/cli/cartridge-providers.js.map +1 -0
- package/dist/esm/cli/config.d.ts +75 -0
- package/dist/esm/cli/config.js +65 -0
- package/dist/esm/cli/config.js.map +1 -0
- package/dist/esm/cli/hooks.d.ts +231 -0
- package/dist/esm/cli/hooks.js +3 -0
- package/dist/esm/cli/hooks.js.map +1 -0
- package/dist/esm/cli/index.d.ts +103 -0
- package/dist/esm/cli/index.js +108 -0
- package/dist/esm/cli/index.js.map +1 -0
- package/dist/esm/cli/instance-command.d.ts +121 -0
- package/dist/esm/cli/instance-command.js +213 -0
- package/dist/esm/cli/instance-command.js.map +1 -0
- package/dist/esm/cli/job-command.d.ts +32 -0
- package/dist/esm/cli/job-command.js +66 -0
- package/dist/esm/cli/job-command.js.map +1 -0
- package/dist/esm/cli/lifecycle.d.ts +189 -0
- package/dist/esm/cli/lifecycle.js +130 -0
- package/dist/esm/cli/lifecycle.js.map +1 -0
- package/dist/esm/cli/mrt-command.d.ts +61 -0
- package/dist/esm/cli/mrt-command.js +113 -0
- package/dist/esm/cli/mrt-command.js.map +1 -0
- package/dist/esm/cli/oauth-command.d.ts +70 -0
- package/dist/esm/cli/oauth-command.js +173 -0
- package/dist/esm/cli/oauth-command.js.map +1 -0
- package/dist/esm/cli/ods-command.d.ts +70 -0
- package/dist/esm/cli/ods-command.js +79 -0
- package/dist/esm/cli/ods-command.js.map +1 -0
- package/dist/esm/cli/table.d.ts +113 -0
- package/dist/esm/cli/table.js +175 -0
- package/dist/esm/cli/table.js.map +1 -0
- package/dist/esm/cli/webdav-command.d.ts +100 -0
- package/dist/esm/cli/webdav-command.js +106 -0
- package/dist/esm/cli/webdav-command.js.map +1 -0
- package/dist/esm/clients/custom-apis.d.ts +137 -0
- package/dist/esm/clients/custom-apis.generated.d.ts +202 -0
- package/dist/esm/clients/custom-apis.generated.js +6 -0
- package/dist/esm/clients/custom-apis.generated.js.map +1 -0
- package/dist/esm/clients/custom-apis.js +124 -0
- package/dist/esm/clients/custom-apis.js.map +1 -0
- package/dist/esm/clients/index.d.ts +127 -0
- package/dist/esm/clients/index.js +125 -0
- package/dist/esm/clients/index.js.map +1 -0
- package/dist/esm/clients/middleware-registry.d.ts +184 -0
- package/dist/esm/clients/middleware-registry.js +104 -0
- package/dist/esm/clients/middleware-registry.js.map +1 -0
- package/dist/esm/clients/middleware.d.ts +85 -0
- package/dist/esm/clients/middleware.js +210 -0
- package/dist/esm/clients/middleware.js.map +1 -0
- package/dist/esm/clients/mrt.d.ts +120 -0
- package/dist/esm/clients/mrt.generated.d.ts +2774 -0
- package/dist/esm/clients/mrt.generated.js +6 -0
- package/dist/esm/clients/mrt.generated.js.map +1 -0
- package/dist/esm/clients/mrt.js +88 -0
- package/dist/esm/clients/mrt.js.map +1 -0
- package/dist/esm/clients/ocapi.d.ts +108 -0
- package/dist/esm/clients/ocapi.generated.d.ts +26052 -0
- package/dist/esm/clients/ocapi.generated.js +6 -0
- package/dist/esm/clients/ocapi.generated.js.map +1 -0
- package/dist/esm/clients/ocapi.js +80 -0
- package/dist/esm/clients/ocapi.js.map +1 -0
- package/dist/esm/clients/ods.d.ts +133 -0
- package/dist/esm/clients/ods.generated.d.ts +2548 -0
- package/dist/esm/clients/ods.generated.js +6 -0
- package/dist/esm/clients/ods.generated.js.map +1 -0
- package/dist/esm/clients/ods.js +103 -0
- package/dist/esm/clients/ods.js.map +1 -0
- package/dist/esm/clients/slas-admin.d.ts +104 -0
- package/dist/esm/clients/slas-admin.generated.d.ts +1434 -0
- package/dist/esm/clients/slas-admin.generated.js +6 -0
- package/dist/esm/clients/slas-admin.generated.js.map +1 -0
- package/dist/esm/clients/slas-admin.js +79 -0
- package/dist/esm/clients/slas-admin.js.map +1 -0
- package/dist/esm/clients/webdav.d.ts +157 -0
- package/dist/esm/clients/webdav.js +337 -0
- package/dist/esm/clients/webdav.js.map +1 -0
- package/dist/esm/config/dw-json.d.ts +114 -0
- package/dist/esm/config/dw-json.js +142 -0
- package/dist/esm/config/dw-json.js.map +1 -0
- package/dist/esm/config/index.d.ts +96 -0
- package/dist/esm/config/index.js +103 -0
- package/dist/esm/config/index.js.map +1 -0
- package/dist/esm/config/mapping.d.ts +143 -0
- package/dist/esm/config/mapping.js +212 -0
- package/dist/esm/config/mapping.js.map +1 -0
- package/dist/esm/config/resolved-config.d.ts +31 -0
- package/dist/esm/config/resolved-config.js +84 -0
- package/dist/esm/config/resolved-config.js.map +1 -0
- package/dist/esm/config/resolver.d.ts +190 -0
- package/dist/esm/config/resolver.js +323 -0
- package/dist/esm/config/resolver.js.map +1 -0
- package/dist/esm/config/sources/dw-json-source.d.ts +10 -0
- package/dist/esm/config/sources/dw-json-source.js +38 -0
- package/dist/esm/config/sources/dw-json-source.js.map +1 -0
- package/dist/esm/config/sources/index.d.ts +7 -0
- package/dist/esm/config/sources/index.js +13 -0
- package/dist/esm/config/sources/index.js.map +1 -0
- package/dist/esm/config/sources/mobify-source.d.ts +24 -0
- package/dist/esm/config/sources/mobify-source.js +79 -0
- package/dist/esm/config/sources/mobify-source.js.map +1 -0
- package/dist/esm/config/types.d.ts +270 -0
- package/dist/esm/config/types.js +2 -0
- package/dist/esm/config/types.js.map +1 -0
- package/dist/esm/defaults.d.ts +22 -0
- package/dist/esm/defaults.js +28 -0
- package/dist/esm/defaults.js.map +1 -0
- package/dist/esm/discovery/detector.d.ts +75 -0
- package/dist/esm/discovery/detector.js +108 -0
- package/dist/esm/discovery/detector.js.map +1 -0
- package/dist/esm/discovery/index.d.ts +63 -0
- package/dist/esm/discovery/index.js +70 -0
- package/dist/esm/discovery/index.js.map +1 -0
- package/dist/esm/discovery/patterns/cartridges.d.ts +16 -0
- package/dist/esm/discovery/patterns/cartridges.js +16 -0
- package/dist/esm/discovery/patterns/cartridges.js.map +1 -0
- package/dist/esm/discovery/patterns/index.d.ts +21 -0
- package/dist/esm/discovery/patterns/index.js +16 -0
- package/dist/esm/discovery/patterns/index.js.map +1 -0
- package/dist/esm/discovery/patterns/pwa-kit.d.ts +15 -0
- package/dist/esm/discovery/patterns/pwa-kit.js +26 -0
- package/dist/esm/discovery/patterns/pwa-kit.js.map +1 -0
- package/dist/esm/discovery/patterns/sfra.d.ts +34 -0
- package/dist/esm/discovery/patterns/sfra.js +50 -0
- package/dist/esm/discovery/patterns/sfra.js.map +1 -0
- package/dist/esm/discovery/patterns/storefront-next.d.ts +14 -0
- package/dist/esm/discovery/patterns/storefront-next.js +20 -0
- package/dist/esm/discovery/patterns/storefront-next.js.map +1 -0
- package/dist/esm/discovery/types.d.ts +47 -0
- package/dist/esm/discovery/types.js +12 -0
- package/dist/esm/discovery/types.js.map +1 -0
- package/dist/esm/discovery/utils.d.ts +44 -0
- package/dist/esm/discovery/utils.js +82 -0
- package/dist/esm/discovery/utils.js.map +1 -0
- package/dist/esm/errors/http-error.d.ts +34 -0
- package/dist/esm/errors/http-error.js +45 -0
- package/dist/esm/errors/http-error.js.map +1 -0
- package/dist/esm/errors/index.d.ts +6 -0
- package/dist/esm/errors/index.js +12 -0
- package/dist/esm/errors/index.js.map +1 -0
- package/dist/esm/i18n/index.d.ts +144 -0
- package/dist/esm/i18n/index.js +242 -0
- package/dist/esm/i18n/index.js.map +1 -0
- package/dist/esm/i18n/locales/de.d.ts +13 -0
- package/dist/esm/i18n/locales/de.js +19 -0
- package/dist/esm/i18n/locales/de.js.map +1 -0
- package/dist/esm/i18n/locales/index.d.ts +28 -0
- package/dist/esm/i18n/locales/index.js +25 -0
- package/dist/esm/i18n/locales/index.js.map +1 -0
- package/dist/esm/index.d.ts +25 -0
- package/dist/esm/index.js +31 -0
- package/dist/esm/index.js.map +1 -0
- package/dist/esm/instance/index.d.ts +132 -0
- package/dist/esm/instance/index.js +124 -0
- package/dist/esm/instance/index.js.map +1 -0
- package/dist/esm/logger.d.ts +66 -0
- package/dist/esm/logger.js +80 -0
- package/dist/esm/logger.js.map +1 -0
- package/dist/esm/logging/index.d.ts +116 -0
- package/dist/esm/logging/index.js +121 -0
- package/dist/esm/logging/index.js.map +1 -0
- package/dist/esm/logging/logger.d.ts +9 -0
- package/dist/esm/logging/logger.js +111 -0
- package/dist/esm/logging/logger.js.map +1 -0
- package/dist/esm/logging/types.d.ts +36 -0
- package/dist/esm/logging/types.js +10 -0
- package/dist/esm/logging/types.js.map +1 -0
- package/dist/esm/operations/code/cartridges.d.ts +46 -0
- package/dist/esm/operations/code/cartridges.js +59 -0
- package/dist/esm/operations/code/cartridges.js.map +1 -0
- package/dist/esm/operations/code/deploy.d.ts +101 -0
- package/dist/esm/operations/code/deploy.js +218 -0
- package/dist/esm/operations/code/deploy.js.map +1 -0
- package/dist/esm/operations/code/index.d.ts +66 -0
- package/dist/esm/operations/code/index.js +72 -0
- package/dist/esm/operations/code/index.js.map +1 -0
- package/dist/esm/operations/code/versions.d.ts +99 -0
- package/dist/esm/operations/code/versions.js +157 -0
- package/dist/esm/operations/code/versions.js.map +1 -0
- package/dist/esm/operations/code/watch.d.ts +58 -0
- package/dist/esm/operations/code/watch.js +226 -0
- package/dist/esm/operations/code/watch.js.map +1 -0
- package/dist/esm/operations/docs/download.d.ts +45 -0
- package/dist/esm/operations/docs/download.js +96 -0
- package/dist/esm/operations/docs/download.js.map +1 -0
- package/dist/esm/operations/docs/index.d.ts +44 -0
- package/dist/esm/operations/docs/index.js +12 -0
- package/dist/esm/operations/docs/index.js.map +1 -0
- package/dist/esm/operations/docs/schema.d.ts +24 -0
- package/dist/esm/operations/docs/schema.js +92 -0
- package/dist/esm/operations/docs/schema.js.map +1 -0
- package/dist/esm/operations/docs/search.d.ts +67 -0
- package/dist/esm/operations/docs/search.js +128 -0
- package/dist/esm/operations/docs/search.js.map +1 -0
- package/dist/esm/operations/docs/types.d.ts +64 -0
- package/dist/esm/operations/docs/types.js +15 -0
- package/dist/esm/operations/docs/types.js.map +1 -0
- package/dist/esm/operations/jobs/index.d.ts +66 -0
- package/dist/esm/operations/jobs/index.js +72 -0
- package/dist/esm/operations/jobs/index.js.map +1 -0
- package/dist/esm/operations/jobs/run.d.ts +224 -0
- package/dist/esm/operations/jobs/run.js +333 -0
- package/dist/esm/operations/jobs/run.js.map +1 -0
- package/dist/esm/operations/jobs/site-archive.d.ts +224 -0
- package/dist/esm/operations/jobs/site-archive.js +355 -0
- package/dist/esm/operations/jobs/site-archive.js.map +1 -0
- package/dist/esm/operations/mrt/bundle.d.ts +114 -0
- package/dist/esm/operations/mrt/bundle.js +166 -0
- package/dist/esm/operations/mrt/bundle.js.map +1 -0
- package/dist/esm/operations/mrt/env-var.d.ts +176 -0
- package/dist/esm/operations/mrt/env-var.js +231 -0
- package/dist/esm/operations/mrt/env-var.js.map +1 -0
- package/dist/esm/operations/mrt/env.d.ts +256 -0
- package/dist/esm/operations/mrt/env.js +233 -0
- package/dist/esm/operations/mrt/env.js.map +1 -0
- package/dist/esm/operations/mrt/index.d.ts +49 -0
- package/dist/esm/operations/mrt/index.js +55 -0
- package/dist/esm/operations/mrt/index.js.map +1 -0
- package/dist/esm/operations/mrt/push.d.ts +109 -0
- package/dist/esm/operations/mrt/push.js +149 -0
- package/dist/esm/operations/mrt/push.js.map +1 -0
- package/dist/esm/operations/sites/index.d.ts +56 -0
- package/dist/esm/operations/sites/index.js +67 -0
- package/dist/esm/operations/sites/index.js.map +1 -0
- package/dist/esm/platform/index.d.ts +38 -0
- package/dist/esm/platform/index.js +42 -0
- package/dist/esm/platform/index.js.map +1 -0
- package/dist/esm/platform/mrt.d.ts +19 -0
- package/dist/esm/platform/mrt.js +22 -0
- package/dist/esm/platform/mrt.js.map +1 -0
- package/dist/esm/platform/ods.d.ts +17 -0
- package/dist/esm/platform/ods.js +22 -0
- package/dist/esm/platform/ods.js.map +1 -0
- package/package.json +269 -6
- package/specs/README.md +7 -0
- package/specs/custom-apis-v1.yaml +309 -0
- package/specs/data-api.json +37503 -0
- package/specs/mrt-api-v1.json +5555 -0
- package/specs/ods-api-v1.json +3673 -0
- package/specs/slas-admin-v1.yaml +1841 -0
|
@@ -0,0 +1,1841 @@
|
|
|
1
|
+
openapi: 3.0.3
|
|
2
|
+
info:
|
|
3
|
+
x-api-type: Admin
|
|
4
|
+
x-api-family: Shopper
|
|
5
|
+
title: Slas Admin
|
|
6
|
+
version: 1.12.31
|
|
7
|
+
description: |-
|
|
8
|
+
[Download API specification](https://developer.salesforce.com/static/commercecloud/commerce-api/slas-admin/slas-admin-oas-v1-public.yaml)
|
|
9
|
+
|
|
10
|
+
# API Overview
|
|
11
|
+
|
|
12
|
+
The SLAS Admin API is a companion to the main [Shopper Login and API Access Service](https://developer.salesforce.com/docs/commerce/commerce-api/references?meta=shopper-login:Summary) (SLAS), which enables secure access to Commerce Cloud’s Shopper APIs. The SLAS Admin API is only used for administration tasks, not for requesting access to the Shopper APIs.
|
|
13
|
+
|
|
14
|
+
**Important:** Before using this API, follow the instructions in [Authorization for Shopper APIs](https://developer.salesforce.com/docs/commerce/commerce-api/guide/authorization-for-shopper-apis.html) from the Get Started guides. The guide provides a complete set of instructions for setting up a SLAS client.
|
|
15
|
+
|
|
16
|
+
For more information, see the [SLAS guides](https://developer.salesforce.com/docs/commerce/commerce-api/guide/slas.html).
|
|
17
|
+
servers:
|
|
18
|
+
- url: https://{shortCode}.api.commercecloud.salesforce.com/shopper/auth-admin/v1
|
|
19
|
+
variables:
|
|
20
|
+
shortCode:
|
|
21
|
+
default: shortCode
|
|
22
|
+
paths:
|
|
23
|
+
/tenants/{tenantId}:
|
|
24
|
+
get:
|
|
25
|
+
summary: Retrieve a tenant by tenant ID.
|
|
26
|
+
description: Retrieve a tenant by tenant ID.
|
|
27
|
+
operationId: retrieveTenant
|
|
28
|
+
parameters:
|
|
29
|
+
- $ref: '#/components/parameters/tenantId'
|
|
30
|
+
responses:
|
|
31
|
+
'200':
|
|
32
|
+
description: The tenant was retrieved successfully.
|
|
33
|
+
content:
|
|
34
|
+
application/json:
|
|
35
|
+
schema:
|
|
36
|
+
$ref: '#/components/schemas/Tenant'
|
|
37
|
+
examples:
|
|
38
|
+
Tenant:
|
|
39
|
+
$ref: '#/components/examples/Tenant'
|
|
40
|
+
'400':
|
|
41
|
+
description: Bad request
|
|
42
|
+
content:
|
|
43
|
+
application/json:
|
|
44
|
+
schema:
|
|
45
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
46
|
+
examples:
|
|
47
|
+
TenantRequestException400:
|
|
48
|
+
$ref: '#/components/examples/TenantRequestException400'
|
|
49
|
+
'401':
|
|
50
|
+
description: Unauthorized. Wrong tenant
|
|
51
|
+
content:
|
|
52
|
+
application/json:
|
|
53
|
+
schema:
|
|
54
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
55
|
+
examples:
|
|
56
|
+
TenantException401:
|
|
57
|
+
$ref: '#/components/examples/TenantException401'
|
|
58
|
+
'404':
|
|
59
|
+
description: Not found
|
|
60
|
+
content:
|
|
61
|
+
application/json:
|
|
62
|
+
schema:
|
|
63
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
64
|
+
examples:
|
|
65
|
+
TenantNotFoundException404:
|
|
66
|
+
$ref: '#/components/examples/TenantNotFoundException404'
|
|
67
|
+
security:
|
|
68
|
+
- BearerToken:
|
|
69
|
+
- SLAS_SERVICE_ADMIN
|
|
70
|
+
- SLAS_ORGANIZATION_ADMIN
|
|
71
|
+
put:
|
|
72
|
+
summary: Create or update a tenant. Use the request body to provide identification and contact information for the tenant and its associated merchant.
|
|
73
|
+
description: This API is used to create or update a tenant. The tenant ID is the unique identifier for the tenant and is used in all subsequent API calls. The tenant ID must be unique across all tenants in the system.
|
|
74
|
+
operationId: registerTenant
|
|
75
|
+
parameters:
|
|
76
|
+
- $ref: '#/components/parameters/tenantId'
|
|
77
|
+
requestBody:
|
|
78
|
+
content:
|
|
79
|
+
application/json:
|
|
80
|
+
schema:
|
|
81
|
+
$ref: '#/components/schemas/TenantDto'
|
|
82
|
+
examples:
|
|
83
|
+
TenantDto:
|
|
84
|
+
$ref: '#/components/examples/TenantDto'
|
|
85
|
+
required: true
|
|
86
|
+
responses:
|
|
87
|
+
'200':
|
|
88
|
+
description: The tenant was updated successfully.
|
|
89
|
+
content:
|
|
90
|
+
application/json:
|
|
91
|
+
schema:
|
|
92
|
+
$ref: '#/components/schemas/Tenant'
|
|
93
|
+
examples:
|
|
94
|
+
Tenant:
|
|
95
|
+
$ref: '#/components/examples/Tenant'
|
|
96
|
+
'201':
|
|
97
|
+
description: The tenant was created successfully.
|
|
98
|
+
content:
|
|
99
|
+
application/json:
|
|
100
|
+
schema:
|
|
101
|
+
$ref: '#/components/schemas/Tenant'
|
|
102
|
+
examples:
|
|
103
|
+
Tenant:
|
|
104
|
+
$ref: '#/components/examples/Tenant'
|
|
105
|
+
'400':
|
|
106
|
+
description: Bad request
|
|
107
|
+
content:
|
|
108
|
+
application/json:
|
|
109
|
+
schema:
|
|
110
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
111
|
+
examples:
|
|
112
|
+
TenantUpdateException400:
|
|
113
|
+
$ref: '#/components/examples/TenantUpdateException400'
|
|
114
|
+
'401':
|
|
115
|
+
description: Unauthorized. Wrong tenant
|
|
116
|
+
content:
|
|
117
|
+
application/json:
|
|
118
|
+
schema:
|
|
119
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
120
|
+
examples:
|
|
121
|
+
TenantUpdateException401:
|
|
122
|
+
$ref: '#/components/examples/TenantUpdateException401'
|
|
123
|
+
'404':
|
|
124
|
+
description: Not found
|
|
125
|
+
content:
|
|
126
|
+
application/json:
|
|
127
|
+
schema:
|
|
128
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
129
|
+
examples:
|
|
130
|
+
TenantNotFoundException404:
|
|
131
|
+
$ref: '#/components/examples/TenantNotFoundException404'
|
|
132
|
+
'409':
|
|
133
|
+
description: Conflict
|
|
134
|
+
content:
|
|
135
|
+
application/json:
|
|
136
|
+
schema:
|
|
137
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
138
|
+
examples:
|
|
139
|
+
TenantAlreadyExistsException409:
|
|
140
|
+
$ref: '#/components/examples/TenantAlreadyExistsException409'
|
|
141
|
+
security:
|
|
142
|
+
- BearerToken:
|
|
143
|
+
- SLAS_SERVICE_ADMIN
|
|
144
|
+
- SLAS_ORGANIZATION_ADMIN
|
|
145
|
+
/tenants/{tenantId}/clients:
|
|
146
|
+
get:
|
|
147
|
+
summary: Retrieve/Get all tenant clients.
|
|
148
|
+
description: Retrieve a list of SLAS clients associated with the tenant_id.
|
|
149
|
+
operationId: retrieveClients
|
|
150
|
+
parameters:
|
|
151
|
+
- $ref: '#/components/parameters/tenantId'
|
|
152
|
+
responses:
|
|
153
|
+
'200':
|
|
154
|
+
description: All tenant clients retrieved successfully.
|
|
155
|
+
content:
|
|
156
|
+
application/json:
|
|
157
|
+
schema:
|
|
158
|
+
$ref: '#/components/schemas/ClientListResponse'
|
|
159
|
+
examples:
|
|
160
|
+
ClientListResponse:
|
|
161
|
+
$ref: '#/components/examples/ClientListResponse'
|
|
162
|
+
'401':
|
|
163
|
+
description: Unauthorized. Wrong tenant
|
|
164
|
+
content:
|
|
165
|
+
application/json:
|
|
166
|
+
schema:
|
|
167
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
168
|
+
examples:
|
|
169
|
+
ClientTenantException401:
|
|
170
|
+
$ref: '#/components/examples/ClientTenantException401'
|
|
171
|
+
'404':
|
|
172
|
+
description: Not found
|
|
173
|
+
content:
|
|
174
|
+
application/json:
|
|
175
|
+
schema:
|
|
176
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
177
|
+
examples:
|
|
178
|
+
ClientNotFoundException404:
|
|
179
|
+
$ref: '#/components/examples/ClientNotFoundException404'
|
|
180
|
+
security:
|
|
181
|
+
- BearerToken:
|
|
182
|
+
- SLAS_SERVICE_ADMIN
|
|
183
|
+
/tenants/{tenantId}/clients/{clientId}:
|
|
184
|
+
get:
|
|
185
|
+
summary: Retrieve a client.
|
|
186
|
+
description: Retrieve a client by client ID. The client ID is the unique identifier for the client and is used in all subsequent API calls. The client ID must be unique across all tenants in the system.
|
|
187
|
+
operationId: retrieveClient
|
|
188
|
+
parameters:
|
|
189
|
+
- $ref: '#/components/parameters/clientId'
|
|
190
|
+
- $ref: '#/components/parameters/tenantId'
|
|
191
|
+
responses:
|
|
192
|
+
'200':
|
|
193
|
+
description: The client was retrieved successfully.
|
|
194
|
+
content:
|
|
195
|
+
application/json:
|
|
196
|
+
schema:
|
|
197
|
+
$ref: '#/components/schemas/Client'
|
|
198
|
+
examples:
|
|
199
|
+
Client:
|
|
200
|
+
$ref: '#/components/examples/Client'
|
|
201
|
+
'400':
|
|
202
|
+
description: Bad request
|
|
203
|
+
content:
|
|
204
|
+
application/json:
|
|
205
|
+
schema:
|
|
206
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
207
|
+
examples:
|
|
208
|
+
ClientRequestException400:
|
|
209
|
+
$ref: '#/components/examples/ClientRequestException400'
|
|
210
|
+
'401':
|
|
211
|
+
description: Unauthorized. Wrong tenant
|
|
212
|
+
content:
|
|
213
|
+
application/json:
|
|
214
|
+
schema:
|
|
215
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
216
|
+
examples:
|
|
217
|
+
ClientTenantException401:
|
|
218
|
+
$ref: '#/components/examples/ClientTenantException401'
|
|
219
|
+
'404':
|
|
220
|
+
description: Not found
|
|
221
|
+
content:
|
|
222
|
+
application/json:
|
|
223
|
+
schema:
|
|
224
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
225
|
+
examples:
|
|
226
|
+
ClientNotFoundException404:
|
|
227
|
+
$ref: '#/components/examples/ClientNotFoundException404'
|
|
228
|
+
security:
|
|
229
|
+
- BearerToken:
|
|
230
|
+
- SLAS_SERVICE_ADMIN
|
|
231
|
+
put:
|
|
232
|
+
summary: Create or update a client.
|
|
233
|
+
description: It is strongly advised to refrain from using the “sfcc-shopper-context.rw” scope with a PUBLIC Client because it offers fewer protections and could potentially enable malicious actors to access Shopper Context enabled promotions. It is highly recommended to use “sfcc-shopper-context.rw” scope with a private client.
|
|
234
|
+
operationId: registerClient
|
|
235
|
+
parameters:
|
|
236
|
+
- $ref: '#/components/parameters/clientId'
|
|
237
|
+
- $ref: '#/components/parameters/tenantId'
|
|
238
|
+
requestBody:
|
|
239
|
+
content:
|
|
240
|
+
application/json:
|
|
241
|
+
schema:
|
|
242
|
+
$ref: '#/components/schemas/ClientRequest'
|
|
243
|
+
examples:
|
|
244
|
+
ClientRequest:
|
|
245
|
+
$ref: '#/components/examples/ClientRequest'
|
|
246
|
+
required: true
|
|
247
|
+
responses:
|
|
248
|
+
'200':
|
|
249
|
+
description: The client was updated successfully. A secret is only returned when a secret was sent with the update request.
|
|
250
|
+
content:
|
|
251
|
+
application/json:
|
|
252
|
+
schema:
|
|
253
|
+
$ref: '#/components/schemas/Client'
|
|
254
|
+
examples:
|
|
255
|
+
ClientRequest:
|
|
256
|
+
$ref: '#/components/examples/ClientWithSecret'
|
|
257
|
+
'201':
|
|
258
|
+
description: The client was created successfully. This is the only time the secret is returned.
|
|
259
|
+
content:
|
|
260
|
+
application/json:
|
|
261
|
+
schema:
|
|
262
|
+
$ref: '#/components/schemas/Client'
|
|
263
|
+
examples:
|
|
264
|
+
ClientRequest:
|
|
265
|
+
$ref: '#/components/examples/ClientWithSecret'
|
|
266
|
+
'400':
|
|
267
|
+
description: Bad request
|
|
268
|
+
content:
|
|
269
|
+
application/json:
|
|
270
|
+
schema:
|
|
271
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
272
|
+
examples:
|
|
273
|
+
ClientRequestException400:
|
|
274
|
+
$ref: '#/components/examples/ClientRequestException400'
|
|
275
|
+
'401':
|
|
276
|
+
description: Unauthorized. Wrong tenant
|
|
277
|
+
content:
|
|
278
|
+
application/json:
|
|
279
|
+
schema:
|
|
280
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
281
|
+
examples:
|
|
282
|
+
ClientTenantException401:
|
|
283
|
+
$ref: '#/components/examples/ClientTenantException401'
|
|
284
|
+
'404':
|
|
285
|
+
description: Not found
|
|
286
|
+
content:
|
|
287
|
+
application/json:
|
|
288
|
+
schema:
|
|
289
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
290
|
+
examples:
|
|
291
|
+
ClientNotFoundException404:
|
|
292
|
+
$ref: '#/components/examples/ClientNotFoundException404'
|
|
293
|
+
'409':
|
|
294
|
+
description: Conflict
|
|
295
|
+
content:
|
|
296
|
+
application/json:
|
|
297
|
+
schema:
|
|
298
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
299
|
+
examples:
|
|
300
|
+
ClientConflictException409:
|
|
301
|
+
$ref: '#/components/examples/ClientConflictException409'
|
|
302
|
+
security:
|
|
303
|
+
- BearerToken:
|
|
304
|
+
- SLAS_SERVICE_ADMIN
|
|
305
|
+
- SLAS_ORGANIZATION_ADMIN
|
|
306
|
+
delete:
|
|
307
|
+
summary: Delete a client.
|
|
308
|
+
description: Delete a client by client ID.
|
|
309
|
+
operationId: deleteClient
|
|
310
|
+
parameters:
|
|
311
|
+
- $ref: '#/components/parameters/clientId'
|
|
312
|
+
- $ref: '#/components/parameters/tenantId'
|
|
313
|
+
responses:
|
|
314
|
+
'204':
|
|
315
|
+
description: No content
|
|
316
|
+
'400':
|
|
317
|
+
description: Bad request
|
|
318
|
+
content:
|
|
319
|
+
application/json:
|
|
320
|
+
schema:
|
|
321
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
322
|
+
examples:
|
|
323
|
+
ClientRequestException400:
|
|
324
|
+
$ref: '#/components/examples/ClientRequestException400'
|
|
325
|
+
'401':
|
|
326
|
+
description: Unauthorized. Wrong tenant
|
|
327
|
+
content:
|
|
328
|
+
application/json:
|
|
329
|
+
schema:
|
|
330
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
331
|
+
examples:
|
|
332
|
+
ClientTenantException401:
|
|
333
|
+
$ref: '#/components/examples/ClientTenantException401'
|
|
334
|
+
'404':
|
|
335
|
+
description: Not found
|
|
336
|
+
content:
|
|
337
|
+
application/json:
|
|
338
|
+
schema:
|
|
339
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
340
|
+
examples:
|
|
341
|
+
ClientNotFoundException404:
|
|
342
|
+
$ref: '#/components/examples/ClientNotFoundException404'
|
|
343
|
+
security:
|
|
344
|
+
- BearerToken:
|
|
345
|
+
- SLAS_SERVICE_ADMIN
|
|
346
|
+
- SLAS_ORGANIZATION_ADMIN
|
|
347
|
+
/tenants/{tenantId}/clients/{clientId}/password-action-templates:
|
|
348
|
+
get:
|
|
349
|
+
summary: Retrieve/get a password action template.
|
|
350
|
+
description: Retrieve a password action template by client ID.
|
|
351
|
+
operationId: retrievePwdlessTemplate
|
|
352
|
+
parameters:
|
|
353
|
+
- $ref: '#/components/parameters/clientId'
|
|
354
|
+
- $ref: '#/components/parameters/tenantId'
|
|
355
|
+
- $ref: '#/components/parameters/channelId'
|
|
356
|
+
- $ref: '#/components/parameters/actionType'
|
|
357
|
+
- $ref: '#/components/parameters/templateType'
|
|
358
|
+
responses:
|
|
359
|
+
'200':
|
|
360
|
+
description: The password action template was retrieved successfully.
|
|
361
|
+
content:
|
|
362
|
+
application/json:
|
|
363
|
+
schema:
|
|
364
|
+
$ref: '#/components/schemas/PasswordActionTemplate'
|
|
365
|
+
examples:
|
|
366
|
+
PasswordActionTemplate:
|
|
367
|
+
$ref: '#/components/examples/PasswordActionTemplate'
|
|
368
|
+
'400':
|
|
369
|
+
description: Bad request
|
|
370
|
+
content:
|
|
371
|
+
application/json:
|
|
372
|
+
schema:
|
|
373
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
374
|
+
examples:
|
|
375
|
+
BadRequestException400:
|
|
376
|
+
$ref: '#/components/examples/BadRequestException400'
|
|
377
|
+
'401':
|
|
378
|
+
description: Unauthorized. Wrong tenant
|
|
379
|
+
content:
|
|
380
|
+
application/json:
|
|
381
|
+
schema:
|
|
382
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
383
|
+
examples:
|
|
384
|
+
ClientTenantException401:
|
|
385
|
+
$ref: '#/components/examples/ClientTenantException401'
|
|
386
|
+
'404':
|
|
387
|
+
description: Not found
|
|
388
|
+
content:
|
|
389
|
+
application/json:
|
|
390
|
+
schema:
|
|
391
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
392
|
+
examples:
|
|
393
|
+
PasswordActionTemplateNotFoundException404:
|
|
394
|
+
$ref: '#/components/examples/PasswordActionTemplateNotFoundException404'
|
|
395
|
+
security:
|
|
396
|
+
- BearerToken:
|
|
397
|
+
- SLAS_SERVICE_ADMIN
|
|
398
|
+
- SLAS_ORGANIZATION_ADMIN
|
|
399
|
+
put:
|
|
400
|
+
summary: Create or update a password action template.
|
|
401
|
+
description: Create or update a password action template by client ID.
|
|
402
|
+
operationId: registerPwdlessTemplate
|
|
403
|
+
parameters:
|
|
404
|
+
- $ref: '#/components/parameters/clientId'
|
|
405
|
+
- $ref: '#/components/parameters/tenantId'
|
|
406
|
+
requestBody:
|
|
407
|
+
content:
|
|
408
|
+
application/json:
|
|
409
|
+
schema:
|
|
410
|
+
$ref: '#/components/schemas/PasswordActionTemplate'
|
|
411
|
+
examples:
|
|
412
|
+
PasswordActionTemplateRequest:
|
|
413
|
+
$ref: '#/components/examples/PasswordActionTemplateRequest'
|
|
414
|
+
required: true
|
|
415
|
+
responses:
|
|
416
|
+
'200':
|
|
417
|
+
description: The password action template was updated successfully.
|
|
418
|
+
content:
|
|
419
|
+
application/json:
|
|
420
|
+
schema:
|
|
421
|
+
$ref: '#/components/schemas/PasswordActionTemplate'
|
|
422
|
+
examples:
|
|
423
|
+
PasswordActionTemplate:
|
|
424
|
+
$ref: '#/components/examples/PasswordActionTemplate'
|
|
425
|
+
'201':
|
|
426
|
+
description: A password action template was created successfully.
|
|
427
|
+
content:
|
|
428
|
+
application/json:
|
|
429
|
+
schema:
|
|
430
|
+
$ref: '#/components/schemas/PasswordActionTemplate'
|
|
431
|
+
examples:
|
|
432
|
+
PasswordActionTemplate:
|
|
433
|
+
$ref: '#/components/examples/PasswordActionTemplate'
|
|
434
|
+
'400':
|
|
435
|
+
description: Bad request
|
|
436
|
+
content:
|
|
437
|
+
application/json:
|
|
438
|
+
schema:
|
|
439
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
440
|
+
examples:
|
|
441
|
+
PasswordActionTemplateCreateException400:
|
|
442
|
+
$ref: '#/components/examples/PasswordActionTemplateCreateException400'
|
|
443
|
+
'401':
|
|
444
|
+
description: Unauthorized. Wrong tenant
|
|
445
|
+
content:
|
|
446
|
+
application/json:
|
|
447
|
+
schema:
|
|
448
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
449
|
+
examples:
|
|
450
|
+
ClientTenantException401:
|
|
451
|
+
$ref: '#/components/examples/ClientTenantException401'
|
|
452
|
+
'404':
|
|
453
|
+
description: Not found
|
|
454
|
+
content:
|
|
455
|
+
application/json:
|
|
456
|
+
schema:
|
|
457
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
458
|
+
examples:
|
|
459
|
+
PasswordActionTemplateNotFoundException404:
|
|
460
|
+
$ref: '#/components/examples/PasswordActionTemplateNotFoundException404'
|
|
461
|
+
security:
|
|
462
|
+
- BearerToken:
|
|
463
|
+
- SLAS_SERVICE_ADMIN
|
|
464
|
+
- SLAS_ORGANIZATION_ADMIN
|
|
465
|
+
delete:
|
|
466
|
+
summary: Delete a password action template.
|
|
467
|
+
operationId: deletePwdlessTemplate
|
|
468
|
+
description: Delete a password action template.
|
|
469
|
+
parameters:
|
|
470
|
+
- $ref: '#/components/parameters/clientId'
|
|
471
|
+
- $ref: '#/components/parameters/tenantId'
|
|
472
|
+
- $ref: '#/components/parameters/channelId'
|
|
473
|
+
- $ref: '#/components/parameters/actionType'
|
|
474
|
+
- $ref: '#/components/parameters/templateType'
|
|
475
|
+
- $ref: '#/components/parameters/locale'
|
|
476
|
+
responses:
|
|
477
|
+
'204':
|
|
478
|
+
description: No content
|
|
479
|
+
'400':
|
|
480
|
+
description: Bad request
|
|
481
|
+
content:
|
|
482
|
+
application/json:
|
|
483
|
+
schema:
|
|
484
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
485
|
+
examples:
|
|
486
|
+
PasswordActionTemplateDeleteException400:
|
|
487
|
+
$ref: '#/components/examples/PasswordActionTemplateDeleteException400'
|
|
488
|
+
'401':
|
|
489
|
+
description: Unauthorized. Wrong tenant
|
|
490
|
+
content:
|
|
491
|
+
application/json:
|
|
492
|
+
schema:
|
|
493
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
494
|
+
examples:
|
|
495
|
+
ClientTenantException401:
|
|
496
|
+
$ref: '#/components/examples/ClientTenantException401'
|
|
497
|
+
'404':
|
|
498
|
+
description: Not found
|
|
499
|
+
content:
|
|
500
|
+
application/json:
|
|
501
|
+
schema:
|
|
502
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
503
|
+
examples:
|
|
504
|
+
PasswordActionTemplateNotFoundException404:
|
|
505
|
+
$ref: '#/components/examples/PasswordActionTemplateNotFoundException404'
|
|
506
|
+
security:
|
|
507
|
+
- BearerToken:
|
|
508
|
+
- SLAS_SERVICE_ADMIN
|
|
509
|
+
- SLAS_ORGANIZATION_ADMIN
|
|
510
|
+
/tenants/{tenantId}/idps:
|
|
511
|
+
get:
|
|
512
|
+
summary: Retrieve/Get all tenant identity providers.
|
|
513
|
+
operationId: retrieveIdentityProviders
|
|
514
|
+
description: Retrieve a list of SLAS identity providers associated with the tenant_id.
|
|
515
|
+
parameters:
|
|
516
|
+
- $ref: '#/components/parameters/tenantId'
|
|
517
|
+
responses:
|
|
518
|
+
'200':
|
|
519
|
+
description: All tenant identity providers retrieved successfully.
|
|
520
|
+
content:
|
|
521
|
+
application/json:
|
|
522
|
+
schema:
|
|
523
|
+
$ref: '#/components/schemas/IdpListResponse'
|
|
524
|
+
examples:
|
|
525
|
+
IdpListResponse:
|
|
526
|
+
$ref: '#/components/examples/IdpListResponse'
|
|
527
|
+
'400':
|
|
528
|
+
description: Bad request
|
|
529
|
+
content:
|
|
530
|
+
application/json:
|
|
531
|
+
schema:
|
|
532
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
533
|
+
examples:
|
|
534
|
+
IdpRequestException400:
|
|
535
|
+
$ref: '#/components/examples/IdpRequestException400'
|
|
536
|
+
'401':
|
|
537
|
+
description: Unauthorized. Wrong tenant
|
|
538
|
+
content:
|
|
539
|
+
application/json:
|
|
540
|
+
schema:
|
|
541
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
542
|
+
examples:
|
|
543
|
+
IdpTenantException401:
|
|
544
|
+
$ref: '#/components/examples/IdpTenantException401'
|
|
545
|
+
'404':
|
|
546
|
+
description: Not found
|
|
547
|
+
content:
|
|
548
|
+
application/json:
|
|
549
|
+
schema:
|
|
550
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
551
|
+
examples:
|
|
552
|
+
IdpNotFoundException404:
|
|
553
|
+
$ref: '#/components/examples/IdpNotFoundException404'
|
|
554
|
+
security:
|
|
555
|
+
- BearerToken:
|
|
556
|
+
- SLAS_SERVICE_ADMIN
|
|
557
|
+
/tenants/{tenantId}/idps/{name}:
|
|
558
|
+
get:
|
|
559
|
+
summary: Retrieve/Get a specific identity provider.
|
|
560
|
+
operationId: retrieveIdentityProvider
|
|
561
|
+
description: Retrieve a specific identity provider by name.
|
|
562
|
+
parameters:
|
|
563
|
+
- $ref: '#/components/parameters/name'
|
|
564
|
+
- $ref: '#/components/parameters/tenantId'
|
|
565
|
+
responses:
|
|
566
|
+
'200':
|
|
567
|
+
description: The identity provider was retrieved successfully.
|
|
568
|
+
content:
|
|
569
|
+
application/json:
|
|
570
|
+
schema:
|
|
571
|
+
$ref: '#/components/schemas/IdentityProvider'
|
|
572
|
+
examples:
|
|
573
|
+
IdentityProvider:
|
|
574
|
+
$ref: '#/components/examples/IdentityProvider'
|
|
575
|
+
'400':
|
|
576
|
+
description: Bad request
|
|
577
|
+
content:
|
|
578
|
+
application/json:
|
|
579
|
+
schema:
|
|
580
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
581
|
+
examples:
|
|
582
|
+
IdpRequestException400:
|
|
583
|
+
$ref: '#/components/examples/IdpRequestException400'
|
|
584
|
+
'401':
|
|
585
|
+
description: Unauthorized. Wrong tenant
|
|
586
|
+
content:
|
|
587
|
+
application/json:
|
|
588
|
+
schema:
|
|
589
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
590
|
+
examples:
|
|
591
|
+
IdpTenantException401:
|
|
592
|
+
$ref: '#/components/examples/IdpTenantException401'
|
|
593
|
+
'404':
|
|
594
|
+
description: Not found
|
|
595
|
+
content:
|
|
596
|
+
application/json:
|
|
597
|
+
schema:
|
|
598
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
599
|
+
examples:
|
|
600
|
+
IdpNotFoundException404:
|
|
601
|
+
$ref: '#/components/examples/IdpNotFoundException404'
|
|
602
|
+
security:
|
|
603
|
+
- BearerToken:
|
|
604
|
+
- SLAS_SERVICE_ADMIN
|
|
605
|
+
- SLAS_ORGANIZATION_ADMIN
|
|
606
|
+
put:
|
|
607
|
+
summary: Create or update an identity provider.
|
|
608
|
+
operationId: registerIdentityProvider
|
|
609
|
+
description: Create or update an identity provider by name.
|
|
610
|
+
parameters:
|
|
611
|
+
- $ref: '#/components/parameters/name'
|
|
612
|
+
- $ref: '#/components/parameters/tenantId'
|
|
613
|
+
requestBody:
|
|
614
|
+
content:
|
|
615
|
+
application/json:
|
|
616
|
+
schema:
|
|
617
|
+
$ref: '#/components/schemas/IdentityProvider'
|
|
618
|
+
examples:
|
|
619
|
+
IdentityProvider:
|
|
620
|
+
$ref: '#/components/examples/IdentityProvider'
|
|
621
|
+
required: true
|
|
622
|
+
responses:
|
|
623
|
+
'200':
|
|
624
|
+
description: The identity provider was updated successfully.
|
|
625
|
+
content:
|
|
626
|
+
application/json:
|
|
627
|
+
schema:
|
|
628
|
+
$ref: '#/components/schemas/IdentityProviderResponse'
|
|
629
|
+
examples:
|
|
630
|
+
IdpProviderResponse:
|
|
631
|
+
$ref: '#/components/examples/IdpProviderResponse'
|
|
632
|
+
'201':
|
|
633
|
+
description: The identity provider was created successfully.
|
|
634
|
+
content:
|
|
635
|
+
application/json:
|
|
636
|
+
schema:
|
|
637
|
+
$ref: '#/components/schemas/IdentityProviderResponse'
|
|
638
|
+
examples:
|
|
639
|
+
IdpProviderResponse:
|
|
640
|
+
$ref: '#/components/examples/IdpProviderResponse'
|
|
641
|
+
'400':
|
|
642
|
+
description: Bad request
|
|
643
|
+
content:
|
|
644
|
+
application/json:
|
|
645
|
+
schema:
|
|
646
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
647
|
+
examples:
|
|
648
|
+
IdpRequestException400:
|
|
649
|
+
$ref: '#/components/examples/IdpRequestException400'
|
|
650
|
+
'401':
|
|
651
|
+
description: Unauthorized. Wrong tenant
|
|
652
|
+
content:
|
|
653
|
+
application/json:
|
|
654
|
+
schema:
|
|
655
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
656
|
+
examples:
|
|
657
|
+
IdpTenantException401:
|
|
658
|
+
$ref: '#/components/examples/IdpTenantException401'
|
|
659
|
+
'404':
|
|
660
|
+
description: Not found
|
|
661
|
+
content:
|
|
662
|
+
application/json:
|
|
663
|
+
schema:
|
|
664
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
665
|
+
examples:
|
|
666
|
+
IdpNotFoundException404:
|
|
667
|
+
$ref: '#/components/examples/IdpNotFoundException404'
|
|
668
|
+
'409':
|
|
669
|
+
description: Conflict. Duplicate
|
|
670
|
+
content:
|
|
671
|
+
application/json:
|
|
672
|
+
schema:
|
|
673
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
674
|
+
examples:
|
|
675
|
+
IdpConflictException409:
|
|
676
|
+
$ref: '#/components/examples/IdpConflictException409'
|
|
677
|
+
security:
|
|
678
|
+
- BearerToken:
|
|
679
|
+
- SLAS_SERVICE_ADMIN
|
|
680
|
+
- SLAS_ORGANIZATION_ADMIN
|
|
681
|
+
delete:
|
|
682
|
+
summary: Delete an identity provider.
|
|
683
|
+
operationId: deleteIdentityProvider
|
|
684
|
+
description: Delete an identity provider by name.
|
|
685
|
+
parameters:
|
|
686
|
+
- $ref: '#/components/parameters/name'
|
|
687
|
+
- $ref: '#/components/parameters/tenantId'
|
|
688
|
+
responses:
|
|
689
|
+
'204':
|
|
690
|
+
description: No content
|
|
691
|
+
'400':
|
|
692
|
+
description: Bad request
|
|
693
|
+
content:
|
|
694
|
+
application/json:
|
|
695
|
+
schema:
|
|
696
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
697
|
+
examples:
|
|
698
|
+
IdpRequestException400:
|
|
699
|
+
$ref: '#/components/examples/IdpRequestException400'
|
|
700
|
+
'401':
|
|
701
|
+
description: Unauthorized. Wrong tenant
|
|
702
|
+
content:
|
|
703
|
+
application/json:
|
|
704
|
+
schema:
|
|
705
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
706
|
+
examples:
|
|
707
|
+
IdpTenantException401:
|
|
708
|
+
$ref: '#/components/examples/IdpTenantException401'
|
|
709
|
+
'404':
|
|
710
|
+
description: Not found
|
|
711
|
+
content:
|
|
712
|
+
application/json:
|
|
713
|
+
schema:
|
|
714
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
715
|
+
examples:
|
|
716
|
+
IdpNotFoundException404:
|
|
717
|
+
$ref: '#/components/examples/IdpNotFoundException404'
|
|
718
|
+
security:
|
|
719
|
+
- BearerToken:
|
|
720
|
+
- SLAS_SERVICE_ADMIN
|
|
721
|
+
- SLAS_ORGANIZATION_ADMIN
|
|
722
|
+
/tenants/{tenantId}/customers/{customerId}:
|
|
723
|
+
delete:
|
|
724
|
+
summary: Delete all shopper records associated with a shopper's customer ID. The email ID is used if it's passed as a query parameter. This conforms to the GDPR regulations.
|
|
725
|
+
operationId: deleteShopper
|
|
726
|
+
description: Delete all shopper records associated with a shopper's customer ID. The email ID is used if it's passed as a query parameter. This conforms to the GDPR regulations.
|
|
727
|
+
parameters:
|
|
728
|
+
- $ref: '#/components/parameters/customerId'
|
|
729
|
+
- $ref: '#/components/parameters/tenantId'
|
|
730
|
+
- $ref: '#/components/parameters/emailAddress'
|
|
731
|
+
responses:
|
|
732
|
+
'204':
|
|
733
|
+
description: No content
|
|
734
|
+
'400':
|
|
735
|
+
description: Bad request
|
|
736
|
+
content:
|
|
737
|
+
application/json:
|
|
738
|
+
schema:
|
|
739
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
740
|
+
examples:
|
|
741
|
+
ShopperDeleteException:
|
|
742
|
+
$ref: '#/components/examples/ShopperDeleteException400'
|
|
743
|
+
'404':
|
|
744
|
+
description: Not found
|
|
745
|
+
content:
|
|
746
|
+
application/json:
|
|
747
|
+
schema:
|
|
748
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
749
|
+
examples:
|
|
750
|
+
ShopperNotFoundException:
|
|
751
|
+
$ref: '#/components/examples/ShopperNotFoundException404'
|
|
752
|
+
security:
|
|
753
|
+
- BearerToken:
|
|
754
|
+
- SLAS_SERVICE_ADMIN
|
|
755
|
+
- SLAS_ORGANIZATION_ADMIN
|
|
756
|
+
components:
|
|
757
|
+
securitySchemes:
|
|
758
|
+
BearerToken:
|
|
759
|
+
type: http
|
|
760
|
+
scheme: bearer
|
|
761
|
+
bearerFormat: JWT
|
|
762
|
+
description: A security scheme that supplements SLAS Administration APIs that are secured with an B2c Commerce Account Manager JWT. This security scheme expects a valid B2C Commerce Account Manager Bearer token passed in the Authorization header to permit API access.
|
|
763
|
+
parameters:
|
|
764
|
+
tenantId:
|
|
765
|
+
name: tenantId
|
|
766
|
+
in: path
|
|
767
|
+
required: true
|
|
768
|
+
schema:
|
|
769
|
+
maxLength: 32
|
|
770
|
+
type: string
|
|
771
|
+
example: zzeu_001, bgvn_dev
|
|
772
|
+
clientId:
|
|
773
|
+
name: clientId
|
|
774
|
+
in: path
|
|
775
|
+
required: true
|
|
776
|
+
schema:
|
|
777
|
+
maxLength: 36
|
|
778
|
+
type: string
|
|
779
|
+
example: 876aff68-6ee5-474f-932d-c90c1d79bcf7
|
|
780
|
+
channelId:
|
|
781
|
+
name: channelId
|
|
782
|
+
in: query
|
|
783
|
+
required: true
|
|
784
|
+
schema:
|
|
785
|
+
maxLength: 100
|
|
786
|
+
type: string
|
|
787
|
+
example: SiteGenesis
|
|
788
|
+
actionType:
|
|
789
|
+
name: actionType
|
|
790
|
+
in: query
|
|
791
|
+
required: true
|
|
792
|
+
schema:
|
|
793
|
+
maxLength: 36
|
|
794
|
+
type: string
|
|
795
|
+
description: "Describes the type of action that the password action template will be used for. \nHere are the actions that each enumerated string refers to:\n - `PWDLESS_LOGIN`: Passwordless login\n - `PWD_RESET_ACTION`: Password reset\n - `PWD_FORGOT_ACTION`: Forgot password\""
|
|
796
|
+
enum:
|
|
797
|
+
- PWDLESS_LOGIN
|
|
798
|
+
- PWD_RESET_ACTION
|
|
799
|
+
- PWD_FORGOT_ACTION
|
|
800
|
+
example: PWDLESS_LOGIN
|
|
801
|
+
templateType:
|
|
802
|
+
name: templateType
|
|
803
|
+
in: query
|
|
804
|
+
required: true
|
|
805
|
+
schema:
|
|
806
|
+
maxLength: 8
|
|
807
|
+
type: string
|
|
808
|
+
enum:
|
|
809
|
+
- EMAIL
|
|
810
|
+
- SMS
|
|
811
|
+
example: EMAIL
|
|
812
|
+
locale:
|
|
813
|
+
name: locale
|
|
814
|
+
in: query
|
|
815
|
+
required: true
|
|
816
|
+
schema:
|
|
817
|
+
type: string
|
|
818
|
+
pattern: ^[a-z][a-z]-[A-Z][A-Z]$
|
|
819
|
+
example: en-US
|
|
820
|
+
name:
|
|
821
|
+
name: name
|
|
822
|
+
in: path
|
|
823
|
+
required: true
|
|
824
|
+
schema:
|
|
825
|
+
maxLength: 256
|
|
826
|
+
type: string
|
|
827
|
+
example: Name
|
|
828
|
+
customerId:
|
|
829
|
+
name: customerId
|
|
830
|
+
in: path
|
|
831
|
+
required: true
|
|
832
|
+
schema:
|
|
833
|
+
maxLength: 28
|
|
834
|
+
type: string
|
|
835
|
+
example: bcJN7998472pLiZuyGabs8knlj
|
|
836
|
+
emailAddress:
|
|
837
|
+
name: emailAddress
|
|
838
|
+
in: query
|
|
839
|
+
description: The shoppers email address.
|
|
840
|
+
required: false
|
|
841
|
+
schema:
|
|
842
|
+
maxLength: 256
|
|
843
|
+
type: string
|
|
844
|
+
example: joe.shopper@foo.org
|
|
845
|
+
schemas:
|
|
846
|
+
Tenant:
|
|
847
|
+
required:
|
|
848
|
+
- contact
|
|
849
|
+
- description
|
|
850
|
+
- emailAddress
|
|
851
|
+
- isDeleted
|
|
852
|
+
- merchantId
|
|
853
|
+
- phoneNo
|
|
854
|
+
- requestQuotaPerMinute
|
|
855
|
+
- status
|
|
856
|
+
- tenantId
|
|
857
|
+
- tier
|
|
858
|
+
type: object
|
|
859
|
+
properties:
|
|
860
|
+
tenantId:
|
|
861
|
+
maxLength: 8
|
|
862
|
+
type: string
|
|
863
|
+
example: aaaa_prd
|
|
864
|
+
merchantId:
|
|
865
|
+
minimum: 0
|
|
866
|
+
type: integer
|
|
867
|
+
example: 1
|
|
868
|
+
description:
|
|
869
|
+
maxLength: 256
|
|
870
|
+
type: string
|
|
871
|
+
example: SLAS Merchant Name
|
|
872
|
+
contact:
|
|
873
|
+
maxLength: 256
|
|
874
|
+
type: string
|
|
875
|
+
example: SLAS Tenant Contact
|
|
876
|
+
emailAddress:
|
|
877
|
+
maxLength: 200
|
|
878
|
+
type: string
|
|
879
|
+
example: tenant_contact@slas.tst
|
|
880
|
+
phoneNo:
|
|
881
|
+
maxLength: 50
|
|
882
|
+
type: string
|
|
883
|
+
example: 000-000-0000
|
|
884
|
+
isDeleted:
|
|
885
|
+
maxLength: 1
|
|
886
|
+
type: boolean
|
|
887
|
+
example: false
|
|
888
|
+
status:
|
|
889
|
+
maxLength: 16
|
|
890
|
+
type: string
|
|
891
|
+
example: CLEAR
|
|
892
|
+
tier:
|
|
893
|
+
type: string
|
|
894
|
+
description: |
|
|
895
|
+
This read only value relates to the B2C Comerce realm of the customer.
|
|
896
|
+
- XS = Bronze and Bronze+
|
|
897
|
+
- S = Silver and Silver+
|
|
898
|
+
- M = Gold and Gold+
|
|
899
|
+
- L = Platinum and Platinum+
|
|
900
|
+
enum:
|
|
901
|
+
- XS
|
|
902
|
+
- S
|
|
903
|
+
- M
|
|
904
|
+
- L
|
|
905
|
+
example: L
|
|
906
|
+
requestQuotaPerMinute:
|
|
907
|
+
type: number
|
|
908
|
+
description: This read only value shows the the number of requests that can be made per minute.
|
|
909
|
+
example: 8000
|
|
910
|
+
description: Tenant
|
|
911
|
+
additionalProperties: true
|
|
912
|
+
ErrorResponse:
|
|
913
|
+
type: object
|
|
914
|
+
additionalProperties: true
|
|
915
|
+
properties:
|
|
916
|
+
title:
|
|
917
|
+
description: "A short, human-readable summary of the problem\ntype. It will not change from occurrence to occurrence of the \nproblem, except for purposes of localization\n"
|
|
918
|
+
type: string
|
|
919
|
+
maxLength: 256
|
|
920
|
+
example: You do not have enough credit
|
|
921
|
+
type:
|
|
922
|
+
description: |
|
|
923
|
+
A URI reference [RFC3986] that identifies the
|
|
924
|
+
problem type. This specification encourages that, when
|
|
925
|
+
dereferenced, it provide human-readable documentation for the
|
|
926
|
+
problem type (e.g., using HTML [W3C.REC-html5-20141028]). When
|
|
927
|
+
this member is not present, its value is assumed to be
|
|
928
|
+
"about:blank". It accepts relative URIs; this means
|
|
929
|
+
that they must be resolved relative to the document's base URI, as
|
|
930
|
+
per [RFC3986], Section 5.
|
|
931
|
+
type: string
|
|
932
|
+
maxLength: 2048
|
|
933
|
+
example: NotEnoughMoney
|
|
934
|
+
detail:
|
|
935
|
+
description: A human-readable explanation specific to this occurrence of the problem.
|
|
936
|
+
type: string
|
|
937
|
+
example: Your current balance is 30, but that costs 50
|
|
938
|
+
instance:
|
|
939
|
+
description: |
|
|
940
|
+
A URI reference that identifies the specific
|
|
941
|
+
occurrence of the problem. It may or may not yield further
|
|
942
|
+
information if dereferenced. It accepts relative URIs; this means
|
|
943
|
+
that they must be resolved relative to the document's base URI, as
|
|
944
|
+
per [RFC3986], Section 5.
|
|
945
|
+
type: string
|
|
946
|
+
maxLength: 2048
|
|
947
|
+
example: /account/12345/msgs/abc
|
|
948
|
+
required:
|
|
949
|
+
- title
|
|
950
|
+
- type
|
|
951
|
+
- detail
|
|
952
|
+
TenantDto:
|
|
953
|
+
required:
|
|
954
|
+
- tenantId
|
|
955
|
+
- contact
|
|
956
|
+
- description
|
|
957
|
+
- emailAddress
|
|
958
|
+
- merchantName
|
|
959
|
+
- phoneNo
|
|
960
|
+
type: object
|
|
961
|
+
properties:
|
|
962
|
+
tenantId:
|
|
963
|
+
maxLength: 8
|
|
964
|
+
type: string
|
|
965
|
+
example: aaaa_prd
|
|
966
|
+
merchantName:
|
|
967
|
+
maxLength: 256
|
|
968
|
+
type: string
|
|
969
|
+
description: Name of the merchant.
|
|
970
|
+
example: Merchant Name
|
|
971
|
+
description:
|
|
972
|
+
maxLength: 256
|
|
973
|
+
type: string
|
|
974
|
+
example: Additional information about the tenant.
|
|
975
|
+
contact:
|
|
976
|
+
maxLength: 256
|
|
977
|
+
type: string
|
|
978
|
+
example: Name of the merchant's designated contact.
|
|
979
|
+
emailAddress:
|
|
980
|
+
maxLength: 200
|
|
981
|
+
type: string
|
|
982
|
+
description: Email address of the designated contact.
|
|
983
|
+
example: joe.shopper@foo.org
|
|
984
|
+
phoneNo:
|
|
985
|
+
maxLength: 50
|
|
986
|
+
type: string
|
|
987
|
+
description: Phone number of the designated contact.
|
|
988
|
+
example: +1 000-000-0000
|
|
989
|
+
description: Create or update tenants
|
|
990
|
+
Client:
|
|
991
|
+
required:
|
|
992
|
+
- callbackUri
|
|
993
|
+
- channels
|
|
994
|
+
- clientId
|
|
995
|
+
- name
|
|
996
|
+
- redirectUri
|
|
997
|
+
- scopes
|
|
998
|
+
- secret
|
|
999
|
+
type: object
|
|
1000
|
+
properties:
|
|
1001
|
+
clientId:
|
|
1002
|
+
type: string
|
|
1003
|
+
maxLength: 100
|
|
1004
|
+
description: Client ID
|
|
1005
|
+
example: fd0d4ab9-bb85-4c04-bebd-589bd74bdd75
|
|
1006
|
+
name:
|
|
1007
|
+
type: string
|
|
1008
|
+
maxLength: 100
|
|
1009
|
+
description: Client Name
|
|
1010
|
+
example: Client Name
|
|
1011
|
+
secret:
|
|
1012
|
+
type: string
|
|
1013
|
+
maxLength: 256
|
|
1014
|
+
description: Client Secret. The secret will only display on create and if the secret was updated when updating the client.
|
|
1015
|
+
example: client-secret
|
|
1016
|
+
scopes:
|
|
1017
|
+
items:
|
|
1018
|
+
type: string
|
|
1019
|
+
maxLength: 100
|
|
1020
|
+
example: sfcc.products sfcc.catalogs sfcc.customers:ro
|
|
1021
|
+
type: array
|
|
1022
|
+
description: "Merchant scopes. These scopes allows different permissions in SLAS and B2C commerce. \nShopper Custom Objects additionally provides a way to do granular scoping besides the standard `sfcc.shopper-custom-objects` like `sfcc.shopper-custom-objects.xyz`\nSLAS is capable of handling a maximum of 20 Custom Object scopes.\n\nFor B2C Commerce scope details, see the [Authorization Scopes Catalog](https://developer.salesforce.com/docs/commerce/commerce-api/guide/auth-z-scope-catalog.html).\""
|
|
1023
|
+
example:
|
|
1024
|
+
- sfcc.products
|
|
1025
|
+
- sfcc.catalogs
|
|
1026
|
+
- sfcc.customers:ro
|
|
1027
|
+
redirectUri:
|
|
1028
|
+
type: string
|
|
1029
|
+
maxLength: 2048
|
|
1030
|
+
description: An absolute URL, beginning with a protocol
|
|
1031
|
+
example: https://www.salesforce.com
|
|
1032
|
+
callbackUri:
|
|
1033
|
+
type: string
|
|
1034
|
+
maxLength: 2048
|
|
1035
|
+
description: An absolute URL, beginning with a protocol
|
|
1036
|
+
example: https://www.salesforce.com
|
|
1037
|
+
channels:
|
|
1038
|
+
items:
|
|
1039
|
+
type: string
|
|
1040
|
+
example: RefArch SiteGenesis
|
|
1041
|
+
maxLength: 1024
|
|
1042
|
+
type: array
|
|
1043
|
+
description: Client Channels
|
|
1044
|
+
example:
|
|
1045
|
+
- RefArch
|
|
1046
|
+
- SiteGenensis
|
|
1047
|
+
isPrivateClient:
|
|
1048
|
+
type: boolean
|
|
1049
|
+
description: Private or Public Client
|
|
1050
|
+
example: true
|
|
1051
|
+
loginEpRestrict:
|
|
1052
|
+
type: boolean
|
|
1053
|
+
maxLength: 1
|
|
1054
|
+
description: When enabling (true) this will restrict all calls to the `\login` endpoint for the Client Id. When calling the `\login` endpoint and `loginEpRestrict` is enabled a HTTP Status code of 403 will be returned.
|
|
1055
|
+
example: false
|
|
1056
|
+
ClientListResponse:
|
|
1057
|
+
required:
|
|
1058
|
+
- data
|
|
1059
|
+
type: object
|
|
1060
|
+
properties:
|
|
1061
|
+
data:
|
|
1062
|
+
items:
|
|
1063
|
+
$ref: '#/components/schemas/Client'
|
|
1064
|
+
type: array
|
|
1065
|
+
description: An array of clients.
|
|
1066
|
+
ClientRequest:
|
|
1067
|
+
required:
|
|
1068
|
+
- channels
|
|
1069
|
+
- clientId
|
|
1070
|
+
- isPrivateClient
|
|
1071
|
+
- name
|
|
1072
|
+
- redirectUri
|
|
1073
|
+
- scopes
|
|
1074
|
+
- secret
|
|
1075
|
+
type: object
|
|
1076
|
+
properties:
|
|
1077
|
+
name:
|
|
1078
|
+
type: string
|
|
1079
|
+
description: Client Name
|
|
1080
|
+
example: High Adventure Wear
|
|
1081
|
+
maxLength: 100
|
|
1082
|
+
clientId:
|
|
1083
|
+
type: string
|
|
1084
|
+
description: SLAS client id. Must match the query parameter.
|
|
1085
|
+
example: fd0d4ab9-bb85-4c04-bebd-589bd74bdd75
|
|
1086
|
+
maxLength: 100
|
|
1087
|
+
secret:
|
|
1088
|
+
type: string
|
|
1089
|
+
description: SLAS client secret. On create if left blank then a secret will be generated.
|
|
1090
|
+
example: client_secret
|
|
1091
|
+
maxLength: 256
|
|
1092
|
+
scopes:
|
|
1093
|
+
items:
|
|
1094
|
+
type: string
|
|
1095
|
+
example: sfcc.products sfcc.catalogs sfcc.customers:ro
|
|
1096
|
+
maxLength: 4096
|
|
1097
|
+
type: array
|
|
1098
|
+
description: "Merchant scopes. These scopes allows different permissions in SLAS and B2C commerce. \nShopper Custom Objects additionally provides a way to do granular scoping besides the standard `sfcc.shopper-custom-objects` like `sfcc.shopper-custom-objects.xyz` \nSLAS is capable of handling a maximum of 20 Custom Object scopes.\""
|
|
1099
|
+
example:
|
|
1100
|
+
- sfcc.products
|
|
1101
|
+
- sfcc.catalogs
|
|
1102
|
+
- sfcc.customers:ro
|
|
1103
|
+
redirectUri:
|
|
1104
|
+
items:
|
|
1105
|
+
type: string
|
|
1106
|
+
example: http://localhost:3000/callback
|
|
1107
|
+
maxLength: 2048
|
|
1108
|
+
type: array
|
|
1109
|
+
description: Array of SLAS redirect URLs. Include protocol and domain name in each URL. Wildcards supported.
|
|
1110
|
+
example:
|
|
1111
|
+
- http://localhost:3000/callback
|
|
1112
|
+
- https://*.example.com/callback
|
|
1113
|
+
callbackUri:
|
|
1114
|
+
items:
|
|
1115
|
+
type: string
|
|
1116
|
+
example: localhost:3000/passwordless-login-callback
|
|
1117
|
+
maxLength: 2048
|
|
1118
|
+
type: array
|
|
1119
|
+
description: Array of SLAS callback URLs that will be used for passworless login and password reset when mode=callback. Include protocol and domain name in each URL. Wildcards are NOT supported.
|
|
1120
|
+
example:
|
|
1121
|
+
- http://localhost:3000/password-reset-callback
|
|
1122
|
+
- http://localhost:3000/passwordless-login-callback
|
|
1123
|
+
channels:
|
|
1124
|
+
items:
|
|
1125
|
+
type: string
|
|
1126
|
+
example: RefArch SiteGenesis
|
|
1127
|
+
maxLength: 1024
|
|
1128
|
+
type: array
|
|
1129
|
+
description: Client Channels
|
|
1130
|
+
example:
|
|
1131
|
+
- RefArch
|
|
1132
|
+
- SiteGenensis
|
|
1133
|
+
isPrivateClient:
|
|
1134
|
+
type: boolean
|
|
1135
|
+
description: Private or Public Client. If left blank the client will default to private.
|
|
1136
|
+
example: true
|
|
1137
|
+
loginEpRestrict:
|
|
1138
|
+
type: boolean
|
|
1139
|
+
description: When enabling (true) this will restrict all calls to the `\login` endpoint for the Client Id. When calling the `\login` endpoint and `loginEpRestrict` is enabled a HTTP Status code of 403 will be returned.
|
|
1140
|
+
example: false
|
|
1141
|
+
description: Used to create and update a SLAS Client
|
|
1142
|
+
PasswordTemplateActionType:
|
|
1143
|
+
type: string
|
|
1144
|
+
description: "Describes the type of action that the password action template will be used for. \nHere are the actions that each enumerated string refers to:\n - `PWDLESS_LOGIN`: Passwordless login\n - `PWD_RESET_ACTION`: Password reset\n - `PWD_FORGOT_ACTION`: Forgot password"
|
|
1145
|
+
enum:
|
|
1146
|
+
- PWDLESS_LOGIN
|
|
1147
|
+
- PWD_RESET_ACTION
|
|
1148
|
+
- PWD_FORGOT_ACTION
|
|
1149
|
+
example: PWDLESS_LOGIN
|
|
1150
|
+
PasswordTemplateType:
|
|
1151
|
+
type: string
|
|
1152
|
+
description: Identifies the type of mode that the password action template will be used for.
|
|
1153
|
+
enum:
|
|
1154
|
+
- SMS
|
|
1155
|
+
- EMAIL
|
|
1156
|
+
example: EMAIL
|
|
1157
|
+
PasswordActionTemplate:
|
|
1158
|
+
required:
|
|
1159
|
+
- actionType
|
|
1160
|
+
- channelId
|
|
1161
|
+
- link
|
|
1162
|
+
- locale
|
|
1163
|
+
- name
|
|
1164
|
+
- subject
|
|
1165
|
+
- template
|
|
1166
|
+
- templateType
|
|
1167
|
+
type: object
|
|
1168
|
+
properties:
|
|
1169
|
+
channelId:
|
|
1170
|
+
maxLength: 36
|
|
1171
|
+
type: string
|
|
1172
|
+
example: SiteGenesis
|
|
1173
|
+
name:
|
|
1174
|
+
maxLength: 128
|
|
1175
|
+
type: string
|
|
1176
|
+
example: Password Action Email Template
|
|
1177
|
+
subject:
|
|
1178
|
+
maxLength: 128
|
|
1179
|
+
type: string
|
|
1180
|
+
example: Password Action Token Request
|
|
1181
|
+
link:
|
|
1182
|
+
maxLength: 2048
|
|
1183
|
+
type: string
|
|
1184
|
+
example: 'This is your password action token: ${token}'
|
|
1185
|
+
locale:
|
|
1186
|
+
maxLength: 16
|
|
1187
|
+
type: string
|
|
1188
|
+
description: Identifies the locale of the template. Must be one of the [language tag strings supported by JDK 11](https://www.oracle.com/java/technologies/javase/jdk11-suported-locales.html). The string is stored in all lowercase.
|
|
1189
|
+
example: en-us
|
|
1190
|
+
actionType:
|
|
1191
|
+
$ref: '#/components/schemas/PasswordTemplateActionType'
|
|
1192
|
+
templateType:
|
|
1193
|
+
$ref: '#/components/schemas/PasswordTemplateType'
|
|
1194
|
+
template:
|
|
1195
|
+
maxLength: 2048
|
|
1196
|
+
type: string
|
|
1197
|
+
example: |-
|
|
1198
|
+
Passwordless Login Token Request
|
|
1199
|
+
You're receiving this because you requested a passwordless login token for your account. ${link}
|
|
1200
|
+
IdentityProviderResponse:
|
|
1201
|
+
required:
|
|
1202
|
+
- authUrl
|
|
1203
|
+
- clientId
|
|
1204
|
+
- clientSecret
|
|
1205
|
+
- isClientCredsBody
|
|
1206
|
+
- isPreferred
|
|
1207
|
+
- name
|
|
1208
|
+
- redirectUrl
|
|
1209
|
+
- scopes
|
|
1210
|
+
- tokenInfoUrl
|
|
1211
|
+
- tokenUrl
|
|
1212
|
+
- userInfoUrl
|
|
1213
|
+
type: object
|
|
1214
|
+
description: Identity provider Response
|
|
1215
|
+
properties:
|
|
1216
|
+
name:
|
|
1217
|
+
type: string
|
|
1218
|
+
description: Identity Provider Name
|
|
1219
|
+
maxLength: 200
|
|
1220
|
+
example: google
|
|
1221
|
+
authUrl:
|
|
1222
|
+
type: string
|
|
1223
|
+
description: IDP authorization URL
|
|
1224
|
+
maxLength: 256
|
|
1225
|
+
example: https://www.salesforce.com/authorize
|
|
1226
|
+
tokenUrl:
|
|
1227
|
+
type: string
|
|
1228
|
+
description: IDP token URL
|
|
1229
|
+
maxLength: 256
|
|
1230
|
+
example: https://www.salesforce.com/token
|
|
1231
|
+
tokenInfoUrl:
|
|
1232
|
+
type: string
|
|
1233
|
+
description: IDP token info URL
|
|
1234
|
+
maxLength: 256
|
|
1235
|
+
example: https://www.salesforce.com/inspect
|
|
1236
|
+
userInfoUrl:
|
|
1237
|
+
type: string
|
|
1238
|
+
description: IDP user info URL
|
|
1239
|
+
maxLength: 256
|
|
1240
|
+
example: https://www.salesforce.com/userinfo
|
|
1241
|
+
redirectUrl:
|
|
1242
|
+
type: string
|
|
1243
|
+
description: Redirect URL to go to after IDP flow is complete. This URL must be registered with the IDP.
|
|
1244
|
+
maxLength: 256
|
|
1245
|
+
example: https://www.salesforce.com/idp/callback
|
|
1246
|
+
wellKnownUrl:
|
|
1247
|
+
type: string
|
|
1248
|
+
description: IDP to get OIDC configuration.
|
|
1249
|
+
maxLength: 256
|
|
1250
|
+
example: https://www.salesforce.com/.well-known/openid-configuration
|
|
1251
|
+
clientId:
|
|
1252
|
+
type: string
|
|
1253
|
+
description: Client Id of the third party IDP.
|
|
1254
|
+
maxLength: 128
|
|
1255
|
+
example: 934277749308-02dg4398n3s31ofge8cot46jirn3kpkf.apps.googleusercontent.com
|
|
1256
|
+
clientSecret:
|
|
1257
|
+
type: string
|
|
1258
|
+
description: Client Secret of the third party IDP. For Apple copy the contents from the .p8 file that was downloaded from Apple between -*----BEGIN PRIVATE KEY-----* and -*---END PRIVATE KEY-----* markers.
|
|
1259
|
+
maxLength: 512
|
|
1260
|
+
example: aKZM1xEnZopNP2bm2gc3GKex
|
|
1261
|
+
isPreferred:
|
|
1262
|
+
type: boolean
|
|
1263
|
+
description: Indicates if the IDP configuration is the Preferred SLAS IDP for the Tenant Id.
|
|
1264
|
+
maxLength: 1
|
|
1265
|
+
example: true
|
|
1266
|
+
isClientCredsBody:
|
|
1267
|
+
type: boolean
|
|
1268
|
+
description: Default is to place the client credentials in a basic authorization header for the call to the IDP. If true, the client credentials are placed in the POST body to the IDP.
|
|
1269
|
+
maxLength: 1
|
|
1270
|
+
example: false
|
|
1271
|
+
scopes:
|
|
1272
|
+
type: array
|
|
1273
|
+
items:
|
|
1274
|
+
type: string
|
|
1275
|
+
maxLength: 8192
|
|
1276
|
+
example: openid email profile
|
|
1277
|
+
description: Scopes needed by the IDP.
|
|
1278
|
+
example:
|
|
1279
|
+
- oidc
|
|
1280
|
+
- email
|
|
1281
|
+
- profile
|
|
1282
|
+
teamId:
|
|
1283
|
+
type: string
|
|
1284
|
+
description: Apple Team ID. Used primarily for Sign with Apple in generating the client secret.
|
|
1285
|
+
maxLength: 32
|
|
1286
|
+
example: appleTeamId
|
|
1287
|
+
keyId:
|
|
1288
|
+
type: string
|
|
1289
|
+
description: Apple key ID. This is the Key ID that was obtained from Apple when the the private key for client authentication was created. Used primarily for Sign with Apple in generating the client secret.
|
|
1290
|
+
maxLength: 8192
|
|
1291
|
+
example: appleKeyId
|
|
1292
|
+
loginMergeClaims:
|
|
1293
|
+
items:
|
|
1294
|
+
type: string
|
|
1295
|
+
maxLength: 256
|
|
1296
|
+
example: email
|
|
1297
|
+
type: array
|
|
1298
|
+
description: |
|
|
1299
|
+
List of user info claims that can be used as identifiers to look up and merge with an existing B2C Commerce profile for a registered shopper or an existing B2C Commerce profile created via federated login with an external Identity Provider with the same merge claim as this one. If multiple matching B2C Commerce shopper (customer) profiles are found, the external profile is merged with the most recently created shopper (customer) profile. Refer to the Merge Shopper Profiles user guide for more details.
|
|
1300
|
+
|
|
1301
|
+
Note: When configuring an Apple IDP, 'email' and 'sub' are the only supported merge claims.
|
|
1302
|
+
example:
|
|
1303
|
+
- email
|
|
1304
|
+
- phone
|
|
1305
|
+
oidcClaimMapper:
|
|
1306
|
+
items:
|
|
1307
|
+
type: string
|
|
1308
|
+
maxLength: 1024
|
|
1309
|
+
example: accessToken=access refresh_token accessTokenTTL=expires_in idToken=id_token subject=sub email=email userId=sub familyName=family_name givenName=given_name name=name
|
|
1310
|
+
type: array
|
|
1311
|
+
description: Mapping from the identity provider’s token claims for SLAS to get user information values when the user successfully authenticates. The values in this array should be setup using the following `key=value` pair pattern. The key part is the SLAS key with the value part being the OIDC claim key.
|
|
1312
|
+
example:
|
|
1313
|
+
- accessToken=access_token
|
|
1314
|
+
- refreshToken=refresh_token
|
|
1315
|
+
- accessTokenTTL=expires_in
|
|
1316
|
+
- idToken=id_token
|
|
1317
|
+
- subject=sub
|
|
1318
|
+
- email=email
|
|
1319
|
+
- userId=sub
|
|
1320
|
+
- familyName=family_name
|
|
1321
|
+
- givenName=given_name
|
|
1322
|
+
- name=name
|
|
1323
|
+
IdpListResponse:
|
|
1324
|
+
required:
|
|
1325
|
+
- data
|
|
1326
|
+
type: object
|
|
1327
|
+
properties:
|
|
1328
|
+
data:
|
|
1329
|
+
items:
|
|
1330
|
+
$ref: '#/components/schemas/IdentityProviderResponse'
|
|
1331
|
+
type: array
|
|
1332
|
+
description: An array of identity providers.
|
|
1333
|
+
IdentityProvider:
|
|
1334
|
+
required:
|
|
1335
|
+
- authUrl
|
|
1336
|
+
- clientId
|
|
1337
|
+
- clientSecret
|
|
1338
|
+
- isClientCredsBody
|
|
1339
|
+
- name
|
|
1340
|
+
- redirectUrl
|
|
1341
|
+
- scopes
|
|
1342
|
+
- tokenInfoUrl
|
|
1343
|
+
- tokenUrl
|
|
1344
|
+
- userInfoUrl
|
|
1345
|
+
- wellKnownUrl
|
|
1346
|
+
type: object
|
|
1347
|
+
properties:
|
|
1348
|
+
name:
|
|
1349
|
+
type: string
|
|
1350
|
+
description: Identity Provider Name
|
|
1351
|
+
maxLength: 200
|
|
1352
|
+
example: google
|
|
1353
|
+
enum:
|
|
1354
|
+
- adfs
|
|
1355
|
+
- apple
|
|
1356
|
+
- auth0
|
|
1357
|
+
- azure
|
|
1358
|
+
- cognito
|
|
1359
|
+
- facebook
|
|
1360
|
+
- forgerock
|
|
1361
|
+
- gigya
|
|
1362
|
+
- gigya_social
|
|
1363
|
+
- google
|
|
1364
|
+
- okta
|
|
1365
|
+
- ping
|
|
1366
|
+
- salesforce
|
|
1367
|
+
authUrl:
|
|
1368
|
+
type: string
|
|
1369
|
+
description: IDP authorize URL
|
|
1370
|
+
maxLength: 256
|
|
1371
|
+
example: https://www.salesforce.com/authorize
|
|
1372
|
+
tokenUrl:
|
|
1373
|
+
type: string
|
|
1374
|
+
description: IDP token URL
|
|
1375
|
+
maxLength: 256
|
|
1376
|
+
example: https://www.salesforce.com/token
|
|
1377
|
+
tokenInfoUrl:
|
|
1378
|
+
type: string
|
|
1379
|
+
description: IDP token info URL
|
|
1380
|
+
maxLength: 256
|
|
1381
|
+
example: https://www.salesforce.com/introspect
|
|
1382
|
+
userInfoUrl:
|
|
1383
|
+
type: string
|
|
1384
|
+
description: IDP user info URL
|
|
1385
|
+
maxLength: 256
|
|
1386
|
+
example: https://www.salesforce.com/userinfo
|
|
1387
|
+
redirectUrl:
|
|
1388
|
+
type: string
|
|
1389
|
+
description: Redirect URL to go to after IDP flow is complete. This URL must be registered with the IDP.
|
|
1390
|
+
maxLength: 256
|
|
1391
|
+
example: https://www.salesforce.com/idp/callback
|
|
1392
|
+
wellKnownUrl:
|
|
1393
|
+
type: string
|
|
1394
|
+
description: IDP URL to get OIDC configuration.
|
|
1395
|
+
maxLength: 256
|
|
1396
|
+
example: https://www.salesforce.com/.well-known/openid-configuration
|
|
1397
|
+
clientId:
|
|
1398
|
+
type: string
|
|
1399
|
+
description: Client Id of the third party IDP.
|
|
1400
|
+
maxLength: 128
|
|
1401
|
+
example: 934277749308-02dg4398n3s31ofge8cot46jirn3kpkf.apps.googleusercontent.com
|
|
1402
|
+
clientSecret:
|
|
1403
|
+
type: string
|
|
1404
|
+
maxLength: 512
|
|
1405
|
+
description: Client Secret of the third party IDP. For Apple copy the contents from the .p8 file that was downloaded from Apple between -*----BEGIN PRIVATE KEY-----* and -*---END PRIVATE KEY-----* markers.
|
|
1406
|
+
example: aKZM1xEnZopNP2bm2gc3GKex
|
|
1407
|
+
preferenceValue:
|
|
1408
|
+
type: boolean
|
|
1409
|
+
description: Set the IDP configuration as the Preferred SLAS IDP. Default value is `false`.
|
|
1410
|
+
maxLength: 1
|
|
1411
|
+
example: true
|
|
1412
|
+
isClientCredsBody:
|
|
1413
|
+
type: boolean
|
|
1414
|
+
description: Default is to place the client credentials in a basic authorization header for the call to the IDP. If true, the client credentials are placed in the POST body to the IDP.
|
|
1415
|
+
maxLength: 1
|
|
1416
|
+
example: false
|
|
1417
|
+
useWellKnown:
|
|
1418
|
+
type: boolean
|
|
1419
|
+
description: If set to `true`, SLAS uses the `wellKnowUrl` value to populate the `authUrl`, `tokenUrl`, `userInfoUrl`, and `scopes` values from the identity provider. Default value is `false`.
|
|
1420
|
+
maxLength: 1
|
|
1421
|
+
example: false
|
|
1422
|
+
scopes:
|
|
1423
|
+
items:
|
|
1424
|
+
type: string
|
|
1425
|
+
maxLength: 8192
|
|
1426
|
+
example: openid email profile
|
|
1427
|
+
type: array
|
|
1428
|
+
description: IDP Scopes
|
|
1429
|
+
example:
|
|
1430
|
+
- oidc
|
|
1431
|
+
- email
|
|
1432
|
+
- profile
|
|
1433
|
+
teamId:
|
|
1434
|
+
type: string
|
|
1435
|
+
description: Apple Team Id. Used primarily for Sign with Apple in generating the client secret.
|
|
1436
|
+
maxLength: 32
|
|
1437
|
+
example: appleTeamId
|
|
1438
|
+
keyId:
|
|
1439
|
+
type: string
|
|
1440
|
+
description: Apple key id. This is the Key ID that was obtained from Apple when the the private key for client authentication was created. Used primarily for Sign with Apple in generating the client secret.
|
|
1441
|
+
maxLength: 32
|
|
1442
|
+
example: appleKeyId
|
|
1443
|
+
loginMergeClaims:
|
|
1444
|
+
items:
|
|
1445
|
+
type: string
|
|
1446
|
+
maxLength: 256
|
|
1447
|
+
example: email
|
|
1448
|
+
type: array
|
|
1449
|
+
description: |
|
|
1450
|
+
List of user info claims that can be used as identifiers to look up and merge with an existing B2C Commerce profile for a registered shopper or an existing B2C Commerce profile created via federated login with an external Identity Provider with the same merge claim as this one. If multiple matching B2C Commerce shopper (customer) profiles are found, the external profile is merged with the most recently created shopper (customer) profile. Refer to the Merge Shopper Profiles user guide for more details.
|
|
1451
|
+
Note: When configuring an Apple IDP, 'email' and 'sub' are the only supported merge claims.
|
|
1452
|
+
example:
|
|
1453
|
+
- email
|
|
1454
|
+
- phone
|
|
1455
|
+
oidcClaimMapper:
|
|
1456
|
+
items:
|
|
1457
|
+
type: string
|
|
1458
|
+
maxLength: 1024
|
|
1459
|
+
example: accessToken=access_token efreshToken=refresh_token accessTokenTTL=expires_in idToken=id_token subject=sub email=email userId=sub familyName=family_name givenName=given_name name=name
|
|
1460
|
+
type: array
|
|
1461
|
+
description: Mapping from the identity provider’s token claims for SLAS to get user information values when the user successfully authenticates. The values in this array should be setup using the following `key=value` pair pattern. The key part is the SLAS key with the value part being the OIDC claim key.
|
|
1462
|
+
example:
|
|
1463
|
+
- accessToken=access_token
|
|
1464
|
+
- refreshToken=refresh_token
|
|
1465
|
+
- accessTokenTTL=expires_in
|
|
1466
|
+
- idToken=id_token
|
|
1467
|
+
- subject=sub
|
|
1468
|
+
- email=email
|
|
1469
|
+
- userId=sub
|
|
1470
|
+
- familyName=family_name
|
|
1471
|
+
- givenName=given_name
|
|
1472
|
+
- name=name
|
|
1473
|
+
description: Identity provider
|
|
1474
|
+
examples:
|
|
1475
|
+
Tenant:
|
|
1476
|
+
value:
|
|
1477
|
+
createdBy: slas
|
|
1478
|
+
modifiedBy: slas
|
|
1479
|
+
createdTime: 2021-02-25T00:55:54.119+0000
|
|
1480
|
+
modifiedTime: 2021-02-25T00:55:54.119+0000
|
|
1481
|
+
tenantId: slsa_dev
|
|
1482
|
+
merchantId: 2
|
|
1483
|
+
description: SLAS Default Tenant Two
|
|
1484
|
+
contact: Tenant Two
|
|
1485
|
+
emailAddress: tenant2@slas.tst
|
|
1486
|
+
phoneNo: 111-222-4444
|
|
1487
|
+
tier: S
|
|
1488
|
+
requestQuotaPerMinute: 8000
|
|
1489
|
+
isDeleted: false
|
|
1490
|
+
status: CLEAR
|
|
1491
|
+
TenantRequestException400:
|
|
1492
|
+
value:
|
|
1493
|
+
type: TenantRequestException
|
|
1494
|
+
title: Unable to retrieve resource because the tenant id was invalid
|
|
1495
|
+
detail: Tenant id is invalid
|
|
1496
|
+
TenantException401:
|
|
1497
|
+
value:
|
|
1498
|
+
type: TenantException
|
|
1499
|
+
title: Unable to retrieve resource because the tenant id was invalid
|
|
1500
|
+
detail: Tenant id is invalid
|
|
1501
|
+
TenantNotFoundException404:
|
|
1502
|
+
value:
|
|
1503
|
+
type: TenantNotFoundException
|
|
1504
|
+
title: Unable to retrieve resource because no resource was found with that value
|
|
1505
|
+
detail: Tenant id Not Found
|
|
1506
|
+
TenantDto:
|
|
1507
|
+
value:
|
|
1508
|
+
tenantId: slsa_dev
|
|
1509
|
+
merchantName: Popular Merchant
|
|
1510
|
+
description: Merchant Description
|
|
1511
|
+
contact: Jerry Smith
|
|
1512
|
+
emailAddress: jerry@merchant.com
|
|
1513
|
+
phoneNo: 801-555-1234
|
|
1514
|
+
TenantUpdateException400:
|
|
1515
|
+
value:
|
|
1516
|
+
type: TenantUpdateException
|
|
1517
|
+
title: Unable to retrieve resource because the tenant id was invalid
|
|
1518
|
+
detail: Tenant id was not updated
|
|
1519
|
+
TenantUpdateException401:
|
|
1520
|
+
value:
|
|
1521
|
+
type: TenantUpdateException
|
|
1522
|
+
title: Unable to retrieve resource because the tenant id was invalid
|
|
1523
|
+
detail: Tenant id was not updated
|
|
1524
|
+
TenantAlreadyExistsException409:
|
|
1525
|
+
value:
|
|
1526
|
+
type: TenantAlreadyExistsException
|
|
1527
|
+
title: Tenant[abcd_prd] already exists!
|
|
1528
|
+
detail: Tenant already exists
|
|
1529
|
+
ClientListResponse:
|
|
1530
|
+
value:
|
|
1531
|
+
data:
|
|
1532
|
+
- clientId: a462b606-317c-4a3c-90a7-4b0b938f3807
|
|
1533
|
+
secret: ''
|
|
1534
|
+
name: Shop Mart
|
|
1535
|
+
scopes:
|
|
1536
|
+
- sfcc.products sfcc.catalogs sfcc.products.ro
|
|
1537
|
+
redirectUri: http://localhost:9010/callback
|
|
1538
|
+
callbackUri: http://localhost:9010/pwd/reset/callback
|
|
1539
|
+
channels:
|
|
1540
|
+
- SiteGenesis
|
|
1541
|
+
- OtherSite
|
|
1542
|
+
isPrivateClient: true
|
|
1543
|
+
loginEpRestrict: false
|
|
1544
|
+
- clientId: 726bde86-7b99-415d-98ec-9290bad18904
|
|
1545
|
+
secret: ''
|
|
1546
|
+
name: High Adventure Wear
|
|
1547
|
+
scopes:
|
|
1548
|
+
- sfcc.products sfcc.catalogs sfcc.products.ro
|
|
1549
|
+
redirectUri: http://localhost:9010/callback
|
|
1550
|
+
callbackUri: http://localhost:9010/pwd/reset/callback
|
|
1551
|
+
channels:
|
|
1552
|
+
- SiteGenesis
|
|
1553
|
+
- OtherSite
|
|
1554
|
+
isPrivateClient: true
|
|
1555
|
+
loginEpRestrict: false
|
|
1556
|
+
- clientId: slas-default-client-1
|
|
1557
|
+
secret: ''
|
|
1558
|
+
name: Shop Salesforce
|
|
1559
|
+
scopes:
|
|
1560
|
+
- sfcc.products.ro sfcc.catalogs.ro
|
|
1561
|
+
redirectUri: http://localhost:9010/callback
|
|
1562
|
+
callbackUri: http://localhost:9010/pwd/reset/callback
|
|
1563
|
+
channels:
|
|
1564
|
+
- SiteGenesis
|
|
1565
|
+
- OtherSite
|
|
1566
|
+
isPrivateClient: true
|
|
1567
|
+
loginEpRestrict: false
|
|
1568
|
+
ClientTenantException401:
|
|
1569
|
+
value:
|
|
1570
|
+
type: ClientTenantException
|
|
1571
|
+
title: Unable to retrieve resource because the tenant id was invalid
|
|
1572
|
+
detail: Tenant id was not found. Please check the tenant id.
|
|
1573
|
+
ClientNotFoundException404:
|
|
1574
|
+
value:
|
|
1575
|
+
type: ClientNotFoundException
|
|
1576
|
+
title: Unable to retrieve resource because no resource was found with that value
|
|
1577
|
+
detail: Client Not Found
|
|
1578
|
+
Client:
|
|
1579
|
+
value:
|
|
1580
|
+
clientId: client-id1
|
|
1581
|
+
name: High Adventure Wear
|
|
1582
|
+
secret: secret1234
|
|
1583
|
+
scopes:
|
|
1584
|
+
- sfcc.products sfcc.catalogs sfcc.customers:ro
|
|
1585
|
+
redirectUri: http://localhost/callback
|
|
1586
|
+
callbackUri: http://localhost:9010/pwd/reset/callback
|
|
1587
|
+
channels:
|
|
1588
|
+
- SiteGenesis
|
|
1589
|
+
- OtherSite
|
|
1590
|
+
isPrivateClient: true
|
|
1591
|
+
loginEpRestrict: false
|
|
1592
|
+
ClientRequestException400:
|
|
1593
|
+
value:
|
|
1594
|
+
type: ClientRequestException
|
|
1595
|
+
title: Unable to retrieve resource because the client id was invalid
|
|
1596
|
+
detail: Client id is invalid
|
|
1597
|
+
ClientRequest:
|
|
1598
|
+
value:
|
|
1599
|
+
clientId: client-id1
|
|
1600
|
+
secret: secret12345
|
|
1601
|
+
name: High Adventure Wear
|
|
1602
|
+
scopes:
|
|
1603
|
+
- sfcc.products
|
|
1604
|
+
- sfcc.catalogs
|
|
1605
|
+
- sfcc.products.ro
|
|
1606
|
+
redirectUri:
|
|
1607
|
+
- http://localhost:9010/callback
|
|
1608
|
+
callbackUri:
|
|
1609
|
+
- http://localhost:9010/pwd/reset/callback
|
|
1610
|
+
channels:
|
|
1611
|
+
- SiteGenesis
|
|
1612
|
+
- OtherSite
|
|
1613
|
+
isPrivateClient: true
|
|
1614
|
+
loginEpRestrict: false
|
|
1615
|
+
ClientWithSecret:
|
|
1616
|
+
value:
|
|
1617
|
+
clientId: client-id1
|
|
1618
|
+
name: High Adventure Wear
|
|
1619
|
+
secret: secret12345
|
|
1620
|
+
scopes:
|
|
1621
|
+
- sfcc.products
|
|
1622
|
+
- sfcc.catalogs
|
|
1623
|
+
- sfcc.customers:ro
|
|
1624
|
+
redirectUri: http://localhost:9010/callback
|
|
1625
|
+
callbackUri: http://localhost:9010/pwd/reset/callback
|
|
1626
|
+
channels:
|
|
1627
|
+
- SiteGenesis
|
|
1628
|
+
- OtherSite
|
|
1629
|
+
isPrivateClient: true
|
|
1630
|
+
loginEpRestrict: false
|
|
1631
|
+
ClientConflictException409:
|
|
1632
|
+
value:
|
|
1633
|
+
type: ClientConflictException
|
|
1634
|
+
title: Unable to create resource because a duplicate resource was found
|
|
1635
|
+
detail: Client was not created. Duplicate resource was found.
|
|
1636
|
+
PasswordActionTemplate:
|
|
1637
|
+
value:
|
|
1638
|
+
channelId: SiteGenesis
|
|
1639
|
+
name: Passwordless SMS Template
|
|
1640
|
+
subject: Passwordless Token Request
|
|
1641
|
+
link: 'This is your passwordless token: ${token}'
|
|
1642
|
+
locale: en-us
|
|
1643
|
+
actionType: PWDLESS_LOGIN
|
|
1644
|
+
templateType: SMS
|
|
1645
|
+
template: |-
|
|
1646
|
+
Passwordless Login Token Request
|
|
1647
|
+
|
|
1648
|
+
Hello ${name},
|
|
1649
|
+
You're receiving this because you requested a passwordless login token for your account.
|
|
1650
|
+
${link}
|
|
1651
|
+
BadRequestException400:
|
|
1652
|
+
value:
|
|
1653
|
+
type: BadRequestException
|
|
1654
|
+
title: Unable to update resource because the request body was invalid
|
|
1655
|
+
detail: Request body is invalid.
|
|
1656
|
+
PasswordActionTemplateNotFoundException404:
|
|
1657
|
+
value:
|
|
1658
|
+
type: PasswordActionTemplateNotFoundException
|
|
1659
|
+
title: Template was not found
|
|
1660
|
+
detail: Template was not found.
|
|
1661
|
+
PasswordActionTemplateRequest:
|
|
1662
|
+
value:
|
|
1663
|
+
channelId: SiteGenesis
|
|
1664
|
+
name: Passwordless SMS Template
|
|
1665
|
+
subject: Passwordless Token Request
|
|
1666
|
+
link: 'This is your passwordless token: ${token}'
|
|
1667
|
+
locale: en-us
|
|
1668
|
+
actionType: PWDLESS_LOGIN
|
|
1669
|
+
templateType: SMS
|
|
1670
|
+
template: |-
|
|
1671
|
+
Passwordless Login Token Request
|
|
1672
|
+
Hello ${name},
|
|
1673
|
+
You're receiving this because you requested a passwordless login token for your account.
|
|
1674
|
+
${link}
|
|
1675
|
+
PasswordActionTemplateCreateException400:
|
|
1676
|
+
value:
|
|
1677
|
+
type: PasswordActionTemplateCreateException
|
|
1678
|
+
title: Template was not created or updated
|
|
1679
|
+
detail: Template was not created or updated.
|
|
1680
|
+
PasswordActionTemplateDeleteException400:
|
|
1681
|
+
value:
|
|
1682
|
+
type: PasswordActionTemplateDeleteException
|
|
1683
|
+
title: Template was not deleted
|
|
1684
|
+
detail: Template was not deleted.
|
|
1685
|
+
IdpListResponse:
|
|
1686
|
+
value:
|
|
1687
|
+
data:
|
|
1688
|
+
- name: google
|
|
1689
|
+
clientId: idp-client-id
|
|
1690
|
+
clientSecret: idp-secret
|
|
1691
|
+
authUrl: https://accounts.google.com/o/oauth2/v2/auth
|
|
1692
|
+
tokenUrl: https://oauth2.googleapis.com/token
|
|
1693
|
+
tokenInfoUrl: https://oauth2.googleapis.com/tokeninfo
|
|
1694
|
+
userInfoUrl: https://www.googleapis.com/oauth2/v3/userinfo
|
|
1695
|
+
redirectUrl: http://localhost:9010/hydra/callback
|
|
1696
|
+
wellKnownUrl: https://accounts.google.com/.well-known/openid-configuration
|
|
1697
|
+
scopes:
|
|
1698
|
+
- openid
|
|
1699
|
+
- email
|
|
1700
|
+
- profile
|
|
1701
|
+
isPreferred: true
|
|
1702
|
+
isClientCredsBody: false
|
|
1703
|
+
teamId: appleTeamId
|
|
1704
|
+
keyId: appleKeyId
|
|
1705
|
+
loginMergeClaims:
|
|
1706
|
+
- email
|
|
1707
|
+
oidcClaimMapper:
|
|
1708
|
+
- accessToken=access_token
|
|
1709
|
+
- refreshToken=refresh_token
|
|
1710
|
+
- accessTokenTTL=expires_in
|
|
1711
|
+
- idToken=id_token
|
|
1712
|
+
- subject=sub
|
|
1713
|
+
- email=email
|
|
1714
|
+
- userId=sub
|
|
1715
|
+
- familyName=family_name
|
|
1716
|
+
- givenName=given_name
|
|
1717
|
+
- name=name
|
|
1718
|
+
- name: Facebook
|
|
1719
|
+
clientId: idp-client-id
|
|
1720
|
+
clientSecret: idp-secret
|
|
1721
|
+
authUrl: https://www.facebook.com/v19.0/dialog/oauth
|
|
1722
|
+
tokenUrl: https://graph.facebook.com/v19.0/oauth/access_token
|
|
1723
|
+
tokenInfoUrl: https://graph.facebook.com/v19.0/debug_token
|
|
1724
|
+
userInfoUrl: https://graph.facebook.com/v19.0/me
|
|
1725
|
+
redirectUrl: http://my.host.com/api/v1/idp/callback/Facebook
|
|
1726
|
+
wellKnownUrl: https://www.facebook.com/.well-known/openid-configuration
|
|
1727
|
+
scopes:
|
|
1728
|
+
- openid
|
|
1729
|
+
- email
|
|
1730
|
+
- profile
|
|
1731
|
+
isPreferred: true
|
|
1732
|
+
isClientCredsBody: false
|
|
1733
|
+
teamId: appleTeamId
|
|
1734
|
+
keyId: appleKeyId
|
|
1735
|
+
loginMergeClaims:
|
|
1736
|
+
- email
|
|
1737
|
+
oidcClaimMapper:
|
|
1738
|
+
- accessToken=access_token
|
|
1739
|
+
- refreshToken=refresh_token
|
|
1740
|
+
- accessTokenTTL=expires_in
|
|
1741
|
+
- idToken=id_token
|
|
1742
|
+
- subject=sub
|
|
1743
|
+
- email=email
|
|
1744
|
+
- userId=sub
|
|
1745
|
+
- familyName=family_name
|
|
1746
|
+
- givenName=given_name
|
|
1747
|
+
- name=name
|
|
1748
|
+
IdpRequestException400:
|
|
1749
|
+
value:
|
|
1750
|
+
type: IdpRequestException
|
|
1751
|
+
title: Unable to update resource because the request body was invalid
|
|
1752
|
+
detail: Request body is invalid.
|
|
1753
|
+
IdpTenantException401:
|
|
1754
|
+
value:
|
|
1755
|
+
type: IdpTenantException
|
|
1756
|
+
title: Unable to update resource because the tenant id was invalid
|
|
1757
|
+
detail: Tenant id is invalid
|
|
1758
|
+
IdpNotFoundException404:
|
|
1759
|
+
value:
|
|
1760
|
+
type: IdpNotFoundException
|
|
1761
|
+
title: Unable to update resource because no resource was found with that value
|
|
1762
|
+
detail: Idp Not Found
|
|
1763
|
+
IdentityProvider:
|
|
1764
|
+
value:
|
|
1765
|
+
name: google
|
|
1766
|
+
clientId: idp-client-id
|
|
1767
|
+
clientSecret: idp-secret
|
|
1768
|
+
authUrl: https://accounts.google.com/o/oauth2/v2/auth
|
|
1769
|
+
tokenUrl: https://oauth2.googleapis.com/token
|
|
1770
|
+
tokenInfoUrl: https://oauth2.googleapis.com/tokeninfo
|
|
1771
|
+
userInfoUrl: https://www.googleapis.com/oauth2/v3/userinfo
|
|
1772
|
+
redirectUrl: http://localhost:9010/hydra/callback
|
|
1773
|
+
wellKnownUrl: https://accounts.google.com/.well-known/openid-configuration
|
|
1774
|
+
scopes:
|
|
1775
|
+
- openid
|
|
1776
|
+
- email
|
|
1777
|
+
- profile
|
|
1778
|
+
preferenceValue: true
|
|
1779
|
+
isClientCredsBody: false
|
|
1780
|
+
teamId: appleTeamId
|
|
1781
|
+
keyId: appleKeyId
|
|
1782
|
+
loginMergeClaims:
|
|
1783
|
+
- email
|
|
1784
|
+
oidcClaimMapper:
|
|
1785
|
+
- accessToken=access_token
|
|
1786
|
+
- refreshToken=refresh_token
|
|
1787
|
+
- accessTokenTTL=expires_in
|
|
1788
|
+
- idToken=id_token
|
|
1789
|
+
- subject=sub
|
|
1790
|
+
- email=email
|
|
1791
|
+
- userId=sub
|
|
1792
|
+
- familyName=family_name
|
|
1793
|
+
- givenName=given_name
|
|
1794
|
+
- name=name
|
|
1795
|
+
IdpProviderResponse:
|
|
1796
|
+
value:
|
|
1797
|
+
name: google
|
|
1798
|
+
clientId: idp-client-id
|
|
1799
|
+
clientSecret: idp-secret
|
|
1800
|
+
authUrl: https://accounts.google.com/o/oauth2/v2/auth
|
|
1801
|
+
tokenUrl: https://oauth2.googleapis.com/token
|
|
1802
|
+
tokenInfoUrl: https://oauth2.googleapis.com/tokeninfo
|
|
1803
|
+
userInfoUrl: https://www.googleapis.com/oauth2/v3/userinfo
|
|
1804
|
+
redirectUrl: http://localhost:9010/hydra/callback
|
|
1805
|
+
wellKnownUrl: https://accounts.google.com/.well-known/openid-configuration
|
|
1806
|
+
scopes:
|
|
1807
|
+
- openid
|
|
1808
|
+
- email
|
|
1809
|
+
- profile
|
|
1810
|
+
isPreferred: true
|
|
1811
|
+
isClientCredsBody: false
|
|
1812
|
+
teamId: appleTeamId
|
|
1813
|
+
keyId: appleKeyId
|
|
1814
|
+
loginMergeClaims:
|
|
1815
|
+
- email
|
|
1816
|
+
oidcClaimMapper:
|
|
1817
|
+
- accessToken=access_token
|
|
1818
|
+
- refreshToken=refresh_token
|
|
1819
|
+
- accessTokenTTL=expires_in
|
|
1820
|
+
- idToken=id_token
|
|
1821
|
+
- subject=sub
|
|
1822
|
+
- email=email
|
|
1823
|
+
- userId=sub
|
|
1824
|
+
- familyName=family_name
|
|
1825
|
+
- givenName=given_name
|
|
1826
|
+
- name=name
|
|
1827
|
+
IdpConflictException409:
|
|
1828
|
+
value:
|
|
1829
|
+
type: IdpConflictException
|
|
1830
|
+
title: Unable to create resource because a duplicate resource was found
|
|
1831
|
+
detail: Idp was not created. Duplicate resource was found.
|
|
1832
|
+
ShopperDeleteException400:
|
|
1833
|
+
value:
|
|
1834
|
+
type: ShopperDeleteException
|
|
1835
|
+
title: Email address does not match stored email address
|
|
1836
|
+
detail: Email address does not match stored email address
|
|
1837
|
+
ShopperNotFoundException404:
|
|
1838
|
+
value:
|
|
1839
|
+
type: ShopperNotFoundException
|
|
1840
|
+
title: SLAS USER was not found by customer id
|
|
1841
|
+
detail: SLAS USER was not found by customer id
|