swoop-common 2.2.1 → 2.2.2

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.
@@ -1,4 +1,6 @@
1
1
  export type Error = {
2
- spanId: string;
3
2
  message: string;
3
+ code: number;
4
+ trace: number;
5
+ span: number;
4
6
  };
@@ -34,7 +34,7 @@ export declare class ComponentService {
34
34
  * Get Component
35
35
  * Get Component via ID
36
36
  * @param componentId Id of a component
37
- * @returns any OK
37
+ * @returns any The request was completed successfully
38
38
  * @throws ApiError
39
39
  */
40
40
  static componentGet(componentId: ComponentId): CancelablePromise<any>;
@@ -58,7 +58,7 @@ export class ComponentService {
58
58
  * Get Component
59
59
  * Get Component via ID
60
60
  * @param componentId Id of a component
61
- * @returns any OK
61
+ * @returns any The request was completed successfully
62
62
  * @throws ApiError
63
63
  */
64
64
  static componentGet(componentId) {
@@ -69,9 +69,10 @@ export class ComponentService {
69
69
  'componentId': componentId,
70
70
  },
71
71
  errors: {
72
- 401: `Unauthorized - Missing or invalid Authorization header`,
73
- 403: `Forbidden - The client is authenticated but not authorized to access this resource`,
74
- 404: `If the component does not exist`,
72
+ 401: `Missing or invalid Authorization header`,
73
+ 403: `The client is authenticated but not authorized to access this resource`,
74
+ 404: `If a resource is not found`,
75
+ 500: `Internal Server Error`,
75
76
  },
76
77
  });
77
78
  }
@@ -39,7 +39,7 @@ export declare class CoreService {
39
39
  * Create a Snapshot
40
40
  * Creates a new snapshot. A snapshot is a reference to a specific itinerary revision group id.
41
41
  * @param requestBody
42
- * @returns DTOSnapshotRead When a snapshot is created
42
+ * @returns DTOSnapshotRead When the entity is created
43
43
  * @throws ApiError
44
44
  */
45
45
  snapshotCreate(requestBody: DTOSnapshotCreate): CancelablePromise<DTOSnapshotRead>;
@@ -261,7 +261,7 @@ export declare class CoreService {
261
261
  * Get Component
262
262
  * Get Component via ID
263
263
  * @param componentId Id of a component
264
- * @returns any OK
264
+ * @returns any The request was completed successfully
265
265
  * @throws ApiError
266
266
  */
267
267
  componentGet(componentId: ComponentId): CancelablePromise<any>;
@@ -40,7 +40,7 @@ export class CoreService {
40
40
  * Create a Snapshot
41
41
  * Creates a new snapshot. A snapshot is a reference to a specific itinerary revision group id.
42
42
  * @param requestBody
43
- * @returns DTOSnapshotRead When a snapshot is created
43
+ * @returns DTOSnapshotRead When the entity is created
44
44
  * @throws ApiError
45
45
  */
46
46
  snapshotCreate(requestBody) {
@@ -51,10 +51,9 @@ export class CoreService {
51
51
  mediaType: 'application/json',
52
52
  errors: {
53
53
  400: `If the payload is malformed`,
54
- 401: `Unauthorized - Missing or invalid Authorization header`,
55
- 404: `If the entity does not exists`,
56
- 500: `When an internal server error occurs when creating a snapshot entity`,
57
- 503: `Service Unavailable - The server is temporarily unable to handle the request`,
54
+ 401: `When the user is not authorised to make a request`,
55
+ 404: `If the entity does not exist`,
56
+ 500: `When an internal server error occurs when creating the entity`,
58
57
  },
59
58
  });
60
59
  }
@@ -85,10 +84,9 @@ export class CoreService {
85
84
  'on': on,
86
85
  },
87
86
  errors: {
88
- 400: `If the filter options or query parameters contain invalid values`,
89
- 401: `Unauthorized - Missing or invalid Authorization header`,
90
- 500: `When an internal server error occurs when listing all related snapshots`,
91
- 503: `Service Unavailable - The server is temporarily unable to handle the request`,
87
+ 400: `If the payload is malformed`,
88
+ 401: `When the user is not authorised to make a request`,
89
+ 500: `When an internal server error occurs when creating the entity`,
92
90
  },
93
91
  });
94
92
  }
@@ -566,7 +564,7 @@ export class CoreService {
566
564
  * Get Component
567
565
  * Get Component via ID
568
566
  * @param componentId Id of a component
569
- * @returns any OK
567
+ * @returns any The request was completed successfully
570
568
  * @throws ApiError
571
569
  */
572
570
  componentGet(componentId) {
@@ -577,9 +575,10 @@ export class CoreService {
577
575
  'componentId': componentId,
578
576
  },
579
577
  errors: {
580
- 401: `Unauthorized - Missing or invalid Authorization header`,
581
- 403: `Forbidden - The client is authenticated but not authorized to access this resource`,
582
- 404: `If the component does not exist`,
578
+ 401: `Missing or invalid Authorization header`,
579
+ 403: `The client is authenticated but not authorized to access this resource`,
580
+ 404: `If a resource is not found`,
581
+ 500: `Internal Server Error`,
583
582
  },
584
583
  });
585
584
  }
@@ -8,7 +8,7 @@ export declare class SnapshotService {
8
8
  * Create a Snapshot
9
9
  * Creates a new snapshot. A snapshot is a reference to a specific itinerary revision group id.
10
10
  * @param requestBody
11
- * @returns DTOSnapshotRead When a snapshot is created
11
+ * @returns DTOSnapshotRead When the entity is created
12
12
  * @throws ApiError
13
13
  */
14
14
  static snapshotCreate(requestBody: DTOSnapshotCreate): CancelablePromise<DTOSnapshotRead>;
@@ -5,7 +5,7 @@ export class SnapshotService {
5
5
  * Create a Snapshot
6
6
  * Creates a new snapshot. A snapshot is a reference to a specific itinerary revision group id.
7
7
  * @param requestBody
8
- * @returns DTOSnapshotRead When a snapshot is created
8
+ * @returns DTOSnapshotRead When the entity is created
9
9
  * @throws ApiError
10
10
  */
11
11
  static snapshotCreate(requestBody) {
@@ -16,10 +16,9 @@ export class SnapshotService {
16
16
  mediaType: 'application/json',
17
17
  errors: {
18
18
  400: `If the payload is malformed`,
19
- 401: `Unauthorized - Missing or invalid Authorization header`,
20
- 404: `If the entity does not exists`,
21
- 500: `When an internal server error occurs when creating a snapshot entity`,
22
- 503: `Service Unavailable - The server is temporarily unable to handle the request`,
19
+ 401: `When the user is not authorised to make a request`,
20
+ 404: `If the entity does not exist`,
21
+ 500: `When an internal server error occurs when creating the entity`,
23
22
  },
24
23
  });
25
24
  }
@@ -50,10 +49,9 @@ export class SnapshotService {
50
49
  'on': on,
51
50
  },
52
51
  errors: {
53
- 400: `If the filter options or query parameters contain invalid values`,
54
- 401: `Unauthorized - Missing or invalid Authorization header`,
55
- 500: `When an internal server error occurs when listing all related snapshots`,
56
- 503: `Service Unavailable - The server is temporarily unable to handle the request`,
52
+ 400: `If the payload is malformed`,
53
+ 401: `When the user is not authorised to make a request`,
54
+ 500: `When an internal server error occurs when creating the entity`,
57
55
  },
58
56
  });
59
57
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "swoop-common",
3
- "version": "2.2.1",
3
+ "version": "2.2.2",
4
4
  "main": "dist/api/index.js",
5
5
  "types": "dist/api/index.d.ts",
6
6
  "exports": {