@wix/auto_sdk_premium-assets_premium-assets 1.0.4 → 1.0.6

package/build/cjs/index.d.ts

@@ -5,29 +5,33 @@ export { Account, AccountInfo, ActionEvent, ActionStatus, ActionStatusStatusOneO
 declare function queryPremiumAssets$1(httpClient: HttpClient): QueryPremiumAssetsSignature;
 interface QueryPremiumAssetsSignature {
     /**
-     * Retrieves a list of Premium assets, given the provided [paging][1] and
-     * [filtering][2]. Assets for which the account is
-     * [Billing Manager](https://support.wix.com/en/article/roles-permissions-overview#roles-for-integrated-wix-apps)
-     * aren't returned by default.
+     * Retrieves a list of up to 100 Premium assets, given the provided paging,
+     * filtering, and sorting.
+     *
      *
+     * Query Premium Assets runs with these defaults, which you can override:
      *
-     * You must pass `targetAccountId` explicitly as a header parameter to query
-     * assets. The call fails if you omit it.
+     * - `cursorPaging.limit` is `50`
      *
-     * To query assets for which the account is Billing Manager pass
-     * `{"includePermitted": true}`.
+     * Pass the ID of the account whose assets you want to retrieve in the
+     * `targetAccountId` header. The call fails without it.
      *
-     * Sorting is applied to the first page of results only. Following requests use
-     * the cursor token, which already carries the sort from the first call.
+     * Which assets are returned depends on what the caller is permitted on. A
+     * caller permitted on the target account receives all of the account's assets.
+     * A caller permitted only on a specific site receives that site's assets alone,
+     * and the results are filtered to that site. In the second case the site is
+     * taken from the call scope, so a call with neither an account permission nor a
+     * site in scope fails.
      *
-     * Up to 100 Premium assets can be returned per request. The default
-     * `cursorPaging.limit` is 50.
+     * Assets for which the account is
+     * [Billing Manager](https://support.wix.com/en/article/roles-permissions-overview#roles-for-integrated-wix-apps)
+     * aren't returned by default. Pass `{"includePermitted": true}` to include
+     * them. Sort isn't guaranteed to be applied when `includePermitted` is `true`.
      *
-     * To learn how to query Premium assets, see [API Query Language][3].
+     * Sorting applies to the first page of results. Following requests use the
+     * cursor token, which already carries the sort from the first call.
      *
-     * [1]: https://dev.wix.com/api/rest/getting-started/pagination
-     * [2]: https://dev.wix.com/api/rest/contacts/contacts/sorting,-filtering,-and-searching
-     * [3]: https://dev.wix.com/api/rest/getting-started/api-query-language
+     * To learn about working with Query methods, see [API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language), [Sorting and Paging](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-sorting-and-paging), and [Field Projection](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-field-projection).
      */
     (options?: QueryPremiumAssetsOptions): Promise<NonNullablePaths<QueryPremiumAssetsResponse, `premiumAssets` | `premiumAssets.${number}.domainsData.domain` | `premiumAssets.${number}.domainsData.primary` | `premiumAssets.${number}.domainsData.privacy` | `premiumAssets.${number}.domainsData.validInRegistrar` | `premiumAssets.${number}.domainsData.dnssecSupported` | `premiumAssets.${number}.domainsData.insuranceSupported` | `premiumAssets.${number}.domainsData.insuranceActivated` | `premiumAssets.${number}.mailboxesData.domainName` | `premiumAssets.${number}.mailboxesData.seats` | `premiumAssets.${number}.mailboxesData.vendor` | `premiumAssets.${number}.digitalGoodsData.digitalGoodsType` | `premiumAssets.${number}.premiumId` | `premiumAssets.${number}.siteData.metasiteId` | `premiumAssets.${number}.siteData.siteName` | `premiumAssets.${number}.accountOwnerId` | `premiumAssets.${number}.billingReference.providerName` | `premiumAssets.${number}.billingReference.providerReferenceId` | `premiumAssets.${number}.status` | `premiumAssets.${number}.deliveryComplete` | `premiumAssets.${number}.renewalType` | `premiumAssets.${number}.billingCycle.cycleType` | `premiumAssets.${number}.billingCycle.cycleDuration.unit` | `premiumAssets.${number}.billingCycle.cycleDuration.count` | `premiumAssets.${number}.pendingChanges.product.productId` | `premiumAssets.${number}.pendingChanges.product.productTypeId` | `premiumAssets.${number}.pendingChanges.product.productTypeName` | `premiumAssets.${number}.pendingChanges.product.productName` | `premiumAssets.${number}.wixBillingDetails.paymentMethod.paymentMethodType` | `premiumAssets.${number}.wixBillingDetails.paymentMethod.displayLabel` | `premiumAssets.${number}.wixBillingDetails.paymentMethod.paymentSourceId` | `premiumAssets.${number}.wixBillingDetails.lastInvoiceDetails.invoiceId` | `premiumAssets.${number}.wixBillingDetails.lastInvoiceDetails.currencyCode` | `premiumAssets.${number}.wixBillingDetails.lastInvoiceDetails.amount` | `premiumAssets.${number}.wixBillingDetails.lastInvoiceDetails.paymentStatus` | `premiumAssets.${number}.wixBillingDetails.customCharges` | `premiumAssets.${number}.freeTrialData.inFreeTrialPeriod` | `premiumAssets.${number}.freeTrialData.pendingExternalActivation`, 4> & {
         __applicationErrorsType?: QueryPremiumAssetsApplicationErrors;