@fragus/sam-types 1.0.0

package/types/index.ts

@@ -0,0 +1,229 @@
+export enum ContractState {
+  Draft = 1,
+  Offer = 100,
+  OfferExpired = 110,
+  OfferRevoked = 120,
+  OfferRejected = 130, // not used
+  Active = 200,
+  ActivePrePaid = 210,
+  ActivePendingTermination = 250,
+  Suspended = 400,
+  CancelledSubscription = 450,
+  Terminated = 500,
+  Extended = 510,
+  Expired = 600,
+  Settled = 900,
+  SettledPrePaid = 950,
+}
+
+export enum WarrantyState {
+  Active = 200,
+  Rejected = 300,
+  Terminated = 500,
+}
+
+export enum DbType {
+  int = 1,
+  text,
+  date,
+  monetary,
+  mileage,
+}
+
+export enum AggregateType {
+  sum = 1,
+  concat,
+  count,
+}
+
+export enum FormattingLocale {
+  'sv-SE',
+  'uk-UA',
+  'da-DK',
+  'en-GB',
+  'fi-FI',
+  'en-US',
+}
+
+export enum ContractActionType {
+  createInV4AndActivate = 90, // Contract was created in V4 (and activated there), this (mirror) contract in JustGO is based on that contract in V4. See also sendMirrorAndActivateInV4.
+  create = 100, // Who created the contract? a customer or a seller? if the contract was created as an extentioon information about the parent must be in the details.
+  sendDraft = 120, // A draft was sent to the customer.
+  buyNow = 130, // Customer visited payment page.
+  failedBuyNow = 135, // Customer or Seller/Admin payment failed.
+  createOffer = 140, // An offer was created.
+  sendOfferReminderMail = 150, // A reminder about offer was sent to the customer.
+  softBounce = 1510, // Email soft bounced, temporary issues preventing email delivery (mailbox is full, delays on client side, spam/reputation related exc).
+  hardBounce = 1512, // Email hard bounced, permanent issues preventing email delivery (address doesn't exist, email not complying with sending domain auth policy, spam/reputation related exc).
+  dnsError = 1513, // A type of soft bounce, can occur during domain migration and change of email provider.
+  sendContractTerminationMail = 151, // A termination mail was sent to the customer.
+  sendOfferReminderMail2 = 152, // A reminder about offer was sent to the customer.
+  sendContractActivationMail = 153, // A contract activation mail was sent to the customer.
+  sendOfferReminderMail3 = 154, // A reminder about offer was sent to the customer.
+  sendContractSuspendedMail = 155, // A suspended mail was sent to the customer.
+  sendContractOfferCreatedMail = 156, // Email sent to the customer informing offer has been created.
+  resendContractOfferMail = 1565, // Resent offer to the customer via "Resend Offer" action.
+  sendOfferToOneselfMail = 1566, // End-user sent the offer to oneself (via Webcalc).
+  sendContractReactivationMail = 157, // A contract reactivation mail was sent to the customer.
+  sendContractAdjustmentMail = 158, // A contract adjustment mail was sent to the customer.
+  sendContractSettlementMail = 159, // A contract settlement mail was sent to the customer.
+  rejectOffer = 160, // The customer rejected the offer.
+  acceptOffer = 180, // The customer accepted the offer.
+  approveOffer = 200, // Who approved it? that would be the customer.
+  activate = 300, // The contract was activated by either the customer or the seller.
+  sendMirrorAndActivateInV4 = 1300, // A (copy/mirror) of this (already created in JustGO) contract was sent to V4 (and activated there in V4). See also createInV4AndActivate.
+  expire = 400, // The contract offer expired and archived.
+  expireContract = 410, // The contract expired.
+  sendContractExpiredMail = 411, // A expired mail was sent to the customer.
+  changeVehicleData = 420, // Meta data for the vehicle was changed.
+  changeCustomerData = 440, // Meta data for the customer was changed.
+  changePaymentData = 460, // Information about payment was changed.
+  modify = 500, // (extended) The contract was changed in a way that changes the financial agreement, if a new contract was created as a sideeffect, information about the new contract is in the details.
+  createPendingTermination = 550, // Registers the creation of a pending termination and indicates that the contract's status has changed from Active to ActivePendingTermination.
+  cancelPendingTermination = 560, // Registers the cancellation of a pending termination and indicates that the contract's status has changed from ActivePendingTermination to Active.
+  suspend = 600, // Who suspended the contract, if the system did this automatically that will be described in the details.
+  cancelSubscription = 650, // When Stripe subscription is cancelled without the request (automatically because of failed payments).
+  successfulInvoicePayment = 690, // Successful invoice payment. Contract soon to be re-activated.
+  reactivate = 700, // Who unsuspended the contract.
+  sendAndReactivateInV4 = 1700, // Sent reactivate request to V4.
+  extending = 710, // Who extended the contract (the contract which extended).
+  pauseSubscription = 720, // The subscription is paused because of contract paid off.
+  terminate = 800, // Who terminated the contract.
+  sendAndInactivateInV4 = 1800, // Sent inactivate request to V4.
+  registerCashPayment = 810, // Registered cash payment. Helps to solve balance issues on a contract.
+  registerCashPayout = 820, // Registered cash payout. Helps to solve balance issues on a contract.
+  registerProviderPayment = 830, // Registered provider payment. It means that provider forgive some amount. Helps to solve balance issues on a contract.
+  createStripeInvoice = 860, // Created stripe invoice for settlement.
+  registerPaidInvoice = 870, // Registered paid invoice. Create new 'settle charge' invoice (invoice.payment_succeeded webhook).
+  settle = 900, // Who Settled the contract, any settlement comments will be in the details.
+  archive = 1000, // Archive contract.
+  other = 9999, // Other action not applicable (yet) by any other action, information about the new and old contract is in the details.
+}
+
+export enum PaymentFailureReason {
+  expiredCard = 10, // The card has expired.
+  authenticationRequired = 20, // The card was declined as the transaction requires authentication.
+  insufficientFunds = 30, // The card has insufficient funds to complete the purchase.
+  withdrawalCountLimitExceeded = 40, // The customer has exceeded the balance or credit limit available on their card.
+  invalidAmount = 50, // The payment amount is invalid, or exceeds the amount that's allowed.
+  // If the amount appears to be correct, the customer needs to check with their card issuer.
+  fraudLostStolen = 60, // Payment matches a value on the Stripe user's block list. Stripe suspects that it's fraudulent.
+  // The card is reported lost or stolen. The specific reason for the decline shouldn't be reported to the customer.
+  // Instead, it needs to be presented as a generic_decline.
+  attemptPaymentAgain = 70, // Attempt the payment again. If you still can't process it, the customer needs to contact their card issuer.
+  // Recommended you not retry charges more than four times.
+  incorrectData = 80, // The customer needs try again using the correct card/payment data.
+  contactCardIssuer = 90, // The customer needs to contact their card issuer for more information.
+  unknownReason = 100, // Unknown Stripe reasons or reasons which shouldn't happen.
+}
+
+export enum ResponseWarnings {
+  GenericWarning = 499,
+}
+
+export type FileUploadToStorageType = 'General-Storage' | 'Logo-Banner-Storage' | 'Logo-Square-Storage'
+
+export enum OutageSeverityLevel {
+  Low = 1,
+  Medium = 2,
+  High = 3,
+}
+
+export enum SettlementPaymentType {
+  cashPayout = 1,
+  cashPayment,
+  stripePayment,
+  providerPayment,
+}
+
+export enum ReleaseSystem {
+  Admin = 1,
+  Superadmin,
+  Api,
+  WebShop,
+}
+
+export enum ReleaseTag {
+  ADDED = 1,
+  FIXED,
+  NEW,
+  REMOVED,
+  UPDATED,
+  IMPROVED,
+}
+
+export enum AccessKeyPermission {
+  Read = 1,
+  Write,
+  ReadWrite,
+}
+
+export enum AccessKeyService {
+  WorkshopOperation = 1,
+  Report,
+}
+
+export * from './address'
+export * from './admin'
+export * from './app'
+export * from './brand'
+export * from './chart'
+export * from './contactPerson'
+export * from './contract/contract'
+export * from './contract/contractActivation'
+export * from './contract/contractFilter'
+export * from './contract/contractList'
+export * from './contract/contractOffer'
+export * from './contract/contractQuery'
+export * from './contractAction'
+export * from './contractOption'
+export * from './contractProvider'
+export * from './contractTemplate'
+export * from './country'
+export * from './currency'
+export * from './customer'
+export * from './durationOptions'
+export * from './errorResponse'
+export * from './fuelType'
+export * from './includedContractOption'
+export * from './invoice'
+export * from './locale'
+export * from './localizationData'
+export * from './model'
+export * from './outage'
+export * from './payment'
+export * from './priceCalculation'
+export * from './priceSpecification'
+export * from './product'
+export * from './providerBranding'
+export * from './queryParams'
+export * from './reports/reports'
+export * from './resetPassword'
+export * from './responseErrors/calculatorResponseErrors'
+export * from './responseErrors/contractResponseErrors'
+export * from './responseErrors/genericResponseTypes'
+export * from './responseErrors/index'
+export * from './stripe/stripe'
+export * from './stripe/stripeAddress'
+export * from './stripe/stripeDateOfBirth'
+export * from './stripe/stripeDeclineChargeOn'
+export * from './stripe/stripeExternalAccount'
+export * from './stripe/stripeLegalEntity'
+export * from './stripe/stripeOwner'
+export * from './stripe/stripeVerification'
+export * from './termsOfService'
+export * from './translation'
+export * from './user'
+export * from './userConfiguration/tableUserConfiguration'
+export * from './userConfiguration/userConfiguration'
+export * from './vatLookup'
+export * from './vehicle'
+export * from './vehiclePartial'
+export * from './vehicleContracts'
+export * from './webcalc'
+export * from './workshopOperation'
+export * from './releaseNotes'
+export * from './paymentFailureReason'
+export * from './translations'
+export * from './v4PricingTool'
+export * from './accessKey'

package/types/invoice.d.ts

@@ -0,0 +1,13 @@
+import { IContractResponse } from './contract/contract'
+import { PriceSpecification } from './priceSpecification'
+
+export type InvoiceOrderBy = 'invoiceId' | 'dateIssuedAt' | 'state' | 'amount' | 'url'
+export type InvoiceState = 'Pending' | 'Paid' | 'Canceled'
+
+export interface IInvoice {
+  invoiceId: number
+  dateIssuedAt: Date
+  state: InvoiceState
+  amount: PriceSpecification
+  url: string
+}

package/types/locale.d.ts

@@ -0,0 +1,24 @@
+export interface Locale {
+  localeId: number
+  name: string
+  isoName: string
+  currencySymbol: string
+  currencyDefaultFormat: string
+  dateDefaultFormat: string
+  vatPct: number
+}
+
+/**
+ * "
+ * For example, to specify common English, use the 'en' language designator as
+ * locale. To specify the English language as it is used in the United
+ * Kingdom, use 'en-GB' as the locale.
+ * "
+ *
+ * Reference:
+ * https://lingohub.com/developers/supported-locales/language-designators-with-regions
+ *
+ * @note 'en-GB' is deprecated, please use 'en' for common English instead if possible.
+ * @deprecated 'en-GB'
+ */
+export type IsoLocale = 'da-DK' | 'sv-SE' | 'fi-FI' | 'nb-NO' | 'en' | 'en-GB' // NOTE: 'en-GB' is deprecated.

package/types/localizationData.d.ts

@@ -0,0 +1,7 @@
+import { Locale } from './locale'
+import { Translation } from './translation'
+
+export interface LocalizationData {
+  locale: Locale | undefined
+  translations: Translation[] | undefined
+}

package/types/model.d.ts

@@ -0,0 +1,4 @@
+export interface Model {
+  name: string
+  id?: number
+}

package/types/outage.d.ts

@@ -0,0 +1,9 @@
+import { OutageSeverityLevel } from './index'
+
+export interface IOutageResponse {
+  headerText: string | null
+  message: string | null
+  date: Date
+  disabledPaths: string[] | null
+  severityLevel: OutageSeverityLevel | null
+}

package/types/payment.d.ts

@@ -0,0 +1,53 @@
+import { SettlementPaymentType } from './index'
+import { PriceSpecification } from './priceSpecification'
+
+/** Supported payment gateways. */
+export type PaymentGateway = 'Stripe' | 'B2B' | 'V4' | 'NONE' | 'Mock'
+
+/** Supported payment types. */
+export type PaymentType = 'automatic' | 'manual'
+
+/** Credit card. */
+export interface PaymentCard {
+  cardType: string
+  last4: string
+  expMonth: number
+  expYear: number
+}
+
+/** Payment plan. */
+export interface PaymentPlan {
+  amountPrPayment: PriceSpecification
+  downpayment: PriceSpecification
+  totalCost: PriceSpecification
+}
+
+/**
+ * Payload to Initialize a Stripe Checkout Session.
+ */
+export interface IPreparePaymentRequest {
+  prettyIdentifier: string
+  cancel_url: string
+  success_url: string
+}
+
+/**
+ * Response payload from from a Stripe Checkout Session initialization request.
+ */
+export interface IPreparePaymentResponse {
+  prettyIdentifier: string
+  paymentGateway: PaymentGateway
+  checkoutSessionId?: string
+  stripePublicKey?: string
+  stripeAccount?: string
+}
+
+/**
+ * Payload to create settlement payments.
+ */
+export interface ISettlementPaymentRequest {
+  paymentAmount: number
+  type: SettlementPaymentType
+  comment?: string
+  shareComment?: boolean
+}

package/types/paymentFailureReason.d.ts

@@ -0,0 +1,6 @@
+import { PaymentFailureReason } from './index'
+
+export interface IPaymentFailureReason {
+  paymentFailureReason: PaymentFailureReason
+  stripeDeclineReason: string
+}

package/types/priceCalculation.d.ts

@@ -0,0 +1,27 @@
+import { PriceSpecification } from './priceSpecification'
+
+export interface ICalculationRequest {
+  contractTemplateId: number
+  brandId: number
+  vehicleModelId: number
+  fuelTypeId: number
+  duration: number
+  mileage: number
+  registrationDate?: string
+  optionIds: number[]
+  startMileage?: number
+  modelYear: number
+  registrationNumber: string
+}
+
+/**
+ * The type returned by a price calculation
+ */
+export interface ICalculationResponse {
+  amountPrPayment: PriceSpecification
+  downpayment: PriceSpecification
+  firstPaymentDate: string
+  contractStartDate: string
+  contractEndDate: string
+  serviceInfo?: string[] // use for AX templates
+}

package/types/priceSpecification.d.ts

@@ -0,0 +1,20 @@
+// import { TCurrency } from "../types"
+
+/**
+ * Note: If priceWith3Decimals has a value then use this value as price (possible value in price
+ * may be ignored), while if priceWith3Decimals is undefined then use the value in price.
+ * 
+ * @param price This value is the price only with max 2 decimals (the precision).
+ * @param priceWith3Decimals This price facilates up to 3 decimals (needed for
+ * calculations at least for euros to get rid of some rounding issues in
+ * combination with VAT in some cases).
+ */
+// TODO: Switch type of currency to TCurrency
+export interface PriceSpecification {
+  price: number     // Price with max 2 decimals (should have been mapped from cents).
+  priceWith3Decimals?: number // Price with upto 3 decimals (should have been mapped from tenth of cents).
+  priceInclVat: number
+  vatShare: number
+  currency: string
+  // currency: TCurrency
+}

package/types/product.d.ts

@@ -0,0 +1,23 @@
+import { Brand } from './brand'
+import { FuelType } from './fuelType'
+import { Model } from './model'
+import { VehicleContracts as ProductContracts } from './vehicleContracts'
+
+export interface Other {
+  id?: number
+  serialNumber?: string
+  serialNumber2?: string
+  itemNumber?: string
+  itemNumber2?: string
+  regDate?: string
+  brand: Brand
+  model: Model
+  fuelType: FuelType | undefined
+  modelYear: number
+  typeName: string
+}
+
+export interface ProductAlongItsContracts extends Other {
+  contracts: ProductContracts | undefined
+  hasActiveWarranty: boolean | undefined
+}

package/types/productPartial.d.ts

@@ -0,0 +1,18 @@
+import { Brand } from './brand'
+import { FuelType } from './fuelType'
+import { Model } from './model'
+
+// Note: Only serial and item numbers is required, rest are optional.
+export interface ProductPartial {
+  id?: number
+  serialNumber: string
+  serialNumber2?: string
+  itemNumber: string
+  itemNumber2?: string
+  regDate?: string
+  brand?: Brand
+  model?: Model
+  fuelType?: FuelType
+  modelYear?: number
+  typeName?: string
+}

package/types/providerBranding.d.ts

@@ -0,0 +1,48 @@
+import { TIsoCountry } from './country'
+import { TCurrency } from './currency'
+import { IsoLocale } from './locale'
+
+export interface IBrandingPayloadResponse {
+  countryCode: TIsoCountry
+  locale: IsoLocale
+  paymentInformation: IStripeInformationResponse
+  providerInformation: IProviderInformationResponse
+  providerBranding: IProviderBrandingResponse[]
+  providerStyling: IProviderStylingResponse
+  providerCustomization?: IProviderCustomizationResponse
+  parentProviderId?: number | null
+}
+
+export interface IStripeInformationResponse {
+  public_key: string
+}
+
+export interface IProviderInformationResponse {
+  contractProviderId: number
+  administrativeName: string
+  countryCode: TIsoCountry
+  currency: TCurrency
+  cvrCode: string
+  logo: string
+  contactFormUrl: string
+  showRegistrationSelectionPage: boolean
+  email: string
+  termsOfTradeRef: string
+  webCalcEnabled: boolean
+  hasAxTemplates: boolean // Autoexperten.
+}
+
+export interface IProviderBrandingResponse {
+  text: string
+}
+
+export interface IProviderStylingResponse {
+  brandingLogo: string
+  hasProviderStyling: boolean
+}
+
+export interface IProviderCustomizationResponse {
+  webCalcTrackingPixelOrderConfirmationUrl: string | undefined // Set undefined if this setting is not loaded.
+  webCalcTrackingPixelOrderConfirmationLastUpdated: string | undefined // Set undefined if this setting is not loaded.
+  inheritParentStylingWebcalc: boolean | undefined // Set undefined if this setting is not loaded.
+}

package/types/queryParams.d.ts

@@ -0,0 +1,51 @@
+// @NOTE - Deprecate this as search is a optional query param and
+// paginated query params has their own extension of query params
+export interface ISearchQuery<OrderBy> {
+  limit?: number
+  offset?: number
+  query?: string
+  orderBy?: OrderBy
+  orderDirection?: OrderDirection
+}
+
+// @NOTE - Deprecate this
+export type OrderDirection = 'ASC' | 'DESC'
+
+// @NOTE - Use this
+export type OrderDirectionType = 'ASC' | 'DESC'
+
+export interface IPaginationParams<OrderBy> {
+  limit?: number
+  offset?: number
+  orderBy?: OrderBy
+  orderDirection?: OrderDirectionType
+}
+
+export interface IQueryParams<Filtering = undefined> {
+  filtering?: Filtering
+  search?: string
+}
+
+export interface IPaginatedQueryParams<OrderBy, Filtering = undefined> extends IQueryParams<Filtering> {
+  pagination?: IPaginationParams<OrderBy>
+}
+
+export interface IPaginatedQuery<OrderByType, Filtering = undefined> {
+  params?: IPaginatedQueryParams<OrderByType, Filtering>
+}
+
+export interface IPagination<OrderByType> {
+  totalCount: number
+  resultCount: number
+  currentPage: number
+  pages: number
+  offset: number
+  limit: number
+  orderBy: OrderByType
+  orderDirection: OrderDirectionType
+}
+
+export interface IPaginatedResponse<Result, OrderByType> {
+  pagination: IPagination<OrderByType>
+  result: Result
+}

package/types/releaseNotes/index.d.ts

@@ -0,0 +1,33 @@
+import { ReleaseSystem, ReleaseTag } from '../index'
+import { IsoLocale } from '../locale'
+
+export interface IReleaseDescription {
+  releaseDescriptionId?: number
+  description: string
+  locale: IsoLocale
+}
+
+export interface IReleaseVersionRequest {
+  version: string
+  releaseSystem: ReleaseSystem
+  releaseDate: string
+}
+
+export interface IReleaseNoteRequest {
+  releaseVersionId: number
+  descriptions: IReleaseDescription[]
+  releaseTag: ReleaseTag
+}
+
+export interface IReleaseVersionResponse extends IReleaseVersionRequest {
+  releaseVersionId: number
+  published: boolean
+}
+
+export interface IReleaseNoteResponse extends IReleaseNoteRequest {
+  releaseNoteId: number
+}
+
+export interface IReleaseNotesResponse extends IReleaseVersionResponse {
+  releaseNotes: IReleaseNoteResponse[]
+}

package/types/reports/reports.d.ts

@@ -0,0 +1,50 @@
+import { AggregateType, DbType, TContractObject, TTranslationApplication } from '../index'
+import { IsoLocale } from '../locale'
+
+export interface IDbColumn {
+  name: string
+  description: string
+  descriptionMap?: TTranslationMap
+  dbType: DbType
+  groupOnly?: true
+}
+
+export interface IReportDefinition {
+  name: string
+  defaultDescription: string
+  columns: IDbColumn[]
+  groupByColumns: string[]
+  descriptionMap?: TTranslationMap
+  hasProductFields?: boolean
+}
+export type IReportDefinitionsResponse = { [key in string]?: IReportDefinition[] }
+
+export interface IReportSearchRequest {
+  name: string
+  search: { col: string; search: string }[]
+  groupBy: string[]
+  contractObjectType?: TContractObject
+}
+
+export type TTranslationMap = { [key in IsoLocale]?: string }
+
+export interface IColDefResponse {
+  header: string
+  type: DbType
+}
+
+export type ColData = { [colName in string]: IColDefResponse }
+export type CellData = string | number | Date | null | RowData[]
+export type RowData = { [colName in string]: CellData }
+export interface IReportSearchResponse {
+  name: string
+  cols: ColData
+  data: RowData[]
+  links?: { [colName in string]: string }[]
+}
+
+export interface IReportSearchResponseArrays {
+  headers: string[]
+  types: DbType[]
+  rows: CellData[][]
+}

package/types/resetPassword.d.ts

@@ -0,0 +1,3 @@
+export interface IResetPasswordRequest {
+  password: string
+}