@wix/auto_sdk_ecom_subscription-contracts 1.0.65 → 1.0.66

package/build/cjs/index.d.ts

@@ -1,6 +1,6 @@
 import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
-import { SubscriptionContract, SubscriptionContractsQueryBuilder, SubscriptionContractCreatedEnvelope, SubscriptionContractDeletedEnvelope, SubscriptionContractUpdatedEnvelope } from './index.typings.js';
-export { ActionEvent, AdditionalFee, Address, AddressLocation, AddressWithContact, AdjustmentType, AdjustmentTypeWithLiterals, ApplicationError, AppliedDiscount, AppliedDiscountDiscountSourceOneOf, BaseEventMetadata, BillingAdjustment, BillingAdjustmentPriceSummary, BulkActionMetadata, BulkCreateSubscriptionContractsRequest, BulkCreateSubscriptionContractsResponse, BulkSubscriptionContractResult, BulkUpdateSubscriptionContractsRequest, BulkUpdateSubscriptionContractsResponse, BuyerInfo, BuyerInfoIdOneOf, CatalogReference, ChannelInfo, ChannelType, ChannelTypeWithLiterals, Color, Coupon, CreateSubscriptionContractRequest, CreateSubscriptionContractResponse, CurrencyConversionDetails, CursorPaging, CursorPagingMetadata, CursorQuery, CursorQueryPagingMethodOneOf, Cursors, CustomField, DeliveryLogistics, DeliveryLogisticsAddressOneOf, DeliveryTimeSlot, DescriptionLine, DescriptionLineDescriptionLineValueOneOf, DescriptionLineName, DescriptionLineType, DescriptionLineTypeWithLiterals, DescriptionLineValueOneOf, DigitalFile, DiscountReason, DiscountReasonWithLiterals, DiscountRule, DiscountRuleName, DiscountType, DiscountTypeWithLiterals, DomainEvent, DomainEventBodyOneOf, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventMetadata, ExtendedFields, FocalPoint, FreeTrialPeriod, FullAddressContactDetails, GetSubscriptionContractRequest, GetSubscriptionContractResponse, IdentificationData, IdentificationDataIdOneOf, ItemMetadata, ItemModifier, ItemTaxFullDetails, ItemType, ItemTypeItemTypeDataOneOf, ItemTypePreset, ItemTypePresetWithLiterals, JurisdictionType, JurisdictionTypeWithLiterals, LineItemDiscount, LineItemTaxBreakdown, LineItemTaxInfo, Location, LocationAndQuantity, MaskedSubscriptionContract, MerchantDiscount, MerchantDiscountMerchantDiscountReasonOneOf, MessageEnvelope, ModifierGroup, OrderLineItem, OrderTaxBreakdown, OrderTaxInfo, PaymentOptionType, PaymentOptionTypeWithLiterals, PhysicalProperties, PickupAddress, PickupDetails, PickupMethod, PickupMethodWithLiterals, PlainTextValue, Price, PriceDescription, PriceSummary, ProductName, QuerySubscriptionContractsRequest, QuerySubscriptionContractsResponse, RestoreInfo, ShippingInformation, ShippingPrice, ShippingRegion, SortOrder, SortOrderWithLiterals, Sorting, StreetAddress, SubscriptionContractsQueryResult, SubscriptionDescription, SubscriptionFrequency, SubscriptionFrequencyWithLiterals, SubscriptionInfo, SubscriptionSettings, SubscriptionTitle, TaxableAddress, TaxableAddressTaxableAddressDataOneOf, TaxableAddressType, TaxableAddressTypeWithLiterals, TranslatableString, UpdateSubscriptionContractRequest, UpdateSubscriptionContractResponse, V1FreeTrialPeriod, V1SubscriptionDescription, V1SubscriptionSettings, V1SubscriptionTitle, V2SubscriptionFrequency, V2SubscriptionFrequencyWithLiterals, VatId, VatType, VatTypeWithLiterals, WebhookIdentityType, WebhookIdentityTypeWithLiterals, WeightUnit, WeightUnitWithLiterals } from './index.typings.js';
+import { SubscriptionContract, SubscriptionContractCreatedEnvelope, SubscriptionContractDeletedEnvelope, SubscriptionContractUpdatedEnvelope, SubscriptionContractsQueryBuilder, CursorQuery, typedQuerySubscriptionContracts } from './index.typings.js';
+export { ActionEvent, AdditionalFee, Address, AddressLocation, AddressWithContact, AdjustmentType, AdjustmentTypeWithLiterals, ApplicationError, AppliedDiscount, AppliedDiscountDiscountSourceOneOf, BaseEventMetadata, BillingAdjustment, BillingAdjustmentPriceSummary, BulkActionMetadata, BulkCreateSubscriptionContractsRequest, BulkCreateSubscriptionContractsResponse, BulkSubscriptionContractResult, BulkUpdateSubscriptionContractsRequest, BulkUpdateSubscriptionContractsResponse, BuyerInfo, BuyerInfoIdOneOf, CatalogReference, ChannelInfo, ChannelType, ChannelTypeWithLiterals, Color, Coupon, CreateSubscriptionContractRequest, CreateSubscriptionContractResponse, CurrencyConversionDetails, CursorPaging, CursorPagingMetadata, CursorQueryPagingMethodOneOf, Cursors, CustomField, DeliveryLogistics, DeliveryLogisticsAddressOneOf, DeliveryTimeSlot, DescriptionLine, DescriptionLineDescriptionLineValueOneOf, DescriptionLineName, DescriptionLineType, DescriptionLineTypeWithLiterals, DescriptionLineValueOneOf, DigitalFile, DiscountReason, DiscountReasonWithLiterals, DiscountRule, DiscountRuleName, DiscountType, DiscountTypeWithLiterals, DomainEvent, DomainEventBodyOneOf, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventMetadata, ExtendedFields, FocalPoint, FreeTrialPeriod, FullAddressContactDetails, GetSubscriptionContractRequest, GetSubscriptionContractResponse, IdentificationData, IdentificationDataIdOneOf, ItemMetadata, ItemModifier, ItemTaxFullDetails, ItemType, ItemTypeItemTypeDataOneOf, ItemTypePreset, ItemTypePresetWithLiterals, JurisdictionType, JurisdictionTypeWithLiterals, LineItemDiscount, LineItemTaxBreakdown, LineItemTaxInfo, Location, LocationAndQuantity, MaskedSubscriptionContract, MerchantDiscount, MerchantDiscountMerchantDiscountReasonOneOf, MessageEnvelope, ModifierGroup, OrderLineItem, OrderTaxBreakdown, OrderTaxInfo, PaymentOptionType, PaymentOptionTypeWithLiterals, PhysicalProperties, PickupAddress, PickupDetails, PickupMethod, PickupMethodWithLiterals, PlainTextValue, Price, PriceDescription, PriceSummary, ProductName, QuerySubscriptionContractsRequest, QuerySubscriptionContractsResponse, RestoreInfo, ShippingInformation, ShippingPrice, ShippingRegion, SortOrder, SortOrderWithLiterals, Sorting, StreetAddress, SubscriptionContractsQueryResult, SubscriptionDescription, SubscriptionFrequency, SubscriptionFrequencyWithLiterals, SubscriptionInfo, SubscriptionSettings, SubscriptionTitle, TaxableAddress, TaxableAddressTaxableAddressDataOneOf, TaxableAddressType, TaxableAddressTypeWithLiterals, TranslatableString, UpdateSubscriptionContractRequest, UpdateSubscriptionContractResponse, V1FreeTrialPeriod, V1SubscriptionDescription, V1SubscriptionSettings, V1SubscriptionTitle, V2SubscriptionFrequency, V2SubscriptionFrequencyWithLiterals, VatId, VatType, VatTypeWithLiterals, WebhookIdentityType, WebhookIdentityTypeWithLiterals, WeightUnit, WeightUnitWithLiterals } from './index.typings.js';
 
 declare function getSubscriptionContract$1(httpClient: HttpClient): GetSubscriptionContractSignature;
 interface GetSubscriptionContractSignature {
@@ -11,26 +11,16 @@ interface GetSubscriptionContractSignature {
      */
     (subscriptionContractId: string): Promise<NonNullablePaths<SubscriptionContract, `subscriptionSettings.frequency` | `subscriptionSettings.autoRenewal` | `subscriptionSettings.enableCustomerCancellation` | `subscriptionSettings.freeTrialPeriod.frequency` | `subscriptionSettings.freeTrialPeriod.interval` | `lineItems` | `lineItems.${number}._id` | `lineItems.${number}.productName.original` | `lineItems.${number}.catalogReference.catalogItemId` | `lineItems.${number}.catalogReference.appId` | `lineItems.${number}.quantity` | `lineItems.${number}.totalDiscount.amount` | `lineItems.${number}.totalDiscount.formattedAmount` | `lineItems.${number}.physicalProperties.shippable` | `lineItems.${number}.itemType.preset` | `lineItems.${number}.itemType.custom` | `lineItems.${number}.paymentOption` | `lineItems.${number}.taxDetails.taxRate` | `lineItems.${number}.taxInfo.taxIncludedInPrice` | `lineItems.${number}.digitalFile.fileId` | `lineItems.${number}.subscriptionInfo.cycleNumber` | `lineItems.${number}.subscriptionInfo.subscriptionOptionTitle` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.frequency` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.autoRenewal` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.enableCustomerCancellation` | `lineItems.${number}.priceDescription.original` | `lineItems.${number}.taxableAddress.addressType` | `buyerInfo.visitorId` | `buyerInfo.memberId` | `weightUnit` | `taxIncludedInPrices` | `billingInfo.address.streetAddress.number` | `billingInfo.address.streetAddress.name` | `billingInfo.contactDetails.vatId._id` | `billingInfo.contactDetails.vatId.type` | `shippingInfo.title` | `shippingInfo.logistics.pickupDetails.pickupMethod` | `appliedDiscounts` | `appliedDiscounts.${number}.coupon._id` | `appliedDiscounts.${number}.coupon.code` | `appliedDiscounts.${number}.coupon.name` | `appliedDiscounts.${number}.merchantDiscount.discountReason` | `appliedDiscounts.${number}.discountRule._id` | `appliedDiscounts.${number}.discountRule.name.original` | `appliedDiscounts.${number}.discountType` | `channelInfo.type` | `customFields` | `customFields.${number}.title` | `additionalFees` | `additionalFees.${number}.name` | `additionalFees.${number}._id`, 6>>;
 }
-declare function querySubscriptionContracts$1(httpClient: HttpClient): QuerySubscriptionContractsSignature;
-interface QuerySubscriptionContractsSignature {
-    /**
-     * Retrieves a list of SubscriptionContracts, given the provided [paging, filtering, and sorting][1].
-     *
-     * Up to 300 SubscriptionContracts can be returned per request.
-     *
-     * To learn how to query SubscriptionContracts, see [API Query Language][2].
-     *
-     * [1]: https://dev.wix.com/api/rest/getting-started/sorting-and-paging
-     * [2]: https://dev.wix.com/api/rest/getting-started/api-query-language
-     */
-    (): SubscriptionContractsQueryBuilder;
-}
 declare const onSubscriptionContractCreated$1: EventDefinition<SubscriptionContractCreatedEnvelope, "wix.ecom.subscription_contracts.v1.subscription_contract_created">;
 declare const onSubscriptionContractDeleted$1: EventDefinition<SubscriptionContractDeletedEnvelope, "wix.ecom.subscription_contracts.v1.subscription_contract_deleted">;
 declare const onSubscriptionContractUpdated$1: EventDefinition<SubscriptionContractUpdatedEnvelope, "wix.ecom.subscription_contracts.v1.subscription_contract_updated">;
 
+declare function customQuerySubscriptionContracts(httpClient: HttpClient): {
+    (): SubscriptionContractsQueryBuilder;
+    (query: CursorQuery): ReturnType<typeof typedQuerySubscriptionContracts>;
+};
 declare const getSubscriptionContract: MaybeContext<BuildRESTFunction<typeof getSubscriptionContract$1> & typeof getSubscriptionContract$1>;
-declare const querySubscriptionContracts: MaybeContext<BuildRESTFunction<typeof querySubscriptionContracts$1> & typeof querySubscriptionContracts$1>;
+declare const querySubscriptionContracts: MaybeContext<BuildRESTFunction<typeof customQuerySubscriptionContracts> & typeof customQuerySubscriptionContracts>;
 /** */
 declare const onSubscriptionContractCreated: BuildEventDefinition<typeof onSubscriptionContractCreated$1> & typeof onSubscriptionContractCreated$1;
 /** */
@@ -38,4 +28,4 @@ declare const onSubscriptionContractDeleted: BuildEventDefinition<typeof onSubsc
 /** */
 declare const onSubscriptionContractUpdated: BuildEventDefinition<typeof onSubscriptionContractUpdated$1> & typeof onSubscriptionContractUpdated$1;
 
-export { SubscriptionContract, SubscriptionContractCreatedEnvelope, SubscriptionContractDeletedEnvelope, SubscriptionContractUpdatedEnvelope, SubscriptionContractsQueryBuilder, getSubscriptionContract, onSubscriptionContractCreated, onSubscriptionContractDeleted, onSubscriptionContractUpdated, querySubscriptionContracts };
+export { CursorQuery, SubscriptionContract, SubscriptionContractCreatedEnvelope, SubscriptionContractDeletedEnvelope, SubscriptionContractUpdatedEnvelope, SubscriptionContractsQueryBuilder, getSubscriptionContract, onSubscriptionContractCreated, onSubscriptionContractDeleted, onSubscriptionContractUpdated, querySubscriptionContracts };

package/build/cjs/index.js

@@ -506,6 +506,51 @@ function querySubscriptionContracts2() {
     transformationPaths: {}
   });
 }
+async function typedQuerySubscriptionContracts(query) {
+  const { httpClient, sideEffects } = arguments[1];
+  const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({ query });
+  const reqOpts = querySubscriptionContracts(
+    payload
+  );
+  sideEffects?.onSiteCall?.();
+  try {
+    const result = await httpClient.request(reqOpts);
+    sideEffects?.onSuccess?.(result);
+    return (0, import_rename_all_nested_keys.renameKeysFromRESTResponseToSDKResponse)(
+      (0, import_transform_paths2.transformPaths)(result.data, [
+        {
+          transformFn: import_image.transformRESTImageToSDKImage,
+          paths: [{ path: "subscriptionContracts.lineItems.image" }]
+        },
+        {
+          transformFn: import_address.transformRESTAddressToSDKAddress,
+          paths: [
+            { path: "subscriptionContracts.billingInfo.address" },
+            {
+              path: "subscriptionContracts.shippingInfo.logistics.shippingDestination.address"
+            },
+            {
+              path: "subscriptionContracts.shippingInfo.logistics.pickupDetails.address"
+            },
+            { path: "subscriptionContracts.recipientInfo.address" }
+          ]
+        }
+      ])
+    );
+  } catch (err) {
+    const transformedError = (0, import_transform_error.transformError)(
+      err,
+      {
+        spreadPathsToArguments: {},
+        explicitPathsToArguments: { query: "$[0]" },
+        singleArgumentUnchanged: false
+      },
+      ["query"]
+    );
+    sideEffects?.onError?.(err);
+    throw transformedError;
+  }
+}
 
 // src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.public.ts
 function getSubscriptionContract3(httpClient) {
@@ -521,6 +566,13 @@ function querySubscriptionContracts3(httpClient) {
     { httpClient }
   );
 }
+function typedQuerySubscriptionContracts2(httpClient) {
+  return (query) => typedQuerySubscriptionContracts(
+    query,
+    // @ts-ignore
+    { httpClient }
+  );
+}
 var onSubscriptionContractCreated = (0, import_sdk_types.EventDefinition)(
   "wix.ecom.subscription_contracts.v1.subscription_contract_created",
   true,
@@ -654,8 +706,20 @@ var onSubscriptionContractUpdated = (0, import_sdk_types.EventDefinition)(
 // src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.context.ts
 var import_rest_modules3 = require("@wix/sdk-runtime/rest-modules");
 var import_event_definition_modules = require("@wix/sdk-runtime/event-definition-modules");
+var import_query_method_router = require("@wix/sdk-runtime/query-method-router");
+function customQuerySubscriptionContracts(httpClient) {
+  const router = (0, import_query_method_router.createQueryOverloadRouter)({
+    builderQueryFunction: () => querySubscriptionContracts3(httpClient)(),
+    typedQueryFunction: (query) => typedQuerySubscriptionContracts2(httpClient)(query),
+    hasOptionsParameter: false
+  });
+  function overloadedQuery(query) {
+    return router(...arguments);
+  }
+  return overloadedQuery;
+}
 var getSubscriptionContract4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(getSubscriptionContract3);
-var querySubscriptionContracts4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(querySubscriptionContracts3);
+var querySubscriptionContracts4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(customQuerySubscriptionContracts);
 var onSubscriptionContractCreated2 = (0, import_event_definition_modules.createEventModule)(
   onSubscriptionContractCreated
 );