@nimee/shared-types 1.0.322 → 1.0.324

package/dist/account/account.d.ts

@@ -67,7 +67,9 @@ export declare enum InvoiceProviderType {
 export declare enum InvoiceDocTypeEnum {
     INVOICE_RECEIPT = "invrec",
     RECEIPT = "receipt",
-    REFUND = "refund"
+    REFUND = "refund",
+    /** קבלה זיכוי — reversal of a RECEIPT sale (Nimi invoices service; no VAT-invoice semantics) */
+    RECEIPT_REFUND = "receipt_refund"
 }
 export interface IBankDetails {
     bankNumber: string;
@@ -95,6 +97,48 @@ export interface IWalletDesign {
         fields: IWalletLayoutField[];
     };
 }
+/**
+ * Groups gate scans into named entrance rows on the activity report. Rules are tried in
+ * order and the first whose `match` appears in the event name wins; scans matching no rule
+ * fall to `entranceFallbackLabel`. A venue with a single gate can omit rules entirely, in
+ * which case the report falls back to one row per event name.
+ */
+export interface IActivityReportEntranceRule {
+    /** Case-insensitive substring matched against the event name. */
+    match: string;
+    /** Row label used for scans of events matching this rule. */
+    label: string;
+}
+export interface IActivityReportScheduleConfig {
+    enabled: boolean;
+    /** Email addresses this report is sent to. Enabled with none set sends nothing. */
+    recipients: string[];
+}
+/**
+ * Opt-in, per-seller configuration for the automated activity reports
+ * (tools/activity-report). Absent or `enabled: false` means the seller is skipped,
+ * so adding a customer is a config change rather than a code change.
+ * Lives on the seller (top-level account) — reports are per seller, scoped by `seller` on
+ * user-events / event-orders / enduser-season-tickets / visits.
+ */
+export interface IActivityReportConfig {
+    /** Same-day report, sent each evening once the venue has closed. */
+    daily?: IActivityReportScheduleConfig;
+    /** Friday-Saturday report, sent Sunday morning. */
+    weekend?: IActivityReportScheduleConfig;
+    /** Second header line. The seller account `name` is always used as the title. */
+    subtitle?: string;
+    entranceRules?: IActivityReportEntranceRule[];
+    /** Label for scans matching no entrance rule. Ignored when no rules are set. */
+    entranceFallbackLabel?: string;
+    /**
+     * Send even when the window has zero scans, sales and subscriptions. Off by default,
+     * because for a venue open every day an all-zeros report almost always means a data or
+     * connection problem rather than a quiet day. Turn on for venues that genuinely close
+     * on some days, which would otherwise raise a failure alert every time.
+     */
+    allowEmpty?: boolean;
+}
 export interface IAccountModel {
     idInsidePaymentProvider: string;
     name: string;
@@ -244,6 +288,7 @@ export interface IAccountModel {
         enabled: boolean;
         recipients: string[];
     };
+    activityReportConfig?: IActivityReportConfig;
 }
 export interface IPaymeUpdateOrCreateSellerWebhookPayload {
     seller_payme_id: string;

package/dist/account/account.js

@@ -52,6 +52,8 @@ var InvoiceDocTypeEnum;
     InvoiceDocTypeEnum["INVOICE_RECEIPT"] = "invrec";
     InvoiceDocTypeEnum["RECEIPT"] = "receipt";
     InvoiceDocTypeEnum["REFUND"] = "refund";
+    /** קבלה זיכוי — reversal of a RECEIPT sale (Nimi invoices service; no VAT-invoice semantics) */
+    InvoiceDocTypeEnum["RECEIPT_REFUND"] = "receipt_refund";
 })(InvoiceDocTypeEnum || (exports.InvoiceDocTypeEnum = InvoiceDocTypeEnum = {}));
 var IAccountStatusEnum;
 (function (IAccountStatusEnum) {

package/dist/account/account.js.map

@@ -1 +1 @@
-{"version":3,"file":"account.js","sourceRoot":"","sources":["../../src/account/account.ts"],"names":[],"mappings":";;;AAMA,IAAY,kBAUX;AAVD,WAAY,kBAAkB;IAC5B,iEAAW,CAAA;IACX,iEAAW,CAAA;IACX,iEAAW,CAAA;IACX,mEAAY,CAAA;IACZ,+DAAU,CAAA;IACV,+DAAU,CAAA;IACV,iEAAW,CAAA;IACX,6DAAS,CAAA;IACT,6DAAS,CAAA;AACX,CAAC,EAVW,kBAAkB,kCAAlB,kBAAkB,QAU7B;AACD,IAAY,aAUX;AAVD,WAAY,aAAa;IACvB,oCAAmB,CAAA;IACnB,oCAAmB,CAAA;IACnB,oCAAmB,CAAA;IACnB,kCAAiB,CAAA;IACjB,kCAAiB,CAAA;IACjB,oCAAmB,CAAA;IACnB,gCAAe,CAAA;IACf,gCAAe,CAAA;IACf,sCAAqB,CAAA;AACvB,CAAC,EAVW,aAAa,6BAAb,aAAa,QAUxB;AACD,IAAY,iBAQX;AARD,WAAY,iBAAiB;IAC3B,kDAA6B,CAAA;IAC7B,kDAA6B,CAAA;IAC7B,sCAAiB,CAAA;IACjB,oCAAe,CAAA;IACf,sCAAiB,CAAA;IACjB,wCAAmB,CAAA;IACnB,0CAAqB,CAAA;AACvB,CAAC,EARW,iBAAiB,iCAAjB,iBAAiB,QAQ5B;AAgBD,IAAY,qBAIX;AAJD,WAAY,qBAAqB;IAC/B,sCAAa,CAAA;IACb,4CAAmB,CAAA;IACnB,8CAAqB,CAAA;AACvB,CAAC,EAJW,qBAAqB,qCAArB,qBAAqB,QAIhC;AAMD,IAAY,mBAIX;AAJD,WAAY,mBAAmB;IAC7B,wCAAiB,CAAA;IACjB,wEAAwE;IACxE,oCAAa,CAAA;AACf,CAAC,EAJW,mBAAmB,mCAAnB,mBAAmB,QAI9B;AAED,IAAY,kBAIX;AAJD,WAAY,kBAAkB;IAC5B,gDAA0B,CAAA;IAC1B,yCAAmB,CAAA;IACnB,uCAAiB,CAAA;AACnB,CAAC,EAJW,kBAAkB,kCAAlB,kBAAkB,QAI7B;AA2ND,IAAY,kBAMX;AAND,WAAY,kBAAkB;IAC5B,yCAAmB,CAAA;IACnB,yCAAmB,CAAA;IACnB,uCAAiB,CAAA;IACjB,6CAAuB,CAAA;IACvB,yCAAmB,CAAA;AACrB,CAAC,EANW,kBAAkB,kCAAlB,kBAAkB,QAM7B"}
+{"version":3,"file":"account.js","sourceRoot":"","sources":["../../src/account/account.ts"],"names":[],"mappings":";;;AAMA,IAAY,kBAUX;AAVD,WAAY,kBAAkB;IAC5B,iEAAW,CAAA;IACX,iEAAW,CAAA;IACX,iEAAW,CAAA;IACX,mEAAY,CAAA;IACZ,+DAAU,CAAA;IACV,+DAAU,CAAA;IACV,iEAAW,CAAA;IACX,6DAAS,CAAA;IACT,6DAAS,CAAA;AACX,CAAC,EAVW,kBAAkB,kCAAlB,kBAAkB,QAU7B;AACD,IAAY,aAUX;AAVD,WAAY,aAAa;IACvB,oCAAmB,CAAA;IACnB,oCAAmB,CAAA;IACnB,oCAAmB,CAAA;IACnB,kCAAiB,CAAA;IACjB,kCAAiB,CAAA;IACjB,oCAAmB,CAAA;IACnB,gCAAe,CAAA;IACf,gCAAe,CAAA;IACf,sCAAqB,CAAA;AACvB,CAAC,EAVW,aAAa,6BAAb,aAAa,QAUxB;AACD,IAAY,iBAQX;AARD,WAAY,iBAAiB;IAC3B,kDAA6B,CAAA;IAC7B,kDAA6B,CAAA;IAC7B,sCAAiB,CAAA;IACjB,oCAAe,CAAA;IACf,sCAAiB,CAAA;IACjB,wCAAmB,CAAA;IACnB,0CAAqB,CAAA;AACvB,CAAC,EARW,iBAAiB,iCAAjB,iBAAiB,QAQ5B;AAgBD,IAAY,qBAIX;AAJD,WAAY,qBAAqB;IAC/B,sCAAa,CAAA;IACb,4CAAmB,CAAA;IACnB,8CAAqB,CAAA;AACvB,CAAC,EAJW,qBAAqB,qCAArB,qBAAqB,QAIhC;AAMD,IAAY,mBAIX;AAJD,WAAY,mBAAmB;IAC7B,wCAAiB,CAAA;IACjB,wEAAwE;IACxE,oCAAa,CAAA;AACf,CAAC,EAJW,mBAAmB,mCAAnB,mBAAmB,QAI9B;AAED,IAAY,kBAMX;AAND,WAAY,kBAAkB;IAC5B,gDAA0B,CAAA;IAC1B,yCAAmB,CAAA;IACnB,uCAAiB,CAAA;IACjB,gGAAgG;IAChG,uDAAiC,CAAA;AACnC,CAAC,EANW,kBAAkB,kCAAlB,kBAAkB,QAM7B;AA0QD,IAAY,kBAMX;AAND,WAAY,kBAAkB;IAC5B,yCAAmB,CAAA;IACnB,yCAAmB,CAAA;IACnB,uCAAiB,CAAA;IACjB,6CAAuB,CAAA;IACvB,yCAAmB,CAAA;AACrB,CAAC,EANW,kBAAkB,kCAAlB,kBAAkB,QAM7B"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nimee/shared-types",
-  "version": "1.0.322",
+  "version": "1.0.324",
   "description": "Types and interfaces that any service can access if needed",
   "main": "dist/index.js",
   "author": "dan goldberg",

package/src/account/account.ts

@@ -70,6 +70,8 @@ export enum InvoiceDocTypeEnum {
   INVOICE_RECEIPT = "invrec",
   RECEIPT = "receipt",
   REFUND = "refund",
+  /** קבלה זיכוי — reversal of a RECEIPT sale (Nimi invoices service; no VAT-invoice semantics) */
+  RECEIPT_REFUND = "receipt_refund",
 }
 
 export interface IBankDetails {
@@ -102,6 +104,51 @@ export interface IWalletDesign {
   };
 }
 
+/**
+ * Groups gate scans into named entrance rows on the activity report. Rules are tried in
+ * order and the first whose `match` appears in the event name wins; scans matching no rule
+ * fall to `entranceFallbackLabel`. A venue with a single gate can omit rules entirely, in
+ * which case the report falls back to one row per event name.
+ */
+export interface IActivityReportEntranceRule {
+  /** Case-insensitive substring matched against the event name. */
+  match: string;
+  /** Row label used for scans of events matching this rule. */
+  label: string;
+}
+
+export interface IActivityReportScheduleConfig {
+  enabled: boolean;
+  /** Email addresses this report is sent to. Enabled with none set sends nothing. */
+  recipients: string[];
+}
+
+/**
+ * Opt-in, per-seller configuration for the automated activity reports
+ * (tools/activity-report). Absent or `enabled: false` means the seller is skipped,
+ * so adding a customer is a config change rather than a code change.
+ * Lives on the seller (top-level account) — reports are per seller, scoped by `seller` on
+ * user-events / event-orders / enduser-season-tickets / visits.
+ */
+export interface IActivityReportConfig {
+  /** Same-day report, sent each evening once the venue has closed. */
+  daily?: IActivityReportScheduleConfig;
+  /** Friday-Saturday report, sent Sunday morning. */
+  weekend?: IActivityReportScheduleConfig;
+  /** Second header line. The seller account `name` is always used as the title. */
+  subtitle?: string;
+  entranceRules?: IActivityReportEntranceRule[];
+  /** Label for scans matching no entrance rule. Ignored when no rules are set. */
+  entranceFallbackLabel?: string;
+  /**
+   * Send even when the window has zero scans, sales and subscriptions. Off by default,
+   * because for a venue open every day an all-zeros report almost always means a data or
+   * connection problem rather than a quiet day. Turn on for venues that genuinely close
+   * on some days, which would otherwise raise a failure alert every time.
+   */
+  allowEmpty?: boolean;
+}
+
 export interface IAccountModel {
   idInsidePaymentProvider: string;
   name: string;
@@ -247,6 +294,8 @@ export interface IAccountModel {
     enabled: boolean;
     recipients: string[];
   };
+  // Opt-in automated activity reports (daily / weekend), see tools/activity-report.
+  activityReportConfig?: IActivityReportConfig;
 }
 // {"payme_status":"success","status_error_code":0,"status_code":0,"seller_payme_id":"MPL16720-72349IAE-FRITPXY5-TFLDUEWF","seller_created":"2022-12-26 18:32:29","seller_first_name":"Ron","seller_last_name":"Dahan","seller_social_id":"205569163","seller_birthdate":"1994-07-01","seller_date_of_birth":"1994-07-01","seller_gender":0,"seller_email":"roncho1794@gmail.com","seller_contact_email":"roncho1794@gmail.com","seller_phone":"+972542323517","seller_contact_phone":"+972542323517","seller_address_city":"Tel Aviv","seller_address_street":"Tel Aviv","seller_address_street_number":"12","seller_address_country":"IL","seller_inc":0,"seller_inc_code":"12345","seller_merchant_name":"Ronen","seller_site_url":"www.no.co.il","seller_custom_details":"No existing Isracard MID","seller_active":true,"seller_approved":false,"seller_market_fee":0,"seller_currencies":,"fee_default_processing_fee":"1.50","fee_default_processing_charge":"0.100000000000000000","fee_default_discount_fee":"0.50","fee_foreign_processing_fee":"2.95","fee_foreign_processing_charge":"0.100000000000000000","fee_forcurr_processing_charge":"0.100000000000000000","seller_public_key":{"uuid":"b40a5251-9907-4db1-8f26-c015dd9466df","description":"PayMe-Public-Key","is_active":true},"notify_type":"seller-create"}