@breign/client 1.0.147 → 1.0.148

package/dist/apis/AppApi.d.ts

@@ -108,7 +108,7 @@ export interface GetAppFillersRequest {
 }
 export interface GetAppProbeRequest {
     appId: string;
-    instanceId?: string;
+    instanceId: string;
 }
 export interface GetAppsForAgentIdRequest {
     agentId: string;
@@ -127,8 +127,8 @@ export interface InterruptAppRequest {
 }
 export interface ProbeAppRequest {
     appId: string;
+    instanceId: string;
     appProbeRequestUio: AppProbeRequestUio;
-    instanceId?: string;
 }
 export interface RefreshAppProbeRequest {
     appId: string;
@@ -407,15 +407,15 @@ export declare class AppApi extends runtime.BaseAPI {
      */
     getAppFillers(appId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<FillersArrayInnerUio>>;
     /**
-     * Probe the app
-     * Probe the app
+     * Returns the last state snapshot posted by the instance. The probe belongs to the instance, so `instanceId` is required: without it the app has no probe to read. An instance that has never posted a probe answers 200 with an empty object.
+     * Read the last probe of an app instance
      */
     getAppProbeRaw(requestParameters: GetAppProbeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AppProbeResponseUio>>;
     /**
-     * Probe the app
-     * Probe the app
+     * Returns the last state snapshot posted by the instance. The probe belongs to the instance, so `instanceId` is required: without it the app has no probe to read. An instance that has never posted a probe answers 200 with an empty object.
+     * Read the last probe of an app instance
      */
-    getAppProbe(appId: string, instanceId?: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AppProbeResponseUio>;
+    getAppProbe(appId: string, instanceId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AppProbeResponseUio>;
     /**
      * Get apps for agent id
      * Get apps for agent id
@@ -457,15 +457,15 @@ export declare class AppApi extends runtime.BaseAPI {
      */
     interruptApp(appId: string, instanceId?: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BodyWithIdUio>;
     /**
-     * Probe the app
-     * Probe the app
+     * Records the state snapshot of the instance, replacing the previous one. `instanceId` is required — the probe is stored on the instance, not on the app. Any extra property of the body is kept as sent.
+     * Post the probe of an app instance
      */
     probeAppRaw(requestParameters: ProbeAppRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     * Probe the app
-     * Probe the app
+     * Records the state snapshot of the instance, replacing the previous one. `instanceId` is required — the probe is stored on the instance, not on the app. Any extra property of the body is kept as sent.
+     * Post the probe of an app instance
      */
-    probeApp(appId: string, appProbeRequestUio: AppProbeRequestUio, instanceId?: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    probeApp(appId: string, instanceId: string, appProbeRequestUio: AppProbeRequestUio, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
      * Refresh the app probe
      * Refresh the app probe

package/dist/apis/AppApi.js

@@ -780,13 +780,16 @@ class AppApi extends runtime.BaseAPI {
         return await response.value();
     }
     /**
-     * Probe the app
-     * Probe the app
+     * Returns the last state snapshot posted by the instance. The probe belongs to the instance, so `instanceId` is required: without it the app has no probe to read. An instance that has never posted a probe answers 200 with an empty object.
+     * Read the last probe of an app instance
      */
     async getAppProbeRaw(requestParameters, initOverrides) {
         if (requestParameters['appId'] == null) {
             throw new runtime.RequiredError('appId', 'Required parameter "appId" was null or undefined when calling getAppProbe().');
         }
+        if (requestParameters['instanceId'] == null) {
+            throw new runtime.RequiredError('instanceId', 'Required parameter "instanceId" was null or undefined when calling getAppProbe().');
+        }
         const queryParameters = {};
         if (requestParameters['instanceId'] != null) {
             queryParameters['instanceId'] = requestParameters['instanceId'];
@@ -804,8 +807,8 @@ class AppApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.AppProbeResponseUioFromJSON)(jsonValue));
     }
     /**
-     * Probe the app
-     * Probe the app
+     * Returns the last state snapshot posted by the instance. The probe belongs to the instance, so `instanceId` is required: without it the app has no probe to read. An instance that has never posted a probe answers 200 with an empty object.
+     * Read the last probe of an app instance
      */
     async getAppProbe(appId, instanceId, initOverrides) {
         const response = await this.getAppProbeRaw({ appId: appId, instanceId: instanceId }, initOverrides);
@@ -937,13 +940,16 @@ class AppApi extends runtime.BaseAPI {
         return await response.value();
     }
     /**
-     * Probe the app
-     * Probe the app
+     * Records the state snapshot of the instance, replacing the previous one. `instanceId` is required — the probe is stored on the instance, not on the app. Any extra property of the body is kept as sent.
+     * Post the probe of an app instance
      */
     async probeAppRaw(requestParameters, initOverrides) {
         if (requestParameters['appId'] == null) {
             throw new runtime.RequiredError('appId', 'Required parameter "appId" was null or undefined when calling probeApp().');
         }
+        if (requestParameters['instanceId'] == null) {
+            throw new runtime.RequiredError('instanceId', 'Required parameter "instanceId" was null or undefined when calling probeApp().');
+        }
         if (requestParameters['appProbeRequestUio'] == null) {
             throw new runtime.RequiredError('appProbeRequestUio', 'Required parameter "appProbeRequestUio" was null or undefined when calling probeApp().');
         }
@@ -966,11 +972,11 @@ class AppApi extends runtime.BaseAPI {
         return new runtime.VoidApiResponse(response);
     }
     /**
-     * Probe the app
-     * Probe the app
+     * Records the state snapshot of the instance, replacing the previous one. `instanceId` is required — the probe is stored on the instance, not on the app. Any extra property of the body is kept as sent.
+     * Post the probe of an app instance
      */
-    async probeApp(appId, appProbeRequestUio, instanceId, initOverrides) {
-        await this.probeAppRaw({ appId: appId, appProbeRequestUio: appProbeRequestUio, instanceId: instanceId }, initOverrides);
+    async probeApp(appId, instanceId, appProbeRequestUio, initOverrides) {
+        await this.probeAppRaw({ appId: appId, instanceId: instanceId, appProbeRequestUio: appProbeRequestUio }, initOverrides);
     }
     /**
      * Refresh the app probe

package/dist/models/AppProbeResponseUio.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * Dernier probe remonte par l'instance. Un objet vide signifie que l'instance n'a jamais probe : `id` et `date` sont alors absents.
  * @export
  * @interface AppProbeResponseUio
  */
@@ -21,13 +21,13 @@ export interface AppProbeResponseUio {
      * @type {string}
      * @memberof AppProbeResponseUio
      */
-    id: string;
+    id?: string;
     /**
      *
      * @type {string}
      * @memberof AppProbeResponseUio
      */
-    date: string;
+    date?: string;
 }
 /**
  * Check if a given object implements the AppProbeResponseUio interface.

package/dist/models/AppProbeResponseUio.js

@@ -22,10 +22,6 @@ exports.AppProbeResponseUioToJSONTyped = AppProbeResponseUioToJSONTyped;
  * Check if a given object implements the AppProbeResponseUio interface.
  */
 function instanceOfAppProbeResponseUio(value) {
-    if (!('id' in value) || value['id'] === undefined)
-        return false;
-    if (!('date' in value) || value['date'] === undefined)
-        return false;
     return true;
 }
 function AppProbeResponseUioFromJSON(json) {
@@ -37,8 +33,8 @@ function AppProbeResponseUioFromJSONTyped(json, ignoreDiscriminator) {
     }
     return {
         ...json,
-        'id': json['id'],
-        'date': json['date'],
+        'id': json['id'] == null ? undefined : json['id'],
+        'date': json['date'] == null ? undefined : json['date'],
     };
 }
 function AppProbeResponseUioToJSON(json) {

package/dist/openapi.json

@@ -3358,7 +3358,7 @@
     },
     "/apps/{appId}/probe" : {
       "get" : {
-        "description" : "Probe the app",
+        "description" : "Returns the last state snapshot posted by the instance. The probe belongs to the instance, so `instanceId` is required: without it the app has no probe to read. An instance that has never posted a probe answers 200 with an empty object.",
         "operationId" : "getAppProbe",
         "parameters" : [ {
           "description" : "ID of the app",
@@ -3369,9 +3369,10 @@
             "type" : "string"
           }
         }, {
-          "description" : "Instance id",
+          "description" : "The instance whose probe is read. `DEFAULT` is not accepted.",
           "in" : "query",
           "name" : "instanceId",
+          "required" : true,
           "schema" : {
             "type" : "string"
           }
@@ -3385,14 +3386,26 @@
                 }
               }
             },
-            "description" : "App probe retrieved successfully"
+            "description" : "Last probe of the instance, or an empty object if it never probed"
+          },
+          "400" : {
+            "description" : "instanceId is missing or is `DEFAULT`"
+          },
+          "401" : {
+            "description" : "Unauthorized"
+          },
+          "403" : {
+            "description" : "Forbidden"
+          },
+          "404" : {
+            "description" : "App or instance not found"
           }
         },
-        "summary" : "Probe the app",
+        "summary" : "Read the last probe of an app instance",
         "tags" : [ "app" ]
       },
       "post" : {
-        "description" : "Probe the app",
+        "description" : "Records the state snapshot of the instance, replacing the previous one. `instanceId` is required — the probe is stored on the instance, not on the app. Any extra property of the body is kept as sent.",
         "operationId" : "probeApp",
         "parameters" : [ {
           "description" : "ID of the app",
@@ -3403,9 +3416,10 @@
             "type" : "string"
           }
         }, {
-          "description" : "Instance id",
+          "description" : "The instance the probe belongs to. `DEFAULT` is not accepted.",
           "in" : "query",
           "name" : "instanceId",
+          "required" : true,
           "schema" : {
             "type" : "string"
           }
@@ -3422,10 +3436,22 @@
         },
         "responses" : {
           "204" : {
-            "description" : "App probed successfully"
+            "description" : "Probe recorded"
+          },
+          "400" : {
+            "description" : "Invalid body, or instanceId missing or `DEFAULT`"
+          },
+          "401" : {
+            "description" : "Unauthorized"
+          },
+          "403" : {
+            "description" : "Forbidden"
+          },
+          "404" : {
+            "description" : "App or instance not found"
           }
         },
-        "summary" : "Probe the app",
+        "summary" : "Post the probe of an app instance",
         "tags" : [ "app" ]
       }
     },
@@ -18476,6 +18502,7 @@
       },
       "AppProbeResponse" : {
         "additionalProperties" : true,
+        "description" : "Dernier probe remonte par l'instance. Un objet vide signifie que l'instance n'a jamais probe : `id` et `date` sont alors absents.",
         "properties" : {
           "id" : {
             "type" : "string"
@@ -18484,7 +18511,6 @@
             "type" : "string"
           }
         },
-        "required" : [ "date", "id" ],
         "type" : "object"
       },
       "AppProbeRequest" : {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@breign/client",
-  "version": "1.0.147",
+  "version": "1.0.148",
   "main": "dist/index.js",
   "exports": {
     ".": "./dist/index.js",