@mj-biz-apps/orders-entities 5.17.0 → 5.18.0

package/dist/generated/entities/__mj_BizAppsOrders.d.ts

@@ -404,6 +404,9 @@ export declare const mjBizAppsOrdersEntitlementGrantSchema: z.ZodObject<{
     RevocationReason: z.ZodNullable<z.ZodString>;
     __mj_CreatedAt: z.ZodDate;
     __mj_UpdatedAt: z.ZodDate;
+    GrantTimingApplied: z.ZodNullable<z.ZodUnion<[z.ZodLiteral<"OnActivation">, z.ZodLiteral<"OnConfirm">, z.ZodLiteral<"OnFirstPayment">, z.ZodLiteral<"OnPaidInFull">]>>;
+    SuspendedAt: z.ZodNullable<z.ZodDate>;
+    SuspensionReason: z.ZodNullable<z.ZodUnion<[z.ZodLiteral<"AwaitingActivation">, z.ZodLiteral<"AwaitingPayment">, z.ZodLiteral<"PastDue">]>>;
     ProductEntitlement: z.ZodNullable<z.ZodString>;
     Subscription: z.ZodNullable<z.ZodString>;
     BeneficiaryPerson: z.ZodNullable<z.ZodString>;
@@ -426,6 +429,9 @@ export declare const mjBizAppsOrdersEntitlementGrantSchema: z.ZodObject<{
     ProvisionedAt?: Date;
     ValidityModeApplied?: "EventWindow" | "FixedDuration" | "Perpetual" | "SubscriptionTerm";
     SubscriptionTermID?: string;
+    GrantTimingApplied?: "OnActivation" | "OnConfirm" | "OnFirstPayment" | "OnPaidInFull";
+    SuspendedAt?: Date;
+    SuspensionReason?: "AwaitingActivation" | "AwaitingPayment" | "PastDue";
     ProductEntitlement?: string;
     Subscription?: string;
     BeneficiaryPerson?: string;
@@ -448,6 +454,9 @@ export declare const mjBizAppsOrdersEntitlementGrantSchema: z.ZodObject<{
     ProvisionedAt?: Date;
     ValidityModeApplied?: "EventWindow" | "FixedDuration" | "Perpetual" | "SubscriptionTerm";
     SubscriptionTermID?: string;
+    GrantTimingApplied?: "OnActivation" | "OnConfirm" | "OnFirstPayment" | "OnPaidInFull";
+    SuspendedAt?: Date;
+    SuspensionReason?: "AwaitingActivation" | "AwaitingPayment" | "PastDue";
     ProductEntitlement?: string;
     Subscription?: string;
     BeneficiaryPerson?: string;
@@ -1578,6 +1587,7 @@ export declare const mjBizAppsOrdersPaymentHeaderSchema: z.ZodObject<{
     IdempotencyKey: z.ZodNullable<z.ZodString>;
     __mj_CreatedAt: z.ZodDate;
     __mj_UpdatedAt: z.ZodDate;
+    ReversalSource: z.ZodNullable<z.ZodUnion<[z.ZodLiteral<"BankReturn">, z.ZodLiteral<"Refund">]>>;
     ReceivingCompany: z.ZodString;
     BillToPerson: z.ZodNullable<z.ZodString>;
     BillToOrganization: z.ZodNullable<z.ZodString>;
@@ -1619,6 +1629,7 @@ export declare const mjBizAppsOrdersPaymentHeaderSchema: z.ZodObject<{
     ProviderRefundID?: string;
     ReversesPaymentHeaderID?: string;
     IdempotencyKey?: string;
+    ReversalSource?: "BankReturn" | "Refund";
     ReceivingCompany?: string;
     ReversesPaymentHeader?: string;
 }, {
@@ -1653,6 +1664,7 @@ export declare const mjBizAppsOrdersPaymentHeaderSchema: z.ZodObject<{
     ProviderRefundID?: string;
     ReversesPaymentHeaderID?: string;
     IdempotencyKey?: string;
+    ReversalSource?: "BankReturn" | "Refund";
     ReceivingCompany?: string;
     ReversesPaymentHeader?: string;
 }>;
@@ -2121,7 +2133,7 @@ export declare const mjBizAppsOrdersProductCategorySchema: z.ZodObject<{
     IsActive: z.ZodBoolean;
     DefaultIsTaxable: z.ZodNullable<z.ZodBoolean>;
     DefaultTaxCategory: z.ZodNullable<z.ZodString>;
-    DefaultEntitlementGrantTiming: z.ZodNullable<z.ZodUnion<[z.ZodLiteral<"OnActivation">, z.ZodLiteral<"OnConfirm">, z.ZodLiteral<"OnPaidInFull">]>>;
+    DefaultEntitlementGrantTiming: z.ZodNullable<z.ZodUnion<[z.ZodLiteral<"OnActivation">, z.ZodLiteral<"OnConfirm">, z.ZodLiteral<"OnFirstPayment">, z.ZodLiteral<"OnPaidInFull">]>>;
     DefaultEntitlementQuantityMode: z.ZodNullable<z.ZodUnion<[z.ZodLiteral<"Flat">, z.ZodLiteral<"PerUnit">]>>;
     DefaultEntitlementValidityMode: z.ZodNullable<z.ZodUnion<[z.ZodLiteral<"EventWindow">, z.ZodLiteral<"FixedDuration">, z.ZodLiteral<"Perpetual">, z.ZodLiteral<"SubscriptionTerm">]>>;
     __mj_CreatedAt: z.ZodDate;
@@ -2148,7 +2160,7 @@ export declare const mjBizAppsOrdersProductCategorySchema: z.ZodObject<{
     ParentProductCategoryID?: string;
     DefaultIsTaxable?: boolean;
     DefaultTaxCategory?: string;
-    DefaultEntitlementGrantTiming?: "OnActivation" | "OnConfirm" | "OnPaidInFull";
+    DefaultEntitlementGrantTiming?: "OnActivation" | "OnConfirm" | "OnFirstPayment" | "OnPaidInFull";
     DefaultEntitlementQuantityMode?: "Flat" | "PerUnit";
     DefaultEntitlementValidityMode?: "EventWindow" | "FixedDuration" | "Perpetual" | "SubscriptionTerm";
     ParentProductCategory?: string;
@@ -2171,7 +2183,7 @@ export declare const mjBizAppsOrdersProductCategorySchema: z.ZodObject<{
     ParentProductCategoryID?: string;
     DefaultIsTaxable?: boolean;
     DefaultTaxCategory?: string;
-    DefaultEntitlementGrantTiming?: "OnActivation" | "OnConfirm" | "OnPaidInFull";
+    DefaultEntitlementGrantTiming?: "OnActivation" | "OnConfirm" | "OnFirstPayment" | "OnPaidInFull";
     DefaultEntitlementQuantityMode?: "Flat" | "PerUnit";
     DefaultEntitlementValidityMode?: "EventWindow" | "FixedDuration" | "Perpetual" | "SubscriptionTerm";
     ParentProductCategory?: string;
@@ -2346,7 +2358,7 @@ export declare const mjBizAppsOrdersProductTypeSchema: z.ZodObject<{
     ProductExtensionEntity: z.ZodNullable<z.ZodString>;
     OrderLineExtensionEntity: z.ZodNullable<z.ZodString>;
     IsActive: z.ZodBoolean;
-    DefaultEntitlementGrantTiming: z.ZodUnion<[z.ZodLiteral<"OnActivation">, z.ZodLiteral<"OnConfirm">, z.ZodLiteral<"OnPaidInFull">]>;
+    DefaultEntitlementGrantTiming: z.ZodUnion<[z.ZodLiteral<"OnActivation">, z.ZodLiteral<"OnConfirm">, z.ZodLiteral<"OnFirstPayment">, z.ZodLiteral<"OnPaidInFull">]>;
     DefaultEntitlementQuantityMode: z.ZodUnion<[z.ZodLiteral<"Flat">, z.ZodLiteral<"PerUnit">]>;
     DefaultEntitlementValidityMode: z.ZodUnion<[z.ZodLiteral<"EventWindow">, z.ZodLiteral<"FixedDuration">, z.ZodLiteral<"Perpetual">, z.ZodLiteral<"SubscriptionTerm">]>;
     __mj_CreatedAt: z.ZodDate;
@@ -2367,7 +2379,7 @@ export declare const mjBizAppsOrdersProductTypeSchema: z.ZodObject<{
     PricingDriverClass?: string;
     DefaultIsTaxable?: boolean;
     DefaultTaxCategory?: string;
-    DefaultEntitlementGrantTiming?: "OnActivation" | "OnConfirm" | "OnPaidInFull";
+    DefaultEntitlementGrantTiming?: "OnActivation" | "OnConfirm" | "OnFirstPayment" | "OnPaidInFull";
     DefaultEntitlementQuantityMode?: "Flat" | "PerUnit";
     DefaultEntitlementValidityMode?: "EventWindow" | "FixedDuration" | "Perpetual" | "SubscriptionTerm";
     RequiresFulfillment?: boolean;
@@ -2389,7 +2401,7 @@ export declare const mjBizAppsOrdersProductTypeSchema: z.ZodObject<{
     PricingDriverClass?: string;
     DefaultIsTaxable?: boolean;
     DefaultTaxCategory?: string;
-    DefaultEntitlementGrantTiming?: "OnActivation" | "OnConfirm" | "OnPaidInFull";
+    DefaultEntitlementGrantTiming?: "OnActivation" | "OnConfirm" | "OnFirstPayment" | "OnPaidInFull";
     DefaultEntitlementQuantityMode?: "Flat" | "PerUnit";
     DefaultEntitlementValidityMode?: "EventWindow" | "FixedDuration" | "Perpetual" | "SubscriptionTerm";
     RequiresFulfillment?: boolean;
@@ -2421,7 +2433,7 @@ export declare const mjBizAppsOrdersProductSchema: z.ZodObject<{
     IsTaxable: z.ZodNullable<z.ZodBoolean>;
     Description: z.ZodNullable<z.ZodString>;
     TaxCategory: z.ZodNullable<z.ZodString>;
-    EntitlementGrantTiming: z.ZodNullable<z.ZodUnion<[z.ZodLiteral<"OnActivation">, z.ZodLiteral<"OnConfirm">, z.ZodLiteral<"OnPaidInFull">]>>;
+    EntitlementGrantTiming: z.ZodNullable<z.ZodUnion<[z.ZodLiteral<"OnActivation">, z.ZodLiteral<"OnConfirm">, z.ZodLiteral<"OnFirstPayment">, z.ZodLiteral<"OnPaidInFull">]>>;
     EntitlementQuantityMode: z.ZodNullable<z.ZodUnion<[z.ZodLiteral<"Flat">, z.ZodLiteral<"PerUnit">]>>;
     EntitlementValidityMode: z.ZodNullable<z.ZodUnion<[z.ZodLiteral<"EventWindow">, z.ZodLiteral<"FixedDuration">, z.ZodLiteral<"Perpetual">, z.ZodLiteral<"SubscriptionTerm">]>>;
     __mj_CreatedAt: z.ZodDate;
@@ -2454,7 +2466,7 @@ export declare const mjBizAppsOrdersProductSchema: z.ZodObject<{
     StandaloneSellingPrice?: number;
     SubscriptionTypeID?: string;
     IsTaxable?: boolean;
-    EntitlementGrantTiming?: "OnActivation" | "OnConfirm" | "OnPaidInFull";
+    EntitlementGrantTiming?: "OnActivation" | "OnConfirm" | "OnFirstPayment" | "OnPaidInFull";
     EntitlementQuantityMode?: "Flat" | "PerUnit";
     EntitlementValidityMode?: "EventWindow" | "FixedDuration" | "Perpetual" | "SubscriptionTerm";
     PricingDriverClass?: string;
@@ -2484,7 +2496,7 @@ export declare const mjBizAppsOrdersProductSchema: z.ZodObject<{
     StandaloneSellingPrice?: number;
     SubscriptionTypeID?: string;
     IsTaxable?: boolean;
-    EntitlementGrantTiming?: "OnActivation" | "OnConfirm" | "OnPaidInFull";
+    EntitlementGrantTiming?: "OnActivation" | "OnConfirm" | "OnFirstPayment" | "OnPaidInFull";
     EntitlementQuantityMode?: "Flat" | "PerUnit";
     EntitlementValidityMode?: "EventWindow" | "FixedDuration" | "Perpetual" | "SubscriptionTerm";
     PricingDriverClass?: string;
@@ -2899,7 +2911,7 @@ export declare const mjBizAppsOrdersStoredValueTransactionSchema: z.ZodObject<{
     Amount?: number;
     StoredValueAccountID?: string;
     StoredValueAccount?: string;
-    TransactionType?: "Adjust" | "Expire" | "Issue" | "Redeem" | "Refund";
+    TransactionType?: "Refund" | "Adjust" | "Expire" | "Issue" | "Redeem";
     BalanceAfter?: number;
     RelatedPaymentID?: string;
     RelatedOrderHeaderID?: string;
@@ -2913,7 +2925,7 @@ export declare const mjBizAppsOrdersStoredValueTransactionSchema: z.ZodObject<{
     Amount?: number;
     StoredValueAccountID?: string;
     StoredValueAccount?: string;
-    TransactionType?: "Adjust" | "Expire" | "Issue" | "Redeem" | "Refund";
+    TransactionType?: "Refund" | "Adjust" | "Expire" | "Issue" | "Redeem";
     BalanceAfter?: number;
     RelatedPaymentID?: string;
     RelatedOrderHeaderID?: string;
@@ -4533,6 +4545,41 @@ export declare class mjBizAppsOrdersEntitlementGrantEntity extends BaseEntity<mj
     */
     get __mj_UpdatedAt(): Date;
     /**
+    * * Field Name: GrantTimingApplied
+    * * Display Name: Grant Timing Applied
+    * * SQL Data Type: nvarchar(20)
+    * * Value List Type: List
+    * * Possible Values
+    *   * OnActivation
+    *   * OnConfirm
+    *   * OnFirstPayment
+    *   * OnPaidInFull
+    * * Description: The grant timing that produced this grant (OnConfirm, OnPaidInFull, OnFirstPayment, OnActivation), resolved at confirm from product, category and product type. Access is re-decided from this when the order's payments change. NULL on grants written before the column existed.
+    */
+    get GrantTimingApplied(): 'OnActivation' | 'OnConfirm' | 'OnFirstPayment' | 'OnPaidInFull' | null;
+    set GrantTimingApplied(value: 'OnActivation' | 'OnConfirm' | 'OnFirstPayment' | 'OnPaidInFull' | null);
+    /**
+    * * Field Name: SuspendedAt
+    * * Display Name: Suspended At
+    * * SQL Data Type: datetimeoffset
+    * * Description: When the grant was last suspended. Set together with SuspensionReason and cleared when the grant becomes Active again.
+    */
+    get SuspendedAt(): Date | null;
+    set SuspendedAt(value: Date | null);
+    /**
+    * * Field Name: SuspensionReason
+    * * Display Name: Suspension Reason
+    * * SQL Data Type: nvarchar(20)
+    * * Value List Type: List
+    * * Possible Values
+    *   * AwaitingActivation
+    *   * AwaitingPayment
+    *   * PastDue
+    * * Description: Why the grant is suspended: AwaitingPayment (a new purchase whose first payment has not been received), PastDue (a renewal past the configured cutoff), or AwaitingActivation. AwaitingPayment and PastDue are lifted automatically when payment arrives.
+    */
+    get SuspensionReason(): 'AwaitingActivation' | 'AwaitingPayment' | 'PastDue' | null;
+    set SuspensionReason(value: 'AwaitingActivation' | 'AwaitingPayment' | 'PastDue' | null);
+    /**
     * * Field Name: ProductEntitlement
     * * Display Name: Product Entitlement Name
     * * SQL Data Type: nvarchar(200)
@@ -7980,6 +8027,18 @@ export declare class mjBizAppsOrdersPaymentHeaderEntity extends BaseEntity<mjBiz
     */
     get __mj_UpdatedAt(): Date;
     /**
+    * * Field Name: ReversalSource
+    * * Display Name: Reversal Source
+    * * SQL Data Type: nvarchar(20)
+    * * Value List Type: List
+    * * Possible Values
+    *   * BankReturn
+    *   * Refund
+    * * Description: Who took the money back on a reversal: Refund (the seller chose to, via Orders.RefundPayment) or BankReturn (the bank reversed a debit). Set on every reversal and on nothing else. A bank return removes payment-gated access; a refund does not.
+    */
+    get ReversalSource(): 'BankReturn' | 'Refund' | null;
+    set ReversalSource(value: 'BankReturn' | 'Refund' | null);
+    /**
     * * Field Name: ReceivingCompany
     * * Display Name: Receiving Company Name
     * * SQL Data Type: nvarchar(50)
@@ -9494,10 +9553,11 @@ export declare class mjBizAppsOrdersProductCategoryEntity extends BaseEntity<mjB
     * * Possible Values
     *   * OnActivation
     *   * OnConfirm
+    *   * OnFirstPayment
     *   * OnPaidInFull
     */
-    get DefaultEntitlementGrantTiming(): 'OnActivation' | 'OnConfirm' | 'OnPaidInFull' | null;
-    set DefaultEntitlementGrantTiming(value: 'OnActivation' | 'OnConfirm' | 'OnPaidInFull' | null);
+    get DefaultEntitlementGrantTiming(): 'OnActivation' | 'OnConfirm' | 'OnFirstPayment' | 'OnPaidInFull' | null;
+    set DefaultEntitlementGrantTiming(value: 'OnActivation' | 'OnConfirm' | 'OnFirstPayment' | 'OnPaidInFull' | null);
     /**
     * * Field Name: DefaultEntitlementQuantityMode
     * * Display Name: Default Entitlement Quantity Mode
@@ -10228,10 +10288,11 @@ export declare class mjBizAppsOrdersProductTypeEntity extends BaseEntity<mjBizAp
     * * Possible Values
     *   * OnActivation
     *   * OnConfirm
+    *   * OnFirstPayment
     *   * OnPaidInFull
     */
-    get DefaultEntitlementGrantTiming(): 'OnActivation' | 'OnConfirm' | 'OnPaidInFull';
-    set DefaultEntitlementGrantTiming(value: 'OnActivation' | 'OnConfirm' | 'OnPaidInFull');
+    get DefaultEntitlementGrantTiming(): 'OnActivation' | 'OnConfirm' | 'OnFirstPayment' | 'OnPaidInFull';
+    set DefaultEntitlementGrantTiming(value: 'OnActivation' | 'OnConfirm' | 'OnFirstPayment' | 'OnPaidInFull');
     /**
     * * Field Name: DefaultEntitlementQuantityMode
     * * Display Name: Default Entitlement Quantity Mode
@@ -10510,10 +10571,11 @@ export declare class mjBizAppsOrdersProductEntity extends BaseEntity<mjBizAppsOr
     * * Possible Values
     *   * OnActivation
     *   * OnConfirm
+    *   * OnFirstPayment
     *   * OnPaidInFull
     */
-    get EntitlementGrantTiming(): 'OnActivation' | 'OnConfirm' | 'OnPaidInFull' | null;
-    set EntitlementGrantTiming(value: 'OnActivation' | 'OnConfirm' | 'OnPaidInFull' | null);
+    get EntitlementGrantTiming(): 'OnActivation' | 'OnConfirm' | 'OnFirstPayment' | 'OnPaidInFull' | null;
+    set EntitlementGrantTiming(value: 'OnActivation' | 'OnConfirm' | 'OnFirstPayment' | 'OnPaidInFull' | null);
     /**
     * * Field Name: EntitlementQuantityMode
     * * Display Name: Entitlement Quantity Mode