@fragus/sam-types 1.1.8 → 1.1.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,5 +1,5 @@
1
1
  {
2
- "version": "1.1.8",
2
+ "version": "1.1.9",
3
3
  "name": "@fragus/sam-types",
4
4
  "description": "Typescript interfaces for all types used to communicate between SAM client(s) and the SAM API",
5
5
  "author": "Fragus",
@@ -1,5 +1,7 @@
1
1
  import { IContractHealth } from './../admin/contract/health'
2
+ import { TContractObject } from './../admin/product'
2
3
  import { ContractState } from './../index'
4
+ import { IPaginatedQueryParams, IPaginatedResponse } from './../queryParams'
3
5
  import { IContractFilterDate, IContractFilterOption } from './contractFilter'
4
6
 
5
7
  export interface IContractListRecord {
@@ -51,3 +53,40 @@ export interface IWarrantyListRecord {
51
53
  registrationNumber: string
52
54
  sellerName: string
53
55
  }
56
+
57
+ /** A contract-list row from the superadmin cross-provider search, tagged with its owning provider. */
58
+ export interface IContractCrossProviderSearchRecord extends IContractListRecord {
59
+ contractProviderId: number
60
+ contractProviderName: string
61
+ }
62
+
63
+ export interface IContractCrossProviderSearchResponse {
64
+ result: IContractCrossProviderSearchRecord[]
65
+ }
66
+
67
+ export interface IContractCrossProviderSearchParams {
68
+ search: string
69
+ limit?: number
70
+ includeInactiveProviders?: 'yes'
71
+ }
72
+
73
+ /**
74
+ * The provider-agnostic contract-list filters. Sellers, templates, options and sub dealers are
75
+ * vocabularies of a single provider and have no cross-provider meaning.
76
+ */
77
+ export interface IContractCrossProviderFilterParams {
78
+ contractStates?: ContractState[]
79
+ created?: IContractFilterDate
80
+ expired?: IContractFilterDate
81
+ activeTypes?: TContractObject[]
82
+ }
83
+
84
+ export interface IContractCrossProviderListParams
85
+ extends IPaginatedQueryParams<ContractListOrderByType, IContractCrossProviderFilterParams> {
86
+ includeInactiveProviders?: 'yes'
87
+ }
88
+
89
+ export type IContractCrossProviderListResponse = IPaginatedResponse<
90
+ IContractCrossProviderSearchRecord[],
91
+ ContractListOrderByType
92
+ >