@easyedu/js-lsm-api 1.61.0 → 1.63.0

package/dist/models/PostLogin.d.ts

@@ -27,6 +27,12 @@ export interface PostLogin {
      * @memberof PostLogin
      */
     password: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof PostLogin
+     */
+    rememberMe?: boolean;
 }
 /**
  * Check if a given object implements the PostLogin interface.

package/dist/models/PostLogin.js

@@ -38,6 +38,7 @@ function PostLoginFromJSONTyped(json, ignoreDiscriminator) {
     return {
         'email': json['email'],
         'password': json['password'],
+        'rememberMe': json['remember_me'] == null ? undefined : json['remember_me'],
     };
 }
 function PostLoginToJSON(json) {
@@ -50,5 +51,6 @@ function PostLoginToJSONTyped(value, ignoreDiscriminator = false) {
     return {
         'email': value['email'],
         'password': value['password'],
+        'remember_me': value['rememberMe'],
     };
 }

package/docs/DispatchApi.md

@@ -0,0 +1,134 @@
+# DispatchApi
+
+All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com/stage1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getDispatchRollup**](DispatchApi.md#getdispatchrollup) | **GET** /dispatch/sessions/{dispatchPackageId}/rollup | Get dispatch package rollup data |
+| [**postDispatchLaunch**](DispatchApi.md#postdispatchlaunch) | **POST** /dispatch/launch | Launch a dispatch package |
+
+
+
+## getDispatchRollup
+
+> getDispatchRollup(dispatchPackageId)
+
+Get dispatch package rollup data
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DispatchApi,
+} from '@easyedu/js-lsm-api';
+import type { GetDispatchRollupRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new DispatchApi();
+
+  const body = {
+    // string
+    dispatchPackageId: dispatchPackageId_example,
+  } satisfies GetDispatchRollupRequest;
+
+  try {
+    const data = await api.getDispatchRollup(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **dispatchPackageId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Dispatch rollup data |  -  |
+| **401** | Dispatch token required |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## postDispatchLaunch
+
+> postDispatchLaunch()
+
+Launch a dispatch package
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DispatchApi,
+} from '@easyedu/js-lsm-api';
+import type { PostDispatchLaunchRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new DispatchApi();
+
+  try {
+    const data = await api.postDispatchLaunch();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Dispatch launch response |  -  |
+| **400** | Invalid launch request |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+