@wix/subscription 1.0.22 → 1.0.23

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/subscription",
-  "version": "1.0.22",
+  "version": "1.0.23",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -18,7 +18,7 @@
     "type-bundles"
   ],
   "dependencies": {
-    "@wix/subscription_subscriptions": "1.0.22"
+    "@wix/subscription_subscriptions": "1.0.23"
   },
   "devDependencies": {
     "glob": "^10.4.1",
@@ -43,5 +43,5 @@
       "fqdn": ""
     }
   },
-  "falconPackageHash": "50b242bedd3f842cd17d194d26378a64b3b33c92acf7b915cdc335ee"
+  "falconPackageHash": "f232d7da53cec90befb8839c2c4a603ed5cdabb61ce00cec152f7a94"
 }

package/type-bundles/context.bundle.d.ts

@@ -486,12 +486,12 @@ interface Subscription {
      * Date when subscription was created
      * @readonly
      */
-    _createdDate?: Date;
+    _createdDate?: Date | null;
     /**
      * Date when subscription was updated
      * @readonly
      */
-    _updatedDate?: Date;
+    _updatedDate?: Date | null;
     /**
      * Revision of subscription. Increments upon changes
      * @readonly
@@ -507,13 +507,13 @@ interface Subscription {
      * Future start_date is not supported for `SEND_INVOICE` CollectionMethod
      * If start_date is set in past, it means subscription was already started.
      */
-    startDate?: Date;
+    startDate?: Date | null;
     /**
      * Represents when the subscription will end, relevant for subscriptions with a termed period.
      * If not provided, will be calculated based on billing schedule. Should be empty for evergreen subscription.
      * Note: A 13-hour tolerance is applied when validating the end date to handle for time zone differences and minor discrepancies.
      */
-    endDate?: Date;
+    endDate?: Date | null;
     /** Business origin subscription is coming from. In site-level subscription it will be vertical app_id and entity_id */
     origin?: BusinessOrigin;
     /** Customer information like id and identity type (member or contact) */
@@ -924,9 +924,9 @@ interface BillingStatus {
     /** how many cycled are remaining, For auto-renew subscriptions is not set. */
     remainingCycles?: number | null;
     /** Date when charge will be for next billing cycle */
-    nextBillingDate?: Date;
+    nextBillingDate?: Date | null;
     /** Previous Date charged for previous billing cycle */
-    previousBillingDate?: Date;
+    previousBillingDate?: Date | null;
     /** last payment details */
     latestPaymentData?: PaymentData;
     /** Free trial data */
@@ -942,7 +942,7 @@ interface PaymentData {
     invoiceId?: string;
     paymentStatus?: PaymentStatus;
     totals?: Totals;
-    initialFailedPaymentDate?: Date;
+    initialFailedPaymentDate?: Date | null;
 }
 declare enum PaymentStatus {
     /** Payment status unknown */
@@ -1008,19 +1008,19 @@ interface FreeTrialData {
      * Date when free trial starts
      * @readonly
      */
-    startDate?: Date;
+    startDate?: Date | null;
     /**
      * Date when free trial ends
      * @readonly
      */
-    endDate?: Date;
+    endDate?: Date | null;
 }
 interface UpdateBillingDateData {
     /**
      * Date until the subscription is paid for.
      * Different from `nextBillingDate` only when the next billing date is updated without immediately issuing a new invoice.
      */
-    paidUntil?: Date;
+    paidUntil?: Date | null;
     /** Information about how to adjust the item's payment due to the update of the billing date */
     proration?: Proration;
 }
@@ -1095,12 +1095,12 @@ interface GracePeriodData {
      * Grace period start date
      * @readonly
      */
-    startDate?: Date;
+    startDate?: Date | null;
     /**
      * Grace period end date
      * @readonly
      */
-    endDate?: Date;
+    endDate?: Date | null;
     /** Automatic retry data during grade period, if have any. Optional. */
     automaticRetryData?: AutomaticRetryData;
 }
@@ -1118,10 +1118,10 @@ interface SubscriptionPolicies {
 interface PauseInfo {
     pausePolicy?: PausePolicy;
     pauseAt?: PauseAt;
-    startDate?: Date;
+    startDate?: Date | null;
     startCycle?: number | null;
     resumeAt?: ResumeAt;
-    resumeDate?: Date;
+    resumeDate?: Date | null;
     resumeCycle?: number | null;
 }
 declare enum PausePolicy {
@@ -1155,7 +1155,7 @@ declare enum ResumeAt {
 }
 interface CancellationInfo {
     /** Subscription cancel date. Can contain a future or past date */
-    cancellationDate?: Date;
+    cancellationDate?: Date | null;
     /** Initiator for cancellation */
     initiator?: HistoryActionInitiator;
     /** Reason for cancellation. Optional. */
@@ -1271,7 +1271,7 @@ interface ApplicationFeeValueOneOf {
 }
 interface SpecificDateSubscriptionUpdateData {
     updateData?: SubscriptionUpdateData;
-    executionDate?: Date;
+    executionDate?: Date | null;
 }
 interface ListSubscriptionHistoryRequest {
     subscriptionId: string;
@@ -1308,7 +1308,7 @@ interface SubscriptionHistoryEntry {
     entryId?: string;
     /** TODO: add max length? it is not defined in domainevents, so should we? */
     slug?: string;
-    entryTime?: Date;
+    entryTime?: Date | null;
     event?: SubscriptionEvent;
 }
 interface SubscriptionEvent extends SubscriptionEventPayloadOneOf {
@@ -1499,7 +1499,7 @@ interface SubscriptionRevived {
 }
 interface SubscriptionBillingDateUpdated {
     subscription?: Subscription;
-    billingDate?: Date;
+    billingDate?: Date | null;
     proration?: Proration;
 }
 interface FutureUpdatesRequested {
@@ -1808,7 +1808,7 @@ interface SubscriptionCharge {
     /** cycle of future charge */
     cycle?: number;
     /** date of the charge */
-    billingDate?: Date;
+    billingDate?: Date | null;
     /** breakdown of charge */
     totals?: Totals;
     /** List of items in the invoice */
@@ -1968,22 +1968,8 @@ interface LineItemTaxSummary {
     aggregatedTaxAmount?: string;
     /** Aggregated from tax_breakdowns */
     aggregatedTaxRate?: string;
-    /** Array of each tax applied, grouped by `"jurisdiction"`, `"jurisdiction_type"`, `"tax_type"`, `"tax_name"` and `"tax_rate"`. */
-    aggregatedTaxBreakdowns?: AggregatedTaxBreakdown[];
-}
-interface AggregatedTaxBreakdown {
-    /** Name of the tax that was calculated. */
-    taxName?: string;
-    /** Type of tax that was calculated. */
-    taxType?: string;
-    /** Jurisdiction that taxes were calculated for. */
-    jurisdiction?: string;
-    /** Type of jurisdiction that taxes were calculated for. */
-    jurisdictionType?: string;
-    /** Tax rate used for this jurisdiction, as a decimal. For example, 10% tax is `"0.1000"` and 200% tax is `"2.0000"`. */
-    rate?: string;
-    /** Total amount of this tax for this jurisdiction. */
-    aggregatedTaxAmount?: string;
+    /** Total taxable amount for this line item. */
+    taxableAmount?: string;
 }
 interface TaxBreakdown {
     taxType?: string;
@@ -2056,7 +2042,7 @@ interface DomainEvent extends DomainEventBodyOneOf {
     /** ID of the entity associated with the event. */
     entityId?: string;
     /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
-    eventTime?: Date;
+    eventTime?: Date | null;
     /**
      * Whether the event was triggered as a result of a privacy regulation application
      * (for example, GDPR).
@@ -2085,7 +2071,7 @@ interface EntityCreatedEvent {
     entity?: string;
 }
 interface RestoreInfo {
-    deletedDate?: Date;
+    deletedDate?: Date | null;
 }
 interface EntityUpdatedEvent {
     /**
@@ -2191,7 +2177,7 @@ interface UpdateSubscriptionStartDateRequest {
      * By setting start_date in the future, end_date will be recalculated for termed Subscriptions
      * cycles_to_pay_on_creation will be set to 1 if no free trial is set
      */
-    startDate?: Date;
+    startDate?: Date | null;
 }
 interface UpdateSubscriptionStartDateResponse {
     subscription?: Subscription;
@@ -2209,7 +2195,7 @@ interface UpdateSubscriptionBillingDateRequest {
     /** ID of the subscription to update the billing date for. */
     _id: string;
     /** New billing date in `YYYY-MM-DDThh:mm:ss:sssZ` format. */
-    billingDate: Date;
+    billingDate: Date | null;
     /**
      * Information about how BASS adjusts the total of the next invoice. Extending
      * the current billing cycle results in a higher payment, while shortening it
@@ -2267,7 +2253,7 @@ interface ScheduleAdditionalInfo extends ScheduleAdditionalInfoParamOneOf {
      * only in combination with `{"resumeAt": "SPECIFIC_DATE"}`, and in
      * _Pause Subscription_ only in combination with `{"pauseAt": "SPECIFIC_DATE"}`.
      */
-    specificDate?: Date;
+    specificDate?: Date | null;
     /**
      * When the update becomes effective, as number of billing cycles from now.
      * The use of this field may be restricted in various BASS endpoints.
@@ -2287,7 +2273,7 @@ interface ScheduleAdditionalInfoParamOneOf {
      * only in combination with `{"resumeAt": "SPECIFIC_DATE"}`, and in
      * _Pause Subscription_ only in combination with `{"pauseAt": "SPECIFIC_DATE"}`.
      */
-    specificDate?: Date;
+    specificDate?: Date | null;
     /**
      * When the update becomes effective, as number of billing cycles from now.
      * The use of this field may be restricted in various BASS endpoints.
@@ -2520,7 +2506,7 @@ interface ListUpcomingChargesRequest {
      * Date of the next billing cycle so that the upcoming charges will be calculated accordingly.
      * If not provided, the upcoming charges will be calculated according to the existing next billing date.
      */
-    nextBillingDate?: Date;
+    nextBillingDate?: Date | null;
 }
 interface ListUpcomingChargesResponse {
     upcomingCharges?: SubscriptionCharge[];
@@ -2538,7 +2524,7 @@ interface PreviewSubscriptionChargesRequestSubscriptionOneOf {
 interface SubscriptionInfo {
     billingSettings?: BillingSettings;
     items?: Item[];
-    startDate?: Date;
+    startDate?: Date | null;
 }
 interface PreviewSubscriptionChargesResponse {
     /** Charges for subscription. */
@@ -2553,7 +2539,7 @@ interface Charge {
     /** The breakdown of the charge */
     totals?: Totals;
     /** The billing date from which the charge starts */
-    cycleBillingDate?: Date;
+    cycleBillingDate?: Date | null;
 }
 interface CreateSubscriptionForOrderRequest {
     /** Subscription needs to be created */
@@ -2578,12 +2564,12 @@ interface Invoice {
      * Date and time the invoice was created.
      * @readonly
      */
-    _createdDate?: Date;
+    _createdDate?: Date | null;
     /**
      * Date and time the invoice was last updated.
      * @readonly
      */
-    _updatedDate?: Date;
+    _updatedDate?: Date | null;
     /**
      * Revision number, which increments by 1 each time the invoice is updated.
      * To prevent conflicting changes,
@@ -2728,7 +2714,7 @@ interface LatestPaymentAttempt {
      * Date and time of the latest payment attempt in `YYYY-MM-DDThh:mm.sssZ` format.
      * @readonly
      */
-    dateAttempt?: Date;
+    dateAttempt?: Date | null;
     /** Number of the latest payment attempt. */
     attemptNumber?: number;
     /**
@@ -2836,9 +2822,23 @@ interface TaxSummary {
     /** Array of each tax applied, grouped by `"jurisdiction"`, `"jurisdiction_type"`, `"tax_type"`, `"tax_name"` and `"tax_rate"`. */
     aggregatedTaxBreakdowns?: AggregatedTaxBreakdown[];
 }
+interface AggregatedTaxBreakdown {
+    /** Name of the tax that was calculated. */
+    taxName?: string;
+    /** Type of tax that was calculated. */
+    taxType?: string;
+    /** Jurisdiction that taxes were calculated for. */
+    jurisdiction?: string;
+    /** Type of jurisdiction that taxes were calculated for. */
+    jurisdictionType?: string;
+    /** Tax rate used for this jurisdiction, as a decimal. For example, 10% tax is `"0.1000"` and 200% tax is `"2.0000"`. */
+    rate?: string;
+    /** Total amount of this tax for this jurisdiction. */
+    aggregatedTaxAmount?: string;
+}
 interface Task {
     key?: TaskKey;
-    executeAt?: Date;
+    executeAt?: Date | null;
     payload?: string | null;
 }
 interface TaskKey {
@@ -2862,7 +2862,7 @@ interface Complete {
 interface Cancel {
 }
 interface Reschedule {
-    executeAt?: Date;
+    executeAt?: Date | null;
     payload?: string | null;
 }
 interface Empty {
@@ -2960,9 +2960,9 @@ interface V1Subscription {
     /** Active, expired, canceled, etc. */
     subscriptionStatus?: V1SubscriptionStatusEnumSubscriptionStatus;
     /** Subscription start date (may differ from creation date) */
-    validFrom?: Date;
+    validFrom?: Date | null;
     /** Subscription expiration date */
-    validUntil?: Date;
+    validUntil?: Date | null;
     /** Status of last payment associated with this subscription */
     lastPaymentStatus?: PaymentStatusEnumPaymentStatus;
     /** Payment schedule in the wix pay format. Exists for recurring subscriptions only. */
@@ -2974,13 +2974,13 @@ interface V1Subscription {
     /** Can be used for arbitrary app-specific map<string, string> data */
     externalData?: Record<string, string>;
     /** Date when subscription was created (not related to payment dates) */
-    dateCreated?: Date;
+    dateCreated?: Date | null;
     /** Restrictions on possible subscription actions. Default policy has all restrictions enabled. */
     policy?: SubscriptionPolicy;
     /** List of subscription suspension periods */
     suspensions?: Suspension[];
     /** Initial subscription expiration date that was calculated on the subscription purchase plus duration of suspensions */
-    validUntilDateWithSuspensions?: Date;
+    validUntilDateWithSuspensions?: Date | null;
     /** Duration of single payment subscription (instead of billing_profile) */
     singlePaymentDuration?: V1Duration;
     originInstanceId?: string | null;
@@ -3071,7 +3071,7 @@ interface V2Subscription {
      * date in the future or in the past when the first billing cycle begins
      * (the first off-session payment is performed when it ends)
      */
-    firstCycleStartDate?: Date;
+    firstCycleStartDate?: Date | null;
 }
 /** Frequency unit of recurring payment */
 declare enum SubscriptionFrequency {
@@ -3111,9 +3111,9 @@ interface SubscriptionPolicy {
 interface Suspension {
     status?: Status;
     /** Beginning of the suspended period */
-    startsAt?: Date;
+    startsAt?: Date | null;
     /** End of the suspended period */
-    endsAt?: Date;
+    endsAt?: Date | null;
 }
 declare enum Status {
     UNDEFINED = "UNDEFINED",
@@ -3209,11 +3209,11 @@ interface MigrationDetails {
     /** system (application) where the Subscription has been created */
     originSystem?: string;
     /** date when the Subscription started to be managed in BASS */
-    shiftManagementDate?: Date;
+    shiftManagementDate?: Date | null;
 }
 interface PausePeriod {
-    startDate?: Date;
-    endDate?: Date;
+    startDate?: Date | null;
+    endDate?: Date | null;
 }
 interface GetSubscriptionAndInternalDataRequest {
     subscriptionId?: string;
@@ -3281,7 +3281,7 @@ interface GetSubscriptionInvoicesResponse {
 interface SubscriptionInvoice {
     _id?: string;
     subscriptionCycle?: number;
-    _createdDate?: Date;
+    _createdDate?: Date | null;
 }
 interface FinishFreeTrialNowRequest {
     subscriptionId?: string;
@@ -3298,7 +3298,7 @@ interface SendTimeCapsuleTaskCanceledBIRequest {
 interface ScheduleTimeCapsuleTaskRequest {
     subscriptionId?: string;
     taskType?: string;
-    executionTime?: Date;
+    executionTime?: Date | null;
     tenantId?: string;
 }
 interface CancelTimeCapsuleTaskRequest {
@@ -3325,8 +3325,8 @@ interface UpdateSubscriptionInvoiceCycleResponse {
 interface AddPausePeriodRequest {
     tenantId?: string;
     subscriptionId?: string;
-    pauseStartDate?: Date;
-    pauseEndDate?: Date;
+    pauseStartDate?: Date | null;
+    pauseEndDate?: Date | null;
 }
 interface AddPausePeriodResponse {
     subscription?: Subscription;
@@ -3348,7 +3348,7 @@ interface SetShiftingDataRequest {
     subscriptionId?: string;
     tenantId?: string;
     isBassManaged?: boolean;
-    shiftManagementDate?: Date;
+    shiftManagementDate?: Date | null;
 }
 interface SetShiftingDataResponse {
     subscription?: Subscription;
@@ -3804,19 +3804,10 @@ interface PriceDetailsNonNullableFields {
     discount?: InvoiceDiscountNonNullableFields;
     applicationFeeDetails?: InvoiceApplicationFeeNonNullableFields;
 }
-interface AggregatedTaxBreakdownNonNullableFields {
-    taxName: string;
-    taxType: string;
-    jurisdiction: string;
-    jurisdictionType: string;
-    rate: string;
-    aggregatedTaxAmount: string;
-    aggregatedTaxableAmount: string;
-}
 interface LineItemTaxSummaryNonNullableFields {
     aggregatedTaxAmount: string;
     aggregatedTaxRate: string;
-    aggregatedTaxBreakdowns: AggregatedTaxBreakdownNonNullableFields[];
+    taxableAmount: string;
 }
 interface TaxBreakdownNonNullableFields {
     taxType: string;
@@ -3946,7 +3937,7 @@ interface EventMetadata extends BaseEventMetadata {
     /** ID of the entity associated with the event. */
     entityId?: string;
     /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
-    eventTime?: Date;
+    eventTime?: Date | null;
     /**
      * Whether the event was triggered as a result of a privacy regulation application
      * (for example, GDPR).
@@ -4105,7 +4096,7 @@ interface ListUpcomingChargesOptions {
      * Date of the next billing cycle so that the upcoming charges will be calculated accordingly.
      * If not provided, the upcoming charges will be calculated according to the existing next billing date.
      */
-    nextBillingDate?: Date;
+    nextBillingDate?: Date | null;
 }
 interface PreviewSubscriptionChargesOptions extends PreviewSubscriptionChargesRequestSubscriptionOneOf {
     /** Information about a non-existing subscription. */
@@ -4227,7 +4218,7 @@ interface UpdateSubscriptionBillingDateSignature {
      * @param - ID of the subscription to update the billing date for.
      * @param - New billing date in `YYYY-MM-DDThh:mm:ss:sssZ` format.
      */
-    (_id: string, billingDate: Date, options?: UpdateSubscriptionBillingDateOptions | undefined): Promise<UpdateSubscriptionBillingDateResponse & UpdateSubscriptionBillingDateResponseNonNullableFields>;
+    (_id: string, billingDate: Date | null, options?: UpdateSubscriptionBillingDateOptions | undefined): Promise<UpdateSubscriptionBillingDateResponse & UpdateSubscriptionBillingDateResponseNonNullableFields>;
 }
 declare function cancelSubscription$1(httpClient: HttpClient): CancelSubscriptionSignature;
 interface CancelSubscriptionSignature {