swoop-common 2.1.72 → 2.1.74

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.
@@ -72,6 +72,7 @@ export type { SearchQueryParam } from './index';
72
72
  export type { SnapshotId } from './index';
73
73
  export type { SnapshotIdPathParam } from './index';
74
74
  export type { SortQueryParam } from './index';
75
+ export type { StateQueryParam } from './index';
75
76
  export type { TagPathParam } from './index';
76
77
  export type { TemplateId } from './index';
77
78
  export type { TemplateIdPathParam } from './index';
@@ -74,6 +74,7 @@ export type { SearchQueryParam } from './models/SearchQueryParam';
74
74
  export type { SnapshotId } from './models/SnapshotId';
75
75
  export type { SnapshotIdPathParam } from './models/SnapshotIdPathParam';
76
76
  export type { SortQueryParam } from './models/SortQueryParam';
77
+ export type { StateQueryParam } from './models/StateQueryParam';
77
78
  export type { TagPathParam } from './models/TagPathParam';
78
79
  export type { TemplateId } from './models/TemplateId';
79
80
  export type { TemplateIdPathParam } from './models/TemplateIdPathParam';
@@ -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 {};
@@ -11,11 +11,14 @@ export declare class ComponentService {
11
11
  * List all available component
12
12
  * @param page Pagination, starting at page 1
13
13
  * @param limit Number of items per page
14
+ * @param order Order the sort query parameter values either by ascending or descending order
14
15
  * @param sort List of fields to sort by, this requires the order query param
16
+ * @param search The search strings to apply to the on query parameter values
17
+ * @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
18
  * @returns any The list of all component given the parameters used
16
19
  * @throws ApiError
17
20
  */
18
- static componentList(page?: number, limit?: number, sort?: any[]): CancelablePromise<{
21
+ static componentList(page?: number, limit?: number, order?: 'asc' | 'desc', sort?: any[], search?: Array<string>, on?: Array<string>): CancelablePromise<{
19
22
  data?: Array<DTOComponentRead>;
20
23
  pagination?: Pagination;
21
24
  }>;
@@ -65,9 +68,9 @@ export declare class ComponentService {
65
68
  * Update Component State
66
69
  * Directly update component state. This does not create a new revision
67
70
  * @param componentId Id of a component
68
- * @param requestBody
71
+ * @param state The publishing state of the component
69
72
  * @returns any OK
70
73
  * @throws ApiError
71
74
  */
72
- static componentStateUpdate(componentId: ComponentId, requestBody: ComponentState): CancelablePromise<any>;
75
+ static componentStateUpdate(componentId: ComponentId, state: ComponentState): CancelablePromise<any>;
73
76
  }
@@ -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,20 @@ 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
157
+ * @param state The publishing state of the component
152
158
  * @returns any OK
153
159
  * @throws ApiError
154
160
  */
155
- static componentStateUpdate(componentId, requestBody) {
161
+ static componentStateUpdate(componentId, state) {
156
162
  return __request(OpenAPI, {
157
163
  method: 'GET',
158
164
  url: '/components/{componentId}/state',
159
165
  path: {
160
166
  'componentId': componentId,
161
167
  },
162
- body: requestBody,
163
- mediaType: 'application/json',
168
+ query: {
169
+ 'state': state,
170
+ },
164
171
  errors: {
165
172
  401: `Unauthorized - Missing or invalid Authorization header`,
166
173
  403: `Forbidden - The client is authenticated but not authorized to access this resource`,
@@ -15,11 +15,14 @@ export declare class CoreService {
15
15
  * List all available templates
16
16
  * @param page Pagination, starting at page 1
17
17
  * @param limit Number of items per page
18
+ * @param order Order the sort query parameter values either by ascending or descending order
18
19
  * @param sort List of fields to sort by, this requires the order query param
20
+ * @param search The search strings to apply to the on query parameter values
21
+ * @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
22
  * @returns any The list of all templates given the parameters used
20
23
  * @throws ApiError
21
24
  */
22
- templateList(page?: number, limit?: number, sort?: any[]): CancelablePromise<{
25
+ templateList(page?: number, limit?: number, order?: 'asc' | 'desc', sort?: any[], search?: Array<string>, on?: Array<string>): CancelablePromise<{
23
26
  data?: Array<DTOTemplateRead>;
24
27
  pagination?: Pagination;
25
28
  }>;
@@ -61,11 +64,14 @@ export declare class CoreService {
61
64
  * List all available component
62
65
  * @param page Pagination, starting at page 1
63
66
  * @param limit Number of items per page
67
+ * @param order Order the sort query parameter values either by ascending or descending order
64
68
  * @param sort List of fields to sort by, this requires the order query param
69
+ * @param search The search strings to apply to the on query parameter values
70
+ * @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
71
  * @returns any The list of all component given the parameters used
66
72
  * @throws ApiError
67
73
  */
68
- componentList(page?: number, limit?: number, sort?: any[]): CancelablePromise<{
74
+ componentList(page?: number, limit?: number, order?: 'asc' | 'desc', sort?: any[], search?: Array<string>, on?: Array<string>): CancelablePromise<{
69
75
  data?: Array<DTOComponentRead>;
70
76
  pagination?: Pagination;
71
77
  }>;
@@ -115,11 +121,11 @@ export declare class CoreService {
115
121
  * Update Component State
116
122
  * Directly update component state. This does not create a new revision
117
123
  * @param componentId Id of a component
118
- * @param requestBody
124
+ * @param state The publishing state of the component
119
125
  * @returns any OK
120
126
  * @throws ApiError
121
127
  */
122
- componentStateUpdate(componentId: ComponentId, requestBody: ComponentState): CancelablePromise<any>;
128
+ componentStateUpdate(componentId: ComponentId, state: ComponentState): CancelablePromise<any>;
123
129
  /**
124
130
  * Resolve template hierarchy
125
131
  * @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,20 @@ 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
291
+ * @param state The publishing state of the component
280
292
  * @returns any OK
281
293
  * @throws ApiError
282
294
  */
283
- componentStateUpdate(componentId, requestBody) {
295
+ componentStateUpdate(componentId, state) {
284
296
  return __request(OpenAPI, {
285
297
  method: 'GET',
286
298
  url: '/components/{componentId}/state',
287
299
  path: {
288
300
  'componentId': componentId,
289
301
  },
290
- body: requestBody,
291
- mediaType: 'application/json',
302
+ query: {
303
+ 'state': state,
304
+ },
292
305
  errors: {
293
306
  401: `Unauthorized - Missing or invalid Authorization header`,
294
307
  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`,
@@ -74,6 +74,7 @@ export type { SearchQueryParam } from './models/SearchQueryParam';
74
74
  export type { SnapshotId } from './models/SnapshotId';
75
75
  export type { SnapshotIdPathParam } from './models/SnapshotIdPathParam';
76
76
  export type { SortQueryParam } from './models/SortQueryParam';
77
+ export type { StateQueryParam } from './models/StateQueryParam';
77
78
  export type { TagPathParam } from './models/TagPathParam';
78
79
  export type { TemplateId } from './models/TemplateId';
79
80
  export type { TemplateIdPathParam } from './models/TemplateIdPathParam';
@@ -0,0 +1,5 @@
1
+ import type { ComponentState } from './ComponentState';
2
+ /**
3
+ * The publishing state of the component
4
+ */
5
+ export type StateQueryParam = ComponentState;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "swoop-common",
3
- "version": "2.1.72",
3
+ "version": "2.1.74",
4
4
  "main": "dist/api/index.js",
5
5
  "types": "dist/api/index.d.ts",
6
6
  "exports": {