@fragus/sam-types 1.1.4 → 1.1.5

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.1.4",
+  "version": "1.1.5",
   "name": "@fragus/sam-types",
   "description": "Typescript interfaces for all types used to communicate between SAM client(s) and the SAM API",
   "author": "Fragus",

package/types/accessKey/index.d.ts

@@ -1,5 +1,8 @@
 import { AccessKeyPermission, AccessKeyService, TIsoCountry } from '../index'
 
+/** How an access key chooses its providers: country-scoped, manually scoped, or group-scoped. */
+export type TAccessKeyScopeMode = 'all' | 'manual' | 'group'
+
 export interface IAccessKey {
   accessKeyId: number
   apiKey: string
@@ -10,5 +13,7 @@ export interface IAccessKey {
   contractProviderIds: number[]
   allProvidersAllowed: boolean
   isoCountries: TIsoCountry[] // scope for allProvidersAllowed; non-empty when it is true
+  scopeMode: TAccessKeyScopeMode
+  contractProviderGroupId: number | null // set only in 'group' mode; resolved live at request time
   description?: string
 }

package/types/admin/vehicleBlacklist/index.d.ts

@@ -6,6 +6,10 @@ export interface IBlacklistedVehicleRequest {
     add: number[]
     remove: number[]
   }
+  contractProviderGroupIds?: {
+    add: number[]
+    remove: number[]
+  }
 }
 
 export interface IBlacklistedVehicleResponse {
@@ -14,11 +18,21 @@ export interface IBlacklistedVehicleResponse {
   model: string
   fuelType: string
   parentRecord?: boolean
+  groupRecord?: boolean
 }
 
 export interface IBlacklistedVehicleListRecord extends IBlacklistedVehicleResponse {
-  providerId: number
-  providerName: string
+  // Null on a group-owned entry: the two owners are exclusive.
+  providerId: number | null
+  providerName: string | null
+  contractProviderGroupId: number | null
+  contractProviderGroupName: string | null
+}
+
+/** Which providers and groups a blacklisted vehicle is registered for. */
+export interface IBlacklistedVehicleScope {
+  providerIds: number[]
+  contractProviderGroupIds: number[]
 }
 
 export type BlacklistedVehicleOrderByType = 'id' | 'brand' | 'model' | 'fuelType'

package/types/contractProviderFlags.d.ts

@@ -1,13 +1,17 @@
 export type TContractProviderFlagKey = 'RENAULT_UNIQ_PDF_FORMAT'
 
+/** Exactly one of the two ids is sent: a flag row is owned by a provider or by a group. */
 export interface ContractProviderFlagRequest {
-  contractProviderId: number
+  contractProviderId?: number
+  contractProviderGroupId?: number
 }
 
 export interface ContractProviderFlagResponse {
   id: number
   featureKey: TContractProviderFlagKey
-  contractProviderId: number
-  contractProviderName: string
+  contractProviderId: number | null
+  contractProviderName: string | null
+  contractProviderGroupId: number | null
+  contractProviderGroupName: string | null
   updatedByUser: string
 }

package/types/contractProviderGroup.d.ts

@@ -0,0 +1,58 @@
+import { ProviderState } from './contractProvider'
+import { EmailCampaignStatus } from './emailCampaign'
+
+export interface IContractProviderGroupMember {
+  contractProviderId: number
+  administrativeName: string
+  isoName: string // country
+  state: ProviderState // lets every picker count Inactive members
+}
+
+export interface IProviderGroupTag {
+  providerGroupTagId: number
+  name: string
+}
+
+export interface IContractProviderGroupListItem {
+  contractProviderGroupId: number
+  name: string
+  description: string | null
+  tags: IProviderGroupTag[]
+  memberCount: number
+  inactiveMemberCount: number
+  archivedAt: string | null // ISO
+  updatedByEmail: string // 'USER NOT FOUND' when the acting user is gone
+}
+
+export type IContractProviderGroupDetail = IContractProviderGroupListItem & {
+  members: IContractProviderGroupMember[]
+  createdAt: string // ISO
+  updatedAt: string // ISO
+}
+
+export interface IContractProviderGroupUsage {
+  accessKeys: { accessKeyId: number; description: string | null }[]
+  emailCampaigns: { id: number; name: string; status: EmailCampaignStatus }[]
+  blacklistEntryCount: number
+  documentCount: number
+  dashboardBannerCount: number
+  featureFlagCount: number
+}
+
+export interface IUpsertContractProviderGroupRequest {
+  name: string
+  description: string | null
+  tags: string[]
+  contractProviderIds: number[]
+}
+
+// The provider-side view of membership: every joinable group, plus any archived group this provider is
+// still in (archived groups can be left but not joined).
+export interface IContractProviderGroupMembership {
+  groups: IContractProviderGroupListItem[]
+  memberGroupIds: number[]
+}
+
+export interface ISetContractProviderGroupsRequest {
+  contractProviderGroupIds: number[] // the full set for one provider; the api diffs it against what is stored
+}

package/types/dashboardBanner.d.ts

@@ -1,32 +1,39 @@
-import { TIsoCountry } from './country';
+import { TIsoCountry } from './country'
+
 /**
  * Request body for creating or updating a dashboard banner (Superadmin)
  */
 export interface DashboardBannerRequest {
-    text: string;
-    countryIso: TIsoCountry;
-    /**
-     * ISO date string (YYYY-MM-DD) for the start date of the banner
-     */
-    startDate: string;
-    /**
-     * ISO date string (YYYY-MM-DD) for the end date of the banner
-     */
-    endDate: string;
+  text: string
+  /**
+   * Exactly one of the two targets the banner: a whole country, or the members of one provider group.
+   * A group banner takes precedence over a country one.
+   */
+  countryIso?: TIsoCountry | null
+  contractProviderGroupId?: number | null
+  /**
+   * ISO date string (YYYY-MM-DD) for the start date of the banner
+   */
+  startDate: string
+  /**
+   * ISO date string (YYYY-MM-DD) for the end date of the banner
+   */
+  endDate: string
 }
 /**
  * Response body for retrieving a dashboard banner (Superadmin)
  */
 export interface DashboardBannerResponse extends DashboardBannerRequest {
-    id: number;
-    /**
-     * Email of the user who last updated the banner
-     */
-    updatedByUser: string;
+  id: number
+  contractProviderGroupName: string | null
+  /**
+   * Email of the user who last updated the banner
+   */
+  updatedByUser: string
 }
 /**
  * Response body for retrieving dashboard banner text in Admin
  */
 export interface ProviderDashboardBannerResponse {
-    text: string;
+  text: string
 }

package/types/emailCampaign.d.ts

@@ -10,12 +10,19 @@ export declare enum EmailCampaignStatus {
 }
 export declare type EmailCampaignRole = 'admin' | 'seller';
 export declare type EmailCampaignSelectionMode = 'all' | 'subset';
+export declare type EmailCampaignProviderMode = EmailCampaignSelectionMode | 'group';
 export declare type EmailCampaignProviderSelection = {
     providerMode: 'all';
     selectedProviderIds: null;
+    selectedGroupIds: null;
 } | {
     providerMode: 'subset';
     selectedProviderIds: number[];
+    selectedGroupIds: null;
+} | {
+    providerMode: 'group';
+    selectedProviderIds: null;
+    selectedGroupIds: number[];
 };
 export declare type EmailCampaignRecipientSelection = {
     recipientMode: 'all';

package/types/emailCampaign.ts

@@ -21,11 +21,15 @@ export type EmailCampaignRole = 'admin' | 'seller'
 // How a pool (providers or recipients) is narrowed: 'all' = every match, 'subset' = explicit ids.
 export type EmailCampaignSelectionMode = 'all' | 'subset'
 
+// The provider dimension has a third mode the recipient dimension does not: 'group'.
+export type EmailCampaignProviderMode = EmailCampaignSelectionMode | 'group'
+
 // Provider dimension: mode is discriminated against its selection, so an invalid combination can't type-check.
 // The candidate-pool filter (`filters`) is carried separately on the request/detail DTOs.
 export type EmailCampaignProviderSelection =
-  | { providerMode: 'all'; selectedProviderIds: null }
-  | { providerMode: 'subset'; selectedProviderIds: number[] }
+  | { providerMode: 'all'; selectedProviderIds: null; selectedGroupIds: null }
+  | { providerMode: 'subset'; selectedProviderIds: number[]; selectedGroupIds: null }
+  | { providerMode: 'group'; selectedProviderIds: null; selectedGroupIds: number[] }
 
 // Recipient dimension: mode is discriminated against its user picks.
 export type EmailCampaignRecipientSelection =

package/types/index.d.ts

@@ -219,3 +219,4 @@ export * from './ISendEmail';
 export * from './emailCampaign';
 export * from './contractProviderFlags';
 export * from './providerDocument';
+export * from './contractProviderGroup';

package/types/index.ts

@@ -238,3 +238,4 @@ export * from './ISendEmail'
 export * from './emailCampaign'
 export * from './contractProviderFlags'
 export * from './providerDocument'
+export * from './contractProviderGroup'

package/types/providerDocument.d.ts

@@ -16,9 +16,12 @@ export interface IProviderDocument {
 // Admin sees the document and its upload date only — no internal staff names.
 export interface IProviderDocumentAdminView extends IProviderDocument {}
 
-// Superadmin additionally sees the acting support users and the tombstone state.
+// Superadmin also sees the acting support users, the tombstone state, and the sharing group. The group
+// fields are null on a provider-owned row.
 export interface IProviderDocumentSuperadminView extends IProviderDocument {
   uploadedByName: string | null
   deletedAt: string | null
   deletedByName: string | null
+  contractProviderGroupId: number | null
+  contractProviderGroupName: string | null
 }

package/types/responseErrors/contractProviderGroupErrors.d.ts

@@ -0,0 +1 @@
+export type ContractProviderGroupErrors = 'CONTRACT_PROVIDER_GROUP_NAME_TAKEN' | 'CONTRACT_PROVIDER_GROUP_IN_USE'

package/types/responseErrors/index.d.ts

@@ -1,6 +1,7 @@
 import { AdjustmentRequestResponseErrors } from './adjustmentRequestResponseErrors'
 import { AdminPaymentErrors } from './adminPaymentErrors'
 import { CalculatorResponseErrors } from './calculatorResponseErrors'
+import { ContractProviderGroupErrors } from './contractProviderGroupErrors'
 import { ContractResponseErrors } from './contractResponseErrors'
 import { GenericResponseErrors } from './genericResponseTypes'
 import { ImportErrors } from './importErrors'
@@ -17,6 +18,7 @@ export type ResponseErrors =
   | AdjustmentRequestResponseErrors
   | AdminPaymentErrors
   | CalculatorResponseErrors
+  | ContractProviderGroupErrors
   | ContractResponseErrors
   | GenericResponseErrors
   | ImportErrors