swoop-common 2.1.71 → 2.1.73

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.
@@ -46,6 +46,7 @@ export type { DTOTemplateRead } from './index';
46
46
  export type { DTOTemplateUpdate } from './index';
47
47
  export type { EnquiryId } from './index';
48
48
  export type { EnquiryIdPathParam } from './index';
49
+ export type { EnquiryIdQueryParam } from './index';
49
50
  export type { Error } from './index';
50
51
  export type { Fee } from './index';
51
52
  export type { Field } from './index';
@@ -71,6 +72,7 @@ export type { SearchQueryParam } from './index';
71
72
  export type { SnapshotId } from './index';
72
73
  export type { SnapshotIdPathParam } from './index';
73
74
  export type { SortQueryParam } from './index';
75
+ export type { StateQueryParam } from './index';
74
76
  export type { TagPathParam } from './index';
75
77
  export type { TemplateId } from './index';
76
78
  export type { TemplateIdPathParam } from './index';
@@ -48,6 +48,7 @@ export type { DTOTemplateRead } from './models/DTOTemplateRead';
48
48
  export type { DTOTemplateUpdate } from './models/DTOTemplateUpdate';
49
49
  export type { EnquiryId } from './models/EnquiryId';
50
50
  export type { EnquiryIdPathParam } from './models/EnquiryIdPathParam';
51
+ export type { EnquiryIdQueryParam } from './models/EnquiryIdQueryParam';
51
52
  export type { Error } from './models/Error';
52
53
  export type { Fee } from './models/Fee';
53
54
  export type { Field } from './models/Field';
@@ -73,6 +74,7 @@ export type { SearchQueryParam } from './models/SearchQueryParam';
73
74
  export type { SnapshotId } from './models/SnapshotId';
74
75
  export type { SnapshotIdPathParam } from './models/SnapshotIdPathParam';
75
76
  export type { SortQueryParam } from './models/SortQueryParam';
77
+ export type { StateQueryParam } from './models/StateQueryParam';
76
78
  export type { TagPathParam } from './models/TagPathParam';
77
79
  export type { TemplateId } from './models/TemplateId';
78
80
  export type { TemplateIdPathParam } from './models/TemplateIdPathParam';
@@ -0,0 +1 @@
1
+ export type EnquiryIdQueryParam = string;
@@ -0,0 +1,5 @@
1
+ import type { ComponentState } from './ComponentState';
2
+ /**
3
+ * The publishing state of the component
4
+ */
5
+ export type StateQueryParam = ComponentState;
@@ -0,0 +1 @@
1
+ export {};
@@ -1,5 +1,4 @@
1
1
  import type { ComponentId } from '../models/ComponentId';
2
- import type { ComponentState } from '../models/ComponentState';
3
2
  import type { DTOComponentCreate } from '../models/DTOComponentCreate';
4
3
  import type { DTOComponentRead } from '../models/DTOComponentRead';
5
4
  import type { DTOComponentUpdate } from '../models/DTOComponentUpdate';
@@ -11,11 +10,14 @@ export declare class ComponentService {
11
10
  * List all available component
12
11
  * @param page Pagination, starting at page 1
13
12
  * @param limit Number of items per page
13
+ * @param order Order the sort query parameter values either by ascending or descending order
14
14
  * @param sort List of fields to sort by, this requires the order query param
15
+ * @param search The search strings to apply to the on query parameter values
16
+ * @param on The fields to apply the search to, the list follows the order and length of the search values in the search query
15
17
  * @returns any The list of all component given the parameters used
16
18
  * @throws ApiError
17
19
  */
18
- static componentList(page?: number, limit?: number, sort?: any[]): CancelablePromise<{
20
+ static componentList(page?: number, limit?: number, order?: 'asc' | 'desc', sort?: any[], search?: Array<string>, on?: Array<string>): CancelablePromise<{
19
21
  data?: Array<DTOComponentRead>;
20
22
  pagination?: Pagination;
21
23
  }>;
@@ -65,9 +67,8 @@ export declare class ComponentService {
65
67
  * Update Component State
66
68
  * Directly update component state. This does not create a new revision
67
69
  * @param componentId Id of a component
68
- * @param requestBody
69
70
  * @returns any OK
70
71
  * @throws ApiError
71
72
  */
72
- static componentStateUpdate(componentId: ComponentId, requestBody: ComponentState): CancelablePromise<any>;
73
+ static componentStateUpdate(componentId: ComponentId): CancelablePromise<any>;
73
74
  }
@@ -6,18 +6,24 @@ export class ComponentService {
6
6
  * List all available component
7
7
  * @param page Pagination, starting at page 1
8
8
  * @param limit Number of items per page
9
+ * @param order Order the sort query parameter values either by ascending or descending order
9
10
  * @param sort List of fields to sort by, this requires the order query param
11
+ * @param search The search strings to apply to the on query parameter values
12
+ * @param on The fields to apply the search to, the list follows the order and length of the search values in the search query
10
13
  * @returns any The list of all component given the parameters used
11
14
  * @throws ApiError
12
15
  */
13
- static componentList(page, limit, sort) {
16
+ static componentList(page, limit, order, sort, search, on) {
14
17
  return __request(OpenAPI, {
15
18
  method: 'GET',
16
19
  url: '/components',
17
20
  query: {
18
21
  'page': page,
19
22
  'limit': limit,
23
+ 'order': order,
20
24
  'sort': sort,
25
+ 'search': search,
26
+ 'on': on,
21
27
  },
22
28
  errors: {
23
29
  400: `If the filter options or query parameters contain invalid values`,
@@ -148,19 +154,16 @@ export class ComponentService {
148
154
  * Update Component State
149
155
  * Directly update component state. This does not create a new revision
150
156
  * @param componentId Id of a component
151
- * @param requestBody
152
157
  * @returns any OK
153
158
  * @throws ApiError
154
159
  */
155
- static componentStateUpdate(componentId, requestBody) {
160
+ static componentStateUpdate(componentId) {
156
161
  return __request(OpenAPI, {
157
162
  method: 'GET',
158
163
  url: '/components/{componentId}/state',
159
164
  path: {
160
165
  'componentId': componentId,
161
166
  },
162
- body: requestBody,
163
- mediaType: 'application/json',
164
167
  errors: {
165
168
  401: `Unauthorized - Missing or invalid Authorization header`,
166
169
  403: `Forbidden - The client is authenticated but not authorized to access this resource`,
@@ -1,5 +1,4 @@
1
1
  import type { ComponentId } from '../models/ComponentId';
2
- import type { ComponentState } from '../models/ComponentState';
3
2
  import type { DTOComponentCreate } from '../models/DTOComponentCreate';
4
3
  import type { DTOComponentRead } from '../models/DTOComponentRead';
5
4
  import type { DTOComponentUpdate } from '../models/DTOComponentUpdate';
@@ -15,11 +14,14 @@ export declare class CoreService {
15
14
  * List all available templates
16
15
  * @param page Pagination, starting at page 1
17
16
  * @param limit Number of items per page
17
+ * @param order Order the sort query parameter values either by ascending or descending order
18
18
  * @param sort List of fields to sort by, this requires the order query param
19
+ * @param search The search strings to apply to the on query parameter values
20
+ * @param on The fields to apply the search to, the list follows the order and length of the search values in the search query
19
21
  * @returns any The list of all templates given the parameters used
20
22
  * @throws ApiError
21
23
  */
22
- templateList(page?: number, limit?: number, sort?: any[]): CancelablePromise<{
24
+ templateList(page?: number, limit?: number, order?: 'asc' | 'desc', sort?: any[], search?: Array<string>, on?: Array<string>): CancelablePromise<{
23
25
  data?: Array<DTOTemplateRead>;
24
26
  pagination?: Pagination;
25
27
  }>;
@@ -61,11 +63,14 @@ export declare class CoreService {
61
63
  * List all available component
62
64
  * @param page Pagination, starting at page 1
63
65
  * @param limit Number of items per page
66
+ * @param order Order the sort query parameter values either by ascending or descending order
64
67
  * @param sort List of fields to sort by, this requires the order query param
68
+ * @param search The search strings to apply to the on query parameter values
69
+ * @param on The fields to apply the search to, the list follows the order and length of the search values in the search query
65
70
  * @returns any The list of all component given the parameters used
66
71
  * @throws ApiError
67
72
  */
68
- componentList(page?: number, limit?: number, sort?: any[]): CancelablePromise<{
73
+ componentList(page?: number, limit?: number, order?: 'asc' | 'desc', sort?: any[], search?: Array<string>, on?: Array<string>): CancelablePromise<{
69
74
  data?: Array<DTOComponentRead>;
70
75
  pagination?: Pagination;
71
76
  }>;
@@ -115,11 +120,10 @@ export declare class CoreService {
115
120
  * Update Component State
116
121
  * Directly update component state. This does not create a new revision
117
122
  * @param componentId Id of a component
118
- * @param requestBody
119
123
  * @returns any OK
120
124
  * @throws ApiError
121
125
  */
122
- componentStateUpdate(componentId: ComponentId, requestBody: ComponentState): CancelablePromise<any>;
126
+ componentStateUpdate(componentId: ComponentId): CancelablePromise<any>;
123
127
  /**
124
128
  * Resolve template hierarchy
125
129
  * @returns Array<DTOTemplateRead> OK
@@ -17,18 +17,24 @@ export class CoreService {
17
17
  * List all available templates
18
18
  * @param page Pagination, starting at page 1
19
19
  * @param limit Number of items per page
20
+ * @param order Order the sort query parameter values either by ascending or descending order
20
21
  * @param sort List of fields to sort by, this requires the order query param
22
+ * @param search The search strings to apply to the on query parameter values
23
+ * @param on The fields to apply the search to, the list follows the order and length of the search values in the search query
21
24
  * @returns any The list of all templates given the parameters used
22
25
  * @throws ApiError
23
26
  */
24
- templateList(page, limit, sort) {
27
+ templateList(page, limit, order, sort, search, on) {
25
28
  return __request(OpenAPI, {
26
29
  method: 'GET',
27
30
  url: '/templates',
28
31
  query: {
29
32
  'page': page,
30
33
  'limit': limit,
34
+ 'order': order,
31
35
  'sort': sort,
36
+ 'search': search,
37
+ 'on': on,
32
38
  },
33
39
  errors: {
34
40
  400: `If the filter options or query parameters contain invalid values`,
@@ -134,18 +140,24 @@ export class CoreService {
134
140
  * List all available component
135
141
  * @param page Pagination, starting at page 1
136
142
  * @param limit Number of items per page
143
+ * @param order Order the sort query parameter values either by ascending or descending order
137
144
  * @param sort List of fields to sort by, this requires the order query param
145
+ * @param search The search strings to apply to the on query parameter values
146
+ * @param on The fields to apply the search to, the list follows the order and length of the search values in the search query
138
147
  * @returns any The list of all component given the parameters used
139
148
  * @throws ApiError
140
149
  */
141
- componentList(page, limit, sort) {
150
+ componentList(page, limit, order, sort, search, on) {
142
151
  return __request(OpenAPI, {
143
152
  method: 'GET',
144
153
  url: '/components',
145
154
  query: {
146
155
  'page': page,
147
156
  'limit': limit,
157
+ 'order': order,
148
158
  'sort': sort,
159
+ 'search': search,
160
+ 'on': on,
149
161
  },
150
162
  errors: {
151
163
  400: `If the filter options or query parameters contain invalid values`,
@@ -276,19 +288,16 @@ export class CoreService {
276
288
  * Update Component State
277
289
  * Directly update component state. This does not create a new revision
278
290
  * @param componentId Id of a component
279
- * @param requestBody
280
291
  * @returns any OK
281
292
  * @throws ApiError
282
293
  */
283
- componentStateUpdate(componentId, requestBody) {
294
+ componentStateUpdate(componentId) {
284
295
  return __request(OpenAPI, {
285
296
  method: 'GET',
286
297
  url: '/components/{componentId}/state',
287
298
  path: {
288
299
  'componentId': componentId,
289
300
  },
290
- body: requestBody,
291
- mediaType: 'application/json',
292
301
  errors: {
293
302
  401: `Unauthorized - Missing or invalid Authorization header`,
294
303
  403: `Forbidden - The client is authenticated but not authorized to access this resource`,
@@ -10,11 +10,14 @@ export declare class TemplateService {
10
10
  * List all available templates
11
11
  * @param page Pagination, starting at page 1
12
12
  * @param limit Number of items per page
13
+ * @param order Order the sort query parameter values either by ascending or descending order
13
14
  * @param sort List of fields to sort by, this requires the order query param
15
+ * @param search The search strings to apply to the on query parameter values
16
+ * @param on The fields to apply the search to, the list follows the order and length of the search values in the search query
14
17
  * @returns any The list of all templates given the parameters used
15
18
  * @throws ApiError
16
19
  */
17
- static templateList(page?: number, limit?: number, sort?: any[]): CancelablePromise<{
20
+ static templateList(page?: number, limit?: number, order?: 'asc' | 'desc', sort?: any[], search?: Array<string>, on?: Array<string>): CancelablePromise<{
18
21
  data?: Array<DTOTemplateRead>;
19
22
  pagination?: Pagination;
20
23
  }>;
@@ -6,18 +6,24 @@ export class TemplateService {
6
6
  * List all available templates
7
7
  * @param page Pagination, starting at page 1
8
8
  * @param limit Number of items per page
9
+ * @param order Order the sort query parameter values either by ascending or descending order
9
10
  * @param sort List of fields to sort by, this requires the order query param
11
+ * @param search The search strings to apply to the on query parameter values
12
+ * @param on The fields to apply the search to, the list follows the order and length of the search values in the search query
10
13
  * @returns any The list of all templates given the parameters used
11
14
  * @throws ApiError
12
15
  */
13
- static templateList(page, limit, sort) {
16
+ static templateList(page, limit, order, sort, search, on) {
14
17
  return __request(OpenAPI, {
15
18
  method: 'GET',
16
19
  url: '/templates',
17
20
  query: {
18
21
  'page': page,
19
22
  'limit': limit,
23
+ 'order': order,
20
24
  'sort': sort,
25
+ 'search': search,
26
+ 'on': on,
21
27
  },
22
28
  errors: {
23
29
  400: `If the filter options or query parameters contain invalid values`,
@@ -48,6 +48,7 @@ export type { DTOTemplateRead } from './models/DTOTemplateRead';
48
48
  export type { DTOTemplateUpdate } from './models/DTOTemplateUpdate';
49
49
  export type { EnquiryId } from './models/EnquiryId';
50
50
  export type { EnquiryIdPathParam } from './models/EnquiryIdPathParam';
51
+ export type { EnquiryIdQueryParam } from './models/EnquiryIdQueryParam';
51
52
  export type { Error } from './models/Error';
52
53
  export type { Fee } from './models/Fee';
53
54
  export type { Field } from './models/Field';
@@ -73,6 +74,7 @@ export type { SearchQueryParam } from './models/SearchQueryParam';
73
74
  export type { SnapshotId } from './models/SnapshotId';
74
75
  export type { SnapshotIdPathParam } from './models/SnapshotIdPathParam';
75
76
  export type { SortQueryParam } from './models/SortQueryParam';
77
+ export type { StateQueryParam } from './models/StateQueryParam';
76
78
  export type { TagPathParam } from './models/TagPathParam';
77
79
  export type { TemplateId } from './models/TemplateId';
78
80
  export type { TemplateIdPathParam } from './models/TemplateIdPathParam';
@@ -0,0 +1 @@
1
+ export type EnquiryIdQueryParam = string;
@@ -0,0 +1,5 @@
1
+ import type { ComponentState } from './ComponentState';
2
+ /**
3
+ * The publishing state of the component
4
+ */
5
+ export type StateQueryParam = ComponentState;
@@ -33,6 +33,7 @@ export declare class ItineraryService {
33
33
  /**
34
34
  * List Snapshots
35
35
  * List all available snapshots relating to the query params
36
+ * @param enquiryId
36
37
  * @param page Pagination, starting at page 1
37
38
  * @param limit Number of items per page
38
39
  * @param order Order the sort query parameter values either by ascending or descending order
@@ -42,7 +43,7 @@ export declare class ItineraryService {
42
43
  * @returns any The list of all snapshots given the parameters used
43
44
  * @throws ApiError
44
45
  */
45
- snapshotList(page?: number, limit?: number, order?: 'asc' | 'desc', sort?: any[], search?: Array<string>, on?: Array<string>): CancelablePromise<{
46
+ snapshotList(enquiryId?: string, page?: number, limit?: number, order?: 'asc' | 'desc', sort?: any[], search?: Array<string>, on?: Array<string>): CancelablePromise<{
46
47
  snapshots?: Array<DTOSnapshotRead>;
47
48
  }>;
48
49
  /**
@@ -50,6 +50,7 @@ export class ItineraryService {
50
50
  /**
51
51
  * List Snapshots
52
52
  * List all available snapshots relating to the query params
53
+ * @param enquiryId
53
54
  * @param page Pagination, starting at page 1
54
55
  * @param limit Number of items per page
55
56
  * @param order Order the sort query parameter values either by ascending or descending order
@@ -59,11 +60,12 @@ export class ItineraryService {
59
60
  * @returns any The list of all snapshots given the parameters used
60
61
  * @throws ApiError
61
62
  */
62
- snapshotList(page, limit, order, sort, search, on) {
63
+ snapshotList(enquiryId, page, limit, order, sort, search, on) {
63
64
  return __request(OpenAPI, {
64
65
  method: 'GET',
65
66
  url: '/snapshot',
66
67
  query: {
68
+ 'enquiryId': enquiryId,
67
69
  'page': page,
68
70
  'limit': limit,
69
71
  'order': order,
@@ -15,6 +15,7 @@ export declare class SnapshotService {
15
15
  /**
16
16
  * List Snapshots
17
17
  * List all available snapshots relating to the query params
18
+ * @param enquiryId
18
19
  * @param page Pagination, starting at page 1
19
20
  * @param limit Number of items per page
20
21
  * @param order Order the sort query parameter values either by ascending or descending order
@@ -24,7 +25,7 @@ export declare class SnapshotService {
24
25
  * @returns any The list of all snapshots given the parameters used
25
26
  * @throws ApiError
26
27
  */
27
- static snapshotList(page?: number, limit?: number, order?: 'asc' | 'desc', sort?: any[], search?: Array<string>, on?: Array<string>): CancelablePromise<{
28
+ static snapshotList(enquiryId?: string, page?: number, limit?: number, order?: 'asc' | 'desc', sort?: any[], search?: Array<string>, on?: Array<string>): CancelablePromise<{
28
29
  snapshots?: Array<DTOSnapshotRead>;
29
30
  }>;
30
31
  /**
@@ -26,6 +26,7 @@ export class SnapshotService {
26
26
  /**
27
27
  * List Snapshots
28
28
  * List all available snapshots relating to the query params
29
+ * @param enquiryId
29
30
  * @param page Pagination, starting at page 1
30
31
  * @param limit Number of items per page
31
32
  * @param order Order the sort query parameter values either by ascending or descending order
@@ -35,11 +36,12 @@ export class SnapshotService {
35
36
  * @returns any The list of all snapshots given the parameters used
36
37
  * @throws ApiError
37
38
  */
38
- static snapshotList(page, limit, order, sort, search, on) {
39
+ static snapshotList(enquiryId, page, limit, order, sort, search, on) {
39
40
  return __request(OpenAPI, {
40
41
  method: 'GET',
41
42
  url: '/snapshot',
42
43
  query: {
44
+ 'enquiryId': enquiryId,
43
45
  'page': page,
44
46
  'limit': limit,
45
47
  'order': order,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "swoop-common",
3
- "version": "2.1.71",
3
+ "version": "2.1.73",
4
4
  "main": "dist/api/index.js",
5
5
  "types": "dist/api/index.d.ts",
6
6
  "exports": {