@fragus/sam-types 1.2.0 → 1.2.2

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.2.0",
+  "version": "1.2.2",
   "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/contractProvider.d.ts

@@ -41,11 +41,6 @@ export interface IContractProviderRequest extends IProviderCustomizationResponse
   optionsConditions?: string
   fetchWarrantiesFromV4: boolean
   hiddenNetPrice: boolean
-  /** Restricts the provider to the Fragus gateways while on. */
-  fragusInvoicing?: boolean
-  /** New contracts use the provider's one fixed customer while on. */
-  isInternalUse?: boolean
-  fixedCustomer?: IFixedCustomerData
   v4ProviderId: number | null
   /** Groups the provider joins on create; an update ignores it. */
   contractProviderGroupIds?: number[]
@@ -98,7 +93,9 @@ export interface IContractProviderResponse extends IProviderCustomizationRespons
   created: Date
   updated: Date
   hiddenNetPrice: boolean
+  /** Read-only, from the provider's `FRAGUS_INVOICING` flag. */
   fragusInvoicing?: boolean
+  /** Read-only, from the provider's `INTERNAL_USE` flag. */
   isInternalUse?: boolean
   fixedCustomer?: IFixedCustomerData | null
   v4ProviderId: number | null
@@ -110,6 +107,7 @@ export interface IFixedCustomerData {
   companyName: string
   cvr: string
   phone: string
+  email: string
   address1: string
   postalCode: string
   city: string

package/types/contractProviderFlags.d.ts

@@ -1,4 +1,4 @@
-export type TContractProviderFlagKey = 'RENAULT_UNIQ_PDF_FORMAT'
+export type TContractProviderFlagKey = 'RENAULT_UNIQ_PDF_FORMAT' | 'FRAGUS_INVOICING' | 'INTERNAL_USE'
 
 /** Exactly one of the two ids is sent: a flag row is owned by a provider or by a group. */
 export interface ContractProviderFlagRequest {

package/types/fragusInvoicing.d.ts

@@ -0,0 +1,19 @@
+import { IFixedCustomerData } from './contractProvider'
+
+export interface IFragusInvoicingProviderRequest {
+  contractProviderId: number
+}
+
+export interface IFragusInvoicingProviderResponse {
+  contractProviderId: number
+  contractProviderName: string
+  country: string
+  updatedByUser: string
+  isInternalUse: boolean
+  /** The saved fixed customer, or a prefill built from the provider's contact person. */
+  fixedCustomer: IFixedCustomerData
+}
+
+export interface IInternalUseRequest {
+  fixedCustomer: IFixedCustomerData
+}

package/types/index.d.ts

@@ -219,5 +219,6 @@ export * from './pinLookup';
 export * from './ISendEmail';
 export * from './emailCampaign';
 export * from './contractProviderFlags';
+export * from './fragusInvoicing';
 export * from './providerDocument';
 export * from './contractProviderGroup';

package/types/index.ts

@@ -238,5 +238,6 @@ export * from './pinLookup'
 export * from './ISendEmail'
 export * from './emailCampaign'
 export * from './contractProviderFlags'
+export * from './fragusInvoicing'
 export * from './providerDocument'
 export * from './contractProviderGroup'

package/types/providerInvoice.d.ts

@@ -1,4 +1,4 @@
-import { TCurrency } from './currency'
+import { PriceSpecification } from './priceSpecification'
 
 export type ProviderInvoiceState = 'Pending' | 'Paid' | 'Canceled'
 
@@ -6,14 +6,11 @@ export type BillingEntrySource = 'Stripe' | 'Fragus'
 
 export type BillingEntryKind = 'Subscription' | 'PrePaid'
 
-// Amounts are in cents, excl. VAT.
 export interface IProviderInvoiceListRecord {
   id: number
   period: string // YYYY-MM
   state: ProviderInvoiceState
-  amount: number
-  vat: number
-  currency: TCurrency
+  amount: PriceSpecification
   contractCount: number
   created: string // ISO
 }
@@ -25,9 +22,7 @@ export interface IContractBillingEntry {
   kind: BillingEntryKind
   coverageStart: string // ISO
   coverageEnd: string // ISO, exclusive
-  amount: number
-  vat: number
-  currency: TCurrency
+  amount: PriceSpecification
 }
 
 export interface IProviderInvoiceDetails extends IProviderInvoiceListRecord {

package/types/responseErrors/contractResponseErrors.d.ts

@@ -27,9 +27,10 @@ type FragusInvoicingErrors =
   | 'FRAGUS_INVOICING_WEBCALC_NOT_AVAILABLE'
   | 'FRAGUS_INVOICING_HAS_FRAGUS_CONTRACTS'
   | 'FRAGUS_INVOICING_DEALER_PAID_NOT_AVAILABLE'
+  | 'FRAGUS_INVOICING_HAS_INTERNAL_USE'
 
 type InternalUseErrors =
-  | 'INTERNAL_USE_REQUIRES_NON_CARD_GATEWAY'
+  | 'INTERNAL_USE_REQUIRES_FRAGUS_INVOICING'
   | 'INTERNAL_USE_NOT_ENABLED'
   | 'INTERNAL_USE_OFFER_NOT_AVAILABLE'
   | 'INTERNAL_USE_STRIPE_NOT_AVAILABLE'