@fragus/sam-types 1.1.10 → 1.2.0

package/README.md

@@ -1,48 +1,75 @@
 # SAM-types
 
-The TypeScript types shared by SAM-api and its clients: SAM-admin-v2, SAM-superadmin-frontend,
-SAM-webcalc-v2 and MyPage. Requests, responses, error keys and enums live here once, so the API and
-every client agree on what goes over the wire.
+SAM types is used to collect and share all interfaces (types) that one or more repositories have in
+common. To facilitate and ensure that repositories use the same types when communicating with each other.
+In most cases, if not all, this is between SAM-api and one or more of the frontend clients like the SAM-admin.
 
-Published to npm as [`@fragus/sam-types`](https://www.npmjs.com/package/@fragus/sam-types).
+## Conventions
 
-## Using it
+### Request/Response interfaces
+TODO: Fill this out
 
-Each consumer pins an exact version in its `package.json`:
+### Versioning
 
-```json
-"@fragus/sam-types": "1.1.9"
-```
+We use standard [semantic versioning](https://semver.org/)
 
-Import from the package root:
+## Development
+### Dependencies
+The project only has one dependency: `Typescript`
 
-```ts
-import { ContractState, INoContractsAvailableErrorParams } from '@fragus/sam-types'
-```
+This is to have `tsc` available.
 
-## Prerequisites
+### Compiling
 
-- Node.js: the version in `.nvmrc`
-- npm
+To compile the `index.d.ts` file and the `index.js` file, run `npm run tsc` (or `yarn tsc`). This cleans all existing `.js` files and updates the `index.d.ts` file and the `index.js` file.
 
-## Getting started
+### Adding new interfaces, types, and enums
 
-```bash
-npm install
-npm run tsc        # npm run tsc-win on Windows without bash
-```
+Write your interface or type like you normally would. In order to export it, you need to add it to the `index.ts` file which holds all exported interfaces, types, and enums. The enums (for now) need to be put directly in the `index.ts` file. To fix this we need to setup some Webpack configuration etc.
 
-`npm run tsc` deletes the compiled `.js` files and builds the package again. CI runs the same build on
-every push.
+### Local development
 
-## Docs
+### Using npm
+To use the types locally in an application, add the line below as a dependency in your `package.json` file:
 
-- [Adding and changing types](docs/adding-types.md): where a type goes, naming, exports, and the
-  TypeScript 3.3 limit
-- [Testing in a consumer before release](docs/local-development.md): `file:../SAM-types` and how to undo it
-- [Releasing](docs/releasing.md): versioning, the GitHub release that publishes to npm, and bumping the
-  consumers
+`"sam-types": "file:../SAM-types"`
 
-## Branches
+The path is the relative path to the SAM-types project.
+### Using yarn
+To use the types locally you can use `yarn link`. See docs [here](https://yarnpkg.com/lang/en/docs/cli/link/).
 
-`fix/`, `feature/` or `backmerge/` plus a kebab-case description. PRs target `develop`.
+`cd` to the SAM-types folder and type: `yarn link`
+
+Then `cd` to your application and type `yarn link "sam-types"`. Now your application uses your local SAM-types project (using a symlink). To unlink, type `yarn unlink "sam-types"`
+
+This means that you do not have to change anything in your `package.json` file.
+
+### Regular dependency
+To use SAM-types in a project, add the line below as a dependency in your `package.json` file:
+
+`"sam-types": "OmniCar/SAM-types#0.0.1"`
+
+If you need to target something other than a specific release, consider targeting a branch or a commit as shown below:
+
+* `"sam-types": "OmniCar/SAM-types#4727d357ea"`
+* `"sam-types": "OmniCar/SAM-types#feature\/branch"`
+
+## Releasing
+
+### Using GitHub
+
+* Go to [releases](https://github.com/OmniCar/SAM-types/releases) on GitHub
+* Press "Create a new release"
+* Set the "Tag version" to the appropriate version number (see versioning above)
+* Set the "Release title" to "Version <version_number>"
+* Describe the changes. What's new? are there any breaking changes? etc.
+* If you want you can see the changes on `master` compared to a release (for example version `0.0.1`) by typing: `git diff tags/0.0.1 master`
+* Press "Publish release"
+
+### Using [hub cli](https://github.com/github/hub)
+
+If you have installed the hub cli (see link above), you can create a new release with the below command. Please note that it defaults to targeting the main (`master`) branch unless you use the `-t` option (more options [here](https://github.com/github/hub/blob/master/commands/release.go))
+
+`git release create -o -m "Release 0.0.2" "0.0.2"`
+
+If you did not set up the alias for `git = hub` you should write `hub` instead of `git` in the command above.

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.1.10",
+  "version": "1.2.0",
   "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/admin/contract/contractDetails.d.ts

@@ -72,6 +72,8 @@ export interface IContractDetailsBasic {
   mileage: number
   maxEndMileage?: number
   warrantyReference?: string
+  /** The customer is a provider's internal-use fixed customer: no PDF, no owner change. */
+  isFixedCustomer?: boolean
 }
 
 /**

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

@@ -1,3 +1,4 @@
+import { IAdminCustomer } from '../../admin/customer/customer'
 import { IApiOtherWithContracts } from '../../admin/product'
 import { IApiVehicleWithContracts } from '../../admin/vehicle'
 import { IsoLocale } from '../../locale'
@@ -32,6 +33,10 @@ export interface IContractProviderInfo extends IEssentialContractProviderInfo {
   inactive: boolean
   isUsingV4PricingTool: boolean
   isUseV4PTOnlyForSigning: boolean
+  fragusInvoicing?: boolean
+  isInternalUse?: boolean
+  /** Set only while internal use is on. */
+  fixedCustomer?: IAdminCustomer | null
 }
 
 export interface ICreateTestContractProvider {

package/types/contractProvider.d.ts

@@ -41,6 +41,11 @@ 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[]
@@ -93,9 +98,23 @@ export interface IContractProviderResponse extends IProviderCustomizationRespons
   created: Date
   updated: Date
   hiddenNetPrice: boolean
+  fragusInvoicing?: boolean
+  isInternalUse?: boolean
+  fixedCustomer?: IFixedCustomerData | null
   v4ProviderId: number | null
 }
 
+/** The fixed customer of an internal-use provider; its country is the provider's. */
+export interface IFixedCustomerData {
+  name: string
+  companyName: string
+  cvr: string
+  phone: string
+  address1: string
+  postalCode: string
+  city: string
+}
+
 export interface IContractProviderListItemResponse {
   administrativeName: string
   contractProviderId: number
@@ -122,6 +141,7 @@ export type TContractProviderSettingsSection =
   | 'conditions'
   | 'customization'
   | 'cvrCode'
+  | 'fixedCustomer'
 
 export interface IContractProviderSettingsResponse {
   administrativeName: string
@@ -151,6 +171,8 @@ export interface IContractProviderSettingsResponse {
     webLogoBannerUrl: string | null
   }
   hasParent: boolean
+  /** Null while the provider is not in internal use. */
+  fixedCustomer?: IFixedCustomerData | null
 }
 
 export type TContractProviderSettingsSectionValue =
@@ -160,6 +182,7 @@ export type TContractProviderSettingsSectionValue =
   | TProviderConditionsValue
   | TProviderCustomizationValue
   | TProviderCvrCodeValue
+  | IFixedCustomerData
 
 export type TProviderGeneralInfoValue = Pick<
   IContractProviderSettingsResponse,

package/types/index.d.ts

@@ -182,6 +182,7 @@ export * from './priceCalculation';
 export * from './priceSpecification';
 export * from './product';
 export * from './providerBranding';
+export * from './providerInvoice';
 export * from './queryParams';
 export * from './reports/reports';
 export * from './resetPassword';

package/types/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":";;;;;AAAA,IAAY,aAgBX;AAhBD,WAAY,aAAa;IACvB,mDAAS,CAAA;IACT,qDAAW,CAAA;IACX,mEAAkB,CAAA;IAClB,mEAAkB,CAAA;IAClB,qEAAmB,CAAA;IACnB,uDAAY,CAAA;IACZ,qEAAmB,CAAA;IACnB,2FAA8B,CAAA;IAC9B,6DAAe,CAAA;IACf,qFAA2B,CAAA;IAC3B,+DAAgB,CAAA;IAChB,2DAAc,CAAA;IACd,yDAAa,CAAA;IACb,yDAAa,CAAA;IACb,uEAAoB,CAAA;AACtB,CAAC,EAhBW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAgBxB;AAED,IAAY,aAIX;AAJD,WAAY,aAAa;IACvB,uDAAY,CAAA;IACZ,2DAAc,CAAA;IACd,+DAAgB,CAAA;AAClB,CAAC,EAJW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAIxB;AAED,IAAY,MAMX;AAND,WAAY,MAAM;IAChB,iCAAO,CAAA;IACP,mCAAI,CAAA;IACJ,mCAAI,CAAA;IACJ,2CAAQ,CAAA;IACR,yCAAO,CAAA;AACT,CAAC,EANW,MAAM,GAAN,cAAM,KAAN,cAAM,QAMjB;AAED,IAAY,aAIX;AAJD,WAAY,aAAa;IACvB,+CAAO,CAAA;IACP,qDAAM,CAAA;IACN,mDAAK,CAAA;AACP,CAAC,EAJW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAIxB;AAED,IAAY,gBAOX;AAPD,WAAY,gBAAgB;IAC1B,yDAAO,CAAA;IACP,yDAAO,CAAA;IACP,yDAAO,CAAA;IACP,yDAAO,CAAA;IACP,yDAAO,CAAA;IACP,yDAAO,CAAA;AACT,CAAC,EAPW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAO3B;AAED,IAAY,kBAyDX;AAzDD,WAAY,kBAAkB;IAC5B,8FAA0B,CAAA;IAC1B,iEAAY,CAAA;IACZ,uEAAe,CAAA;IACf,iEAAY,CAAA;IACZ,6EAAkB,CAAA;IAClB,2EAAiB,CAAA;IACjB,+FAA2B,CAAA;IAC3B,sGAA+B,CAAA;IAC/B,0EAAiB,CAAA;IACjB,0EAAiB,CAAA;IACjB,sEAAe,CAAA;IACf,2GAAiC,CAAA;IACjC,iGAA4B,CAAA;IAC5B,yGAAgC,CAAA;IAChC,iGAA4B,CAAA;IAC5B,uGAA+B,CAAA;IAC/B,6GAAkC,CAAA;IAClC,oGAA8B,CAAA;IAC9B,kGAA6B,CAAA;IAC7B,6GAAkC,CAAA;IAClC,yGAAgC,CAAA;IAChC,yGAAgC,CAAA;IAChC,2EAAiB,CAAA;IACjB,2EAAiB,CAAA;IACjB,6EAAkB,CAAA;IAClB,qEAAc,CAAA;IACd,wGAAgC,CAAA;IAChC,kFAAqB,CAAA;IACrB,gFAAoB,CAAA;IACpB,sFAAuB,CAAA;IACvB,iEAAY,CAAA;IACZ,iFAAoB,CAAA;IACpB,mGAA6B,CAAA;IAC7B,uFAAuB,CAAA;IACvB,yFAAwB,CAAA;IACxB,uFAAuB,CAAA;IACvB,iEAAY,CAAA;IACZ,qGAA8B,CAAA;IAC9B,qGAA8B,CAAA;IAC9B,mEAAa,CAAA;IACb,yFAAwB,CAAA;IACxB,qGAA8B,CAAA;IAC9B,yEAAgB,CAAA;IAChB,gGAA4B,CAAA;IAC5B,uEAAe,CAAA;IACf,uFAAuB,CAAA;IACvB,uEAAe,CAAA;IACf,gGAA4B,CAAA;IAC5B,2FAAyB,CAAA;IACzB,yFAAwB,CAAA;IACxB,mGAA6B,CAAA;IAC7B,2FAAyB,CAAA;IACzB,2FAAyB,CAAA;IACzB,iEAAY,CAAA;IACZ,oEAAc,CAAA;IACd,gEAAY,CAAA;AACd,CAAC,EAzDW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAyD7B;AAED,IAAY,oBAeX;AAfD,WAAY,oBAAoB;IAC9B,8EAAgB,CAAA;IAChB,oGAA2B,CAAA;IAC3B,0FAAsB,CAAA;IACtB,gHAAiC,CAAA;IACjC,kFAAkB,CAAA;IAClB,2FAA2F;IAC3F,sFAAoB,CAAA;IACpB,kHAAkH;IAClH,0DAA0D;IAC1D,8FAAwB,CAAA;IACxB,0DAA0D;IAC1D,kFAAkB,CAAA;IAClB,0FAAsB,CAAA;IACtB,mFAAmB,CAAA;AACrB,CAAC,EAfW,oBAAoB,GAApB,4BAAoB,KAApB,4BAAoB,QAe/B;AAED,IAAY,gBAEX;AAFD,WAAY,gBAAgB;IAC1B,6EAAoB,CAAA;AACtB,CAAC,EAFW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAE3B;AAID,IAAY,mBAIX;AAJD,WAAY,mBAAmB;IAC7B,2DAAO,CAAA;IACP,iEAAU,CAAA;IACV,6DAAQ,CAAA;AACV,CAAC,EAJW,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,QAI9B;AAED,IAAY,qBAKX;AALD,WAAY,qBAAqB;IAC/B,6EAAc,CAAA;IACd,+EAAW,CAAA;IACX,mFAAa,CAAA;IACb,uFAAe,CAAA;AACjB,CAAC,EALW,qBAAqB,GAArB,6BAAqB,KAArB,6BAAqB,QAKhC;AAED,IAAY,aAKX;AALD,WAAY,aAAa;IACvB,mDAAS,CAAA;IACT,6DAAU,CAAA;IACV,+CAAG,CAAA;IACH,uDAAO,CAAA;AACT,CAAC,EALW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAKxB;AAED,IAAY,UAOX;AAPD,WAAY,UAAU;IACpB,6CAAS,CAAA;IACT,6CAAK,CAAA;IACL,yCAAG,CAAA;IACH,iDAAO,CAAA;IACP,iDAAO,CAAA;IACP,mDAAQ,CAAA;AACV,CAAC,EAPW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAOrB;AAED,IAAY,mBAIX;AAJD,WAAY,mBAAmB;IAC7B,6DAAQ,CAAA;IACR,+DAAK,CAAA;IACL,uEAAS,CAAA;AACX,CAAC,EAJW,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,QAI9B;AAED,IAAY,gBAGX;AAHD,WAAY,gBAAgB;IAC1B,iFAAqB,CAAA;IACrB,2DAAM,CAAA;AACR,CAAC,EAHW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAG3B;AAsED,qCAA+B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":";;;;;AAAA,IAAY,aAgBX;AAhBD,WAAY,aAAa;IACvB,mDAAS,CAAA;IACT,qDAAW,CAAA;IACX,mEAAkB,CAAA;IAClB,mEAAkB,CAAA;IAClB,qEAAmB,CAAA;IACnB,uDAAY,CAAA;IACZ,qEAAmB,CAAA;IACnB,2FAA8B,CAAA;IAC9B,6DAAe,CAAA;IACf,qFAA2B,CAAA;IAC3B,+DAAgB,CAAA;IAChB,2DAAc,CAAA;IACd,yDAAa,CAAA;IACb,yDAAa,CAAA;IACb,uEAAoB,CAAA;AACtB,CAAC,EAhBW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAgBxB;AAED,IAAY,aAIX;AAJD,WAAY,aAAa;IACvB,uDAAY,CAAA;IACZ,2DAAc,CAAA;IACd,+DAAgB,CAAA;AAClB,CAAC,EAJW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAIxB;AAED,IAAY,MAMX;AAND,WAAY,MAAM;IAChB,iCAAO,CAAA;IACP,mCAAI,CAAA;IACJ,mCAAI,CAAA;IACJ,2CAAQ,CAAA;IACR,yCAAO,CAAA;AACT,CAAC,EANW,MAAM,GAAN,cAAM,KAAN,cAAM,QAMjB;AAED,IAAY,aAIX;AAJD,WAAY,aAAa;IACvB,+CAAO,CAAA;IACP,qDAAM,CAAA;IACN,mDAAK,CAAA;AACP,CAAC,EAJW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAIxB;AAED,IAAY,gBAOX;AAPD,WAAY,gBAAgB;IAC1B,yDAAO,CAAA;IACP,yDAAO,CAAA;IACP,yDAAO,CAAA;IACP,yDAAO,CAAA;IACP,yDAAO,CAAA;IACP,yDAAO,CAAA;AACT,CAAC,EAPW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAO3B;AAED,IAAY,kBAyDX;AAzDD,WAAY,kBAAkB;IAC5B,8FAA0B,CAAA;IAC1B,iEAAY,CAAA;IACZ,uEAAe,CAAA;IACf,iEAAY,CAAA;IACZ,6EAAkB,CAAA;IAClB,2EAAiB,CAAA;IACjB,+FAA2B,CAAA;IAC3B,sGAA+B,CAAA;IAC/B,0EAAiB,CAAA;IACjB,0EAAiB,CAAA;IACjB,sEAAe,CAAA;IACf,2GAAiC,CAAA;IACjC,iGAA4B,CAAA;IAC5B,yGAAgC,CAAA;IAChC,iGAA4B,CAAA;IAC5B,uGAA+B,CAAA;IAC/B,6GAAkC,CAAA;IAClC,oGAA8B,CAAA;IAC9B,kGAA6B,CAAA;IAC7B,6GAAkC,CAAA;IAClC,yGAAgC,CAAA;IAChC,yGAAgC,CAAA;IAChC,2EAAiB,CAAA;IACjB,2EAAiB,CAAA;IACjB,6EAAkB,CAAA;IAClB,qEAAc,CAAA;IACd,wGAAgC,CAAA;IAChC,kFAAqB,CAAA;IACrB,gFAAoB,CAAA;IACpB,sFAAuB,CAAA;IACvB,iEAAY,CAAA;IACZ,iFAAoB,CAAA;IACpB,mGAA6B,CAAA;IAC7B,uFAAuB,CAAA;IACvB,yFAAwB,CAAA;IACxB,uFAAuB,CAAA;IACvB,iEAAY,CAAA;IACZ,qGAA8B,CAAA;IAC9B,qGAA8B,CAAA;IAC9B,mEAAa,CAAA;IACb,yFAAwB,CAAA;IACxB,qGAA8B,CAAA;IAC9B,yEAAgB,CAAA;IAChB,gGAA4B,CAAA;IAC5B,uEAAe,CAAA;IACf,uFAAuB,CAAA;IACvB,uEAAe,CAAA;IACf,gGAA4B,CAAA;IAC5B,2FAAyB,CAAA;IACzB,yFAAwB,CAAA;IACxB,mGAA6B,CAAA;IAC7B,2FAAyB,CAAA;IACzB,2FAAyB,CAAA;IACzB,iEAAY,CAAA;IACZ,oEAAc,CAAA;IACd,gEAAY,CAAA;AACd,CAAC,EAzDW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAyD7B;AAED,IAAY,oBAeX;AAfD,WAAY,oBAAoB;IAC9B,8EAAgB,CAAA;IAChB,oGAA2B,CAAA;IAC3B,0FAAsB,CAAA;IACtB,gHAAiC,CAAA;IACjC,kFAAkB,CAAA;IAClB,2FAA2F;IAC3F,sFAAoB,CAAA;IACpB,kHAAkH;IAClH,0DAA0D;IAC1D,8FAAwB,CAAA;IACxB,0DAA0D;IAC1D,kFAAkB,CAAA;IAClB,0FAAsB,CAAA;IACtB,mFAAmB,CAAA;AACrB,CAAC,EAfW,oBAAoB,GAApB,4BAAoB,KAApB,4BAAoB,QAe/B;AAED,IAAY,gBAEX;AAFD,WAAY,gBAAgB;IAC1B,6EAAoB,CAAA;AACtB,CAAC,EAFW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAE3B;AAID,IAAY,mBAIX;AAJD,WAAY,mBAAmB;IAC7B,2DAAO,CAAA;IACP,iEAAU,CAAA;IACV,6DAAQ,CAAA;AACV,CAAC,EAJW,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,QAI9B;AAED,IAAY,qBAKX;AALD,WAAY,qBAAqB;IAC/B,6EAAc,CAAA;IACd,+EAAW,CAAA;IACX,mFAAa,CAAA;IACb,uFAAe,CAAA;AACjB,CAAC,EALW,qBAAqB,GAArB,6BAAqB,KAArB,6BAAqB,QAKhC;AAED,IAAY,aAKX;AALD,WAAY,aAAa;IACvB,mDAAS,CAAA;IACT,6DAAU,CAAA;IACV,+CAAG,CAAA;IACH,uDAAO,CAAA;AACT,CAAC,EALW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAKxB;AAED,IAAY,UAOX;AAPD,WAAY,UAAU;IACpB,6CAAS,CAAA;IACT,6CAAK,CAAA;IACL,yCAAG,CAAA;IACH,iDAAO,CAAA;IACP,iDAAO,CAAA;IACP,mDAAQ,CAAA;AACV,CAAC,EAPW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAOrB;AAED,IAAY,mBAIX;AAJD,WAAY,mBAAmB;IAC7B,6DAAQ,CAAA;IACR,+DAAK,CAAA;IACL,uEAAS,CAAA;AACX,CAAC,EAJW,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,QAI9B;AAED,IAAY,gBAGX;AAHD,WAAY,gBAAgB;IAC1B,iFAAqB,CAAA;IACrB,2DAAM,CAAA;AACR,CAAC,EAHW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAG3B;AAuED,qCAA+B"}

package/types/index.ts

@@ -201,6 +201,7 @@ export * from './priceCalculation'
 export * from './priceSpecification'
 export * from './product'
 export * from './providerBranding'
+export * from './providerInvoice'
 export * from './queryParams'
 export * from './reports/reports'
 export * from './resetPassword'

package/types/outage.d.ts

@@ -1,4 +1,3 @@
-import { TIsoCountry } from './country'
 import { OutageSeverityLevel } from './index'
 
 export interface IOutageResponse {
@@ -8,68 +7,3 @@ export interface IOutageResponse {
   disabledPaths: string[] | null
   severityLevel: OutageSeverityLevel | null
 }
-
-/**
- * Request body for creating or updating an outage (Superadmin). A null text or severity falls back to the
- * template's default. Leave both iso_countries and provider_ids null for an outage that applies to everyone.
- */
-export interface IOutageAdminRequest {
-  outageTemplateId: number | null
-  headerText: string | null
-  message: string | null
-  severityLevel: OutageSeverityLevel | null
-  /**
-   * Paths whose requests are refused while the outage is active. A path matches anywhere in the URL, in every app,
-   * so start it with its app: /admin/contracts, /my-page/invoices. '*' refuses every request.
-   */
-  disabledPaths: string[] | null
-  isoCountries: TIsoCountry[] | null
-  providerIds: number[] | null
-}
-
-/**
- * An outage as Superadmin lists and edits it.
- */
-export interface IOutageAdminResponse extends IOutageAdminRequest {
-  outageId: number
-  /**
-   * ISO date string (YYYY-MM-DD) of when the outage was created
-   */
-  date: string
-  /**
-   * ISO date string (YYYY-MM-DD) of when the outage was archived; null while it is active
-   */
-  archived: string | null
-  /**
-   * What users see: the outage's own text and severity, or the template's when those are null
-   */
-  effectiveHeaderText: string
-  effectiveMessage: string
-  effectiveSeverityLevel: OutageSeverityLevel
-}
-
-/**
- * Request body for creating or updating an outage template (Superadmin). Updating changes what users see for every
- * active outage that leaves these values empty.
- */
-export interface IOutageTemplateRequest {
-  name: string
-  defaultHeaderText: string
-  defaultMessage: string
-  defaultSeverityLevel: OutageSeverityLevel
-}
-
-/**
- * An outage template: the texts and severity a new outage can start from (Superadmin).
- */
-export interface IOutageTemplateResponse extends IOutageTemplateRequest {
-  outageTemplateId: number
-  /**
-   * Outages using the template, archived ones included; a template can only be deleted while this is 0
-   */
-  outageCount: number
-  /**
-   * Active outages using the template, whose text changes when the template is edited
-   */
-  activeOutageCount: number
-}

package/types/payment.d.ts

@@ -2,7 +2,7 @@ import { SettlementPaymentType } from './index'
 import { PriceSpecification } from './priceSpecification'
 
 /** Supported payment gateways. */
-export type PaymentGateway = 'Stripe' | 'B2B' | 'V4' | 'NONE' | 'Mock'
+export type PaymentGateway = 'Stripe' | 'B2B' | 'V4' | 'NONE' | 'Mock' | 'FragusSubscription' | 'FragusPrePaid'
 
 /** Supported payment types. */
 export type PaymentType = 'automatic' | 'manual'

package/types/providerInvoice.d.ts

@@ -0,0 +1,35 @@
+import { TCurrency } from './currency'
+
+export type ProviderInvoiceState = 'Pending' | 'Paid' | 'Canceled'
+
+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
+  contractCount: number
+  created: string // ISO
+}
+
+export interface IContractBillingEntry {
+  id: number
+  contractPrettyId: string
+  source: BillingEntrySource
+  kind: BillingEntryKind
+  coverageStart: string // ISO
+  coverageEnd: string // ISO, exclusive
+  amount: number
+  vat: number
+  currency: TCurrency
+}
+
+export interface IProviderInvoiceDetails extends IProviderInvoiceListRecord {
+  entries: IContractBillingEntry[]
+}

package/types/responseErrors/contractResponseErrors.d.ts

@@ -3,6 +3,8 @@ export type ContractResponseErrors =
   | PostContractResponseErrors
   | ContractActivationPreventedBySystemForThisVehicle
   | WarrantyCheckErrors
+  | FragusInvoicingErrors
+  | InternalUseErrors
 
 type ContractUpdateErrors = 'CONTRACT_TRANSITION_INVALID_OR_ILLEGAL'
 type PostContractResponseErrors = 'CONTRACT_MISSING_OR_INVALID_INFORMATION' | 'ITEM_SERIALNO_ACTIVE_CONTRACT_EXISTS'
@@ -21,3 +23,18 @@ type WarrantyCheckErrors =
   | 'WARRANTY_MODEL_NOT_FOUND'
   | 'WARRANTY_NOT_AVAILABLE_FOR_VEHICLE'
 
+type FragusInvoicingErrors =
+  | 'FRAGUS_INVOICING_WEBCALC_NOT_AVAILABLE'
+  | 'FRAGUS_INVOICING_HAS_FRAGUS_CONTRACTS'
+  | 'FRAGUS_INVOICING_DEALER_PAID_NOT_AVAILABLE'
+
+type InternalUseErrors =
+  | 'INTERNAL_USE_REQUIRES_NON_CARD_GATEWAY'
+  | 'INTERNAL_USE_NOT_ENABLED'
+  | 'INTERNAL_USE_OFFER_NOT_AVAILABLE'
+  | 'INTERNAL_USE_STRIPE_NOT_AVAILABLE'
+  | 'INTERNAL_USE_WEBCALC_NOT_AVAILABLE'
+  | 'INTERNAL_USE_FIXED_CUSTOMER_NO_LOGIN'
+  | 'INTERNAL_USE_OWNER_CHANGE_NOT_AVAILABLE'
+  | 'INTERNAL_USE_FIXED_CUSTOMER_READ_ONLY'
+  | 'INTERNAL_USE_FIXED_CUSTOMER_NOT_ALLOWED'

package/types/v4PricingTool/productsAndContracts/index.d.ts

@@ -1,2 +1,2 @@
 export declare type TV4PTProductType = 'ServiceAgreement' | 'Warranty' | 'WarrantyAndServiceAgreement';
-export declare type TV4PTPaymentType = 'DealerPaid' | 'CustomerSubscription';
+export declare type TV4PTPaymentType = 'DealerPaid' | 'CustomerSubscription' | 'FragusSubscription' | 'FragusPrePaid';

package/types/v4PricingTool/productsAndContracts/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":";;AAMA,yFAAyF;AACzF,kFAAkF;AAClF,6EAA6E;AAC7E,gFAAgF"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":";;AAQA,yFAAyF;AACzF,kFAAkF;AAClF,6EAA6E;AAC7E,gFAAgF"}

package/types/v4PricingTool/productsAndContracts/index.ts

@@ -4,6 +4,8 @@ export type TV4PTProductType = 'ServiceAgreement' | 'Warranty' | 'WarrantyAndSer
 export type TV4PTPaymentType =
   | 'DealerPaid' // One-time dealer payment via V4.
   | 'CustomerSubscription' // Customer monthly subscription.
+  | 'FragusSubscription' // Fragus Invoicing, sent to V4 as 'CustomerSubscription'.
+  | 'FragusPrePaid' // Fragus Invoicing, sent to V4 as 'DealerPaid'.
 // | 'CustomerPaymentCard' // Deprecated, use 'CustomerSubscription' instead. /2023-01-01
 // | 'Subscription' // Deprecated, use 'CustomerSubscription' instead. /2023-01-01
 // | 'DealerPaidMonthly' // Deprecated, use 'DealerPaid' instead. /2023-01-01