@wix/auto_sdk_premium-assets_premium-assets 1.0.0

package/build/cjs/index.d.ts

@@ -0,0 +1,39 @@
+import { HttpClient, NonNullablePaths, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
+import { QueryPremiumAssetsOptions, QueryPremiumAssetsResponse, QueryPremiumAssetsApplicationErrors } from './index.typings.js';
+export { Account, AccountInfo, ActionEvent, ActionStatus, ActionStatusStatusOneOf, ActiveRegistration, AdditionalFee, AdditionalFeeTrigger, AdditionalFeeTriggerWithLiterals, Address, AddressHint, AddressLocation, Aggregation, AggregationData, AggregationKindOneOf, AggregationResults, AggregationResultsResultOneOf, AggregationResultsScalarDateResult, AggregationResultsScalarResult, AggregationType, AggregationTypeWithLiterals, AllCardBrands, AlternativePaymentMethod, AlternativePaymentMethodType, AlternativePaymentMethodTypeWithLiterals, ApplicationFee, ApplicationFeeValueOneOf, AssetStatus, AssetStatusWithLiterals, AssetToRecollect, AssetToRecollectAssetClassifierOneOf, AssetType, AssetTypeWithLiterals, AutomaticRetryData, BankTransfer, BankTransferDetails, BankTransferType, BankTransferTypeWithLiterals, BassBillingDetails, BillingDetails, BillingProviderType, BillingProviderTypeWithLiterals, BillingReference, BillingReferenceProviderName, BillingReferenceProviderNameWithLiterals, BillingSettings, BillingStatus, BillingSubscriptionCancelled, BulkGetPermittedPremiumAssetsRequest, BulkGetPermittedPremiumAssetsResponse, BulkRecollectPremiumAsset, BusinessOrigin, BusinessSchedule, CancelActionConfiguration, CancelActionSettings, CancellationDetails, CancellationInfo, CannotExtendReasonEnum, CannotExtendReasonEnumWithLiterals, Card, CardBrand, CardBrandWithLiterals, CardBrands, CardSupportedBrandsOneOf, Cash, CashDetails, CashType, CashTypeWithLiterals, CatalogReference, Categories, ChangeContext, ChangeContextPayloadOneOf, CollectionMethod, CollectionMethodWithLiterals, ConnectedToSite, ConnectionLost, ConnectionVerified, ConsentPolicy, Contact, ContactVerificationStatus, ContactVerificationStatusChanged, ContactVerificationStatusWithLiterals, Contacts, ContractSwitchReason, ContractSwitchReasonWithLiterals, ContractSwitchType, ContractSwitchTypeWithLiterals, ContractSwitched, CountPremiumAssetsRequest, CountPremiumAssetsResponse, CouponData, CrudType, CrudTypeWithLiterals, CursorPaging, CursorPagingMetadata, CursorQuery, CursorQueryPagingMethodOneOf, CursorSearch, CursorSearchPagingMethodOneOf, Cursors, CustomBillingSchedule, CustomProration, CustomProrationAmountOneOf, Customer, CustomerActionCounters, CustomerActionSettings, CustomerIdOneOf, Cycle, CycleCycleSelectorOneOf, CycleDuration, CycleMessage, CycleType, CycleTypeWithLiterals, Cycles, DateHistogramAggregation, DateHistogramAggregationInterval, DateHistogramAggregationIntervalWithLiterals, DateHistogramResult, DateHistogramResults, DayOfWeek, DayOfWeekWithLiterals, Deactivated, DeferredBillingData, DeleteAssetRequest, DigitalGoodCancelled, DigitalGoodChangeMessage, DigitalGoodChangeMessagePayloadOneOf, DigitalGoodDelivered, DigitalGoodsData, DigitalGoodsType, DigitalGoodsTypeWithLiterals, DirectDebit, DirectDebitBrand, DirectDebitBrandWithLiterals, DisconnectedFromSite, Discount, DiscountCycles, DiscountDetails, DiscountOrigin, DiscountValueOneOf, DnssecChanged, DomainChangedEvent, DomainChangedEventPayloadOneOf, DomainData, DomainEvent, DomainEventBodyOneOf, DomainPrivacy, DomainPrivacyWithLiterals, DomainRegistrationChangedEvent, Duration, DurationDurationUnit, DurationDurationUnitWithLiterals, DurationUnit, DurationUnitWithLiterals, DynamicTax, EligibilityIdType, EligibilityIdTypeEnum, EligibilityIdTypeEnumWithLiterals, EligibilityType, EligibilityTypeEnum, EligibilityTypeEnumWithLiterals, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityType, EntityTypeEnum, EntityTypeEnumWithLiterals, EntityUpdatedEvent, EsIdType, EsIdTypeEnum, EsIdTypeEnumWithLiterals, ExpirationDateChanged, Expired, ExternalCollectionDetails, ExternalPaymentMethodDetails, ExternalPrice, Failure, FixedPrice, FreeTrialData, FullAddressContactDetails, FullAddressDetails, FullName, GeoCoordinates, GeotileGridAggregation, GeotileGridBucket, GeotileGridResults, GetPremiumAssetByPremiumIdRequest, GetPremiumAssetByPremiumIdResponse, GetPremiumAssetRequest, GetPremiumAssetResponse, GraceEnded, GracePeriodData, GroupByAggregation, GroupByAggregationKindOneOf, GroupByValueResults, HistoryActionInitiator, HistoryActionInitiatorWithLiterals, ICANNContactVerificationStatus, ICANNContactVerificationStatusWithLiterals, ICANNStatusInfo, ICANNStatusInfoStatusOneOf, IdentificationData, IdentificationDataIdOneOf, IlRegistrantType, IlRegistrantTypeEnum, IlRegistrantTypeEnumWithLiterals, InactiveRegistration, IncludeMissingValuesOptions, Initiator, InitiatorWithLiterals, Interval, IntervalUnit, IntervalUnitWithLiterals, Invoice, InvoiceDetails, InvoiceLineItem, InvoiceStatus, InvoiceStatusWithLiterals, Item, ItemCategory, ItemCategoryWithLiterals, ItemChange, LegalType, LegalTypeEnum, LegalTypeEnumWithLiterals, LifecycleStatus, LifecycleStatusStatusOneOf, ListSitesPremiumStatusRequest, ListSitesPremiumStatusResponse, Locale, MailboxData, ManagementTypeChanged, MessageEnvelope, MissingValues, MissingValuesWithLiterals, Mode, ModeWithLiterals, Multilingual, NameServersTypeEnum, NameServersTypeEnumWithLiterals, NestedAggregation, NestedAggregationItem, NestedAggregationItemKindOneOf, NestedAggregationResults, NestedAggregationResultsResultOneOf, NestedAggregationType, NestedAggregationTypeWithLiterals, NestedResultValue, NestedResultValueResultOneOf, NestedResults, NestedValueAggregationResult, NextInvoiceDetails, NexusCategory, NexusCategoryEnum, NexusCategoryEnumWithLiterals, OneTime, Origin, OwnerChanged, PauseAt, PauseAtWithLiterals, PauseInfo, PausePolicy, PausePolicyWithLiterals, PauseResumeActionConfiguration, PauseResumeActionSettings, PaymentBrand, PaymentData, PaymentDisplayProperties, PaymentIntegration, PaymentIntegrationWithLiterals, PaymentMethod, PaymentMethodPaymentMethodSelectorOneOf, PaymentMethodType, PaymentMethodTypeWithLiterals, PaymentSource, PaymentStatus, PaymentStatusWithLiterals, PaymentTaxData, PaymentType, Pending, PendingChanges, PlacementType, PlacementTypeWithLiterals, PlatformOrigin, PolicyReason, PolicyReasonEnum, PolicyReasonEnumWithLiterals, PremiumAsset, PremiumAssetTypeSpecificDataOneOf, PremiumStatus, PremiumStatusWithLiterals, PriceIncreaseProcessed, PriceIncreaseTrigger, PriceIncreaseTriggerWithLiterals, PricingModel, PricingModelModelOneOf, PrivacyChanged, ProductAdjustment, ProductAdjustmentWithLiterals, ProductData, ProductPriceIncreaseData, PropagationStarted, Properties, PropertiesChange, Proration, ProrationTypeOneOf, ProviderName, ProviderNameWithLiterals, PublicAlternativePaymentMethodDetails, PublicCreditCard, PublicDirectDebitDetails, PublicSepaDetails, QueryAccountPremiumAssetsRequest, QueryAccountPremiumAssetsResponse, QueryPremiumAssetsRequest, RangeAggregation, RangeAggregationResult, RangeBucket, RangeResult, RangeResults, ReactivationData, ReactivationReasonEnum, ReactivationReasonEnumWithLiterals, RecollectAccountRequest, RecollectAccountResponse, RecollectAssetResult, RecollectAssetsRequest, RecollectAssetsResponse, RecollectDigitalGood, RecollectGoogleMailbox, RecollectPremiumAsset, RecollectPremiumAssetExtended, RecollectPremiumAssetExtendedBillingDetailsOneOf, RecollectPremiumAssetRecollectAssetOneOf, RecollectRegistration, RecollectSubscription, RecurringChargeAttemptFailed, RecurringChargeFailureReason, RecurringChargeFailureReasonWithLiterals, RecurringChargeSucceeded, RecurringType, RecurringTypeMessageRecurringType, RecurringTypeMessageRecurringTypeWithLiterals, RecurringTypeWithLiterals, RedeemStatusEnum, RedeemStatusEnumWithLiterals, RedemptionEnded, RefundType, RefundTypeWithLiterals, Registered, RegistrarName, RegistrarNameWithLiterals, Registration, RegistrationCanExtendDataOneOf, RegistrationCancelled, RegistrationExtended, RenewalType, RenewalTypeWithLiterals, ResolutionMethod, ResolutionMethodWithLiterals, RestoreInfo, Results, ResumeAt, ResumeAtWithLiterals, SbsBillingDetails, ScalarAggregation, ScalarDateResult, ScalarResult, ScalarType, ScalarTypeWithLiterals, SearchDetails, SearchPremiumAssetsRequest, SearchPremiumAssetsResponse, SelfPickup, Service, ServicePendingChanges, ServiceStatus, ServiceStatusWithLiterals, Shipping, ShippingCharges, ShippingDetails, ShippingShippingSelectorOneOf, SiteCloned, SiteCreated, SiteData, SitePremiumStatus, SitePropertiesEvent, SitePropertiesNotification, SkipActionConfiguration, SkipActionSettings, SortDirection, SortDirectionWithLiterals, SortOrder, SortOrderWithLiterals, SortType, SortTypeWithLiterals, Sorting, SpecialHourPeriod, SpecificDateSubscriptionUpdateData, Street, StreetAddress, Subscription, SubscriptionAssigned, SubscriptionAutoRenewTurnedOff, SubscriptionAutoRenewTurnedOn, SubscriptionCancelled, SubscriptionCreated, SubscriptionEvent, SubscriptionEventEventOneOf, SubscriptionMigratedFromVista, SubscriptionNearEndOfPeriod, SubscriptionPendingChange, SubscriptionPolicies, SubscriptionStatus, SubscriptionStatusEnumSubscriptionStatus, SubscriptionStatusEnumSubscriptionStatusWithLiterals, SubscriptionStatusWithLiterals, SubscriptionTransferred, SubscriptionUnassigned, SubscriptionUpdateData, SubscriptionUpdated, SubscriptionVistaMigrationReverted, Success, SupportedLanguage, Tax, TaxAmount, TaxBreakdown, TaxCalculationType, TaxCalculationTypeWithLiterals, TaxInfo, TaxInfoModel, TaxSettings, TaxableAddressType, TaxableAddressTypeWithLiterals, TimeBasedProration, TimeInterval, TimePeriod, Totals, TransactionData, TransferDetails, Translation, TypeSpecificFields, UnassignReason, UnassignReasonWithLiterals, UpdateBillingDateActionConfiguration, UpdateBillingDateActionSettings, UpdateBillingDateData, UpmActionSettings, V1Address, V1AddressStreetOneOf, V1Cycle, V1FreeTrialData, V1PaymentMethod, V1PaymentMethodType, V1PaymentMethodTypeType_SelectorOneOf, V1Subscription, V1Tax, V1TaxValueOneOf, V2BillingReference, V2CursorPaging, V2CursorQuery, V2CursorQueryPagingMethodOneOf, V2CursorSearch, V2CursorSearchPagingMethodOneOf, V2FreeTrialData, V2PaymentMethod, V2PaymentStatus, V2PaymentStatusWithLiterals, V4Address, ValueAggregation, ValueAggregationOptionsOneOf, ValueAggregationResult, ValueResult, ValueResults, VendorType, VendorTypeWithLiterals, VerificationStarted, Verified, WebhookIdentityType, WebhookIdentityTypeWithLiterals, YearMonth } from './index.typings.js';
+
+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.
+     *
+     *
+     * You must pass `targetAccountId` explicitly as a header parameter to query
+     * assets. The call fails if you omit it.
+     *
+     * To query assets for which the account is Billing Manager pass
+     * `{"includePermitted": true}`.
+     *
+     * 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.
+     *
+     * Up to 100 Premium assets can be returned per request. The default
+     * `cursorPaging.limit` is 50.
+     *
+     * To learn how to query Premium assets, see [API Query Language][3].
+     *
+     * [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
+     */
+    (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`, 6> & {
+        __applicationErrorsType?: QueryPremiumAssetsApplicationErrors;
+    }>;
+}
+
+declare const queryPremiumAssets: MaybeContext<BuildRESTFunction<typeof queryPremiumAssets$1> & typeof queryPremiumAssets$1>;
+
+export { QueryPremiumAssetsApplicationErrors, QueryPremiumAssetsOptions, QueryPremiumAssetsResponse, queryPremiumAssets };