@software-hardware-integration-lab/sdk-shield 3.0.0 → 3.5.2-beta.a5c1c2f

package/bin/sdk/api/update/upload/index.d.ts

@@ -0,0 +1,27 @@
+import { type BaseRequestBuilder, type RequestConfiguration, type RequestInformation, type RequestsMetadata } from '@microsoft/kiota-abstractions';
+/**
+ * Builds and executes requests for operations under /Api/Update/Upload
+ */
+export interface UploadRequestBuilder extends BaseRequestBuilder<UploadRequestBuilder> {
+    /**
+     * THIS API SHOULD ONLY BE USED IF INSTRUCTED BY SHI EMPLOYEES!Uploads the specified ZIP package, validates signature and installs it if it matches. This ignores version numbers and will allow you to install the same version again if necessary.This endpoint requires the `Update.ReadWrite`, or the `Everything.ReadWrite` scope (permission).
+     * @param body Binary request body
+     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
+     */
+    post(body: ArrayBuffer | undefined, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<void>;
+    /**
+     * THIS API SHOULD ONLY BE USED IF INSTRUCTED BY SHI EMPLOYEES!Uploads the specified ZIP package, validates signature and installs it if it matches. This ignores version numbers and will allow you to install the same version again if necessary.This endpoint requires the `Update.ReadWrite`, or the `Everything.ReadWrite` scope (permission).
+     * @param body Binary request body
+     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
+     * @returns {RequestInformation}
+     */
+    toPostRequestInformation(body: ArrayBuffer | undefined, requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
+}
+/**
+ * Uri template for the request builder.
+ */
+export declare const UploadRequestBuilderUriTemplate = "{+baseurl}/Api/Update/Upload";
+/**
+ * Metadata for all the requests in the request builder.
+ */
+export declare const UploadRequestBuilderRequestsMetadata: RequestsMetadata;

package/bin/sdk/api/update/upload/index.js

@@ -0,0 +1,9 @@
+export const UploadRequestBuilderUriTemplate = "{+baseurl}/Api/Update/Upload";
+export const UploadRequestBuilderRequestsMetadata = {
+    post: {
+        uriTemplate: UploadRequestBuilderUriTemplate,
+        adapterMethodName: "sendNoResponseContent",
+        requestBodyContentType: "application/octet-stream",
+        requestInformationContentSetMethod: "setStreamContent",
+    },
+};

package/bin/sdk/models/architectureReport/index.d.ts

@@ -0,0 +1,49 @@
+import { type AdditionalDataHolder, type Guid, type Parsable, type ParseNode, type SerializationWriter } from '@microsoft/kiota-abstractions';
+/**
+ * Metadata that describes the execution session (run) that is used to tie/relate all of the architecture report together.
+ */
+export interface CorrelationRecord extends AdditionalDataHolder, Parsable {
+    /**
+     * The user principal name used to authenticate into the tenant being audited.
+     */
+    auditTenantAccount?: string | null;
+    /**
+     * Unique Identifier that represents a single run of architectural analysis. This record is used to identify which architecture report records should be grouped together.
+     */
+    correlationId?: Guid | null;
+    /**
+     * Timestamp when the record was created.
+     */
+    createdAt?: Date | null;
+    /**
+     * User account used to store/report the architecture report to the SHI Lab cloud service.
+     */
+    reportTenantAccount?: string | null;
+    /**
+     * Unique identifier of the customer tenant that the report was created for.
+     */
+    tenantId?: Guid | null;
+    /**
+     * Timestamp when the record was updated last.
+     */
+    updatedAt?: Date | null;
+}
+/**
+ * Creates a new instance of the appropriate class based on discriminator value
+ * @param parseNode The parse node to use to read the discriminator value and create the object
+ * @returns {CorrelationRecord}
+ */
+export declare function createCorrelationRecordFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
+/**
+ * The deserialization information for the current model
+ * @param CorrelationRecord The instance to deserialize into.
+ * @returns {Record<string, (node: ParseNode) => void>}
+ */
+export declare function deserializeIntoCorrelationRecord(correlationRecord?: Partial<CorrelationRecord> | undefined): Record<string, (node: ParseNode) => void>;
+/**
+ * Serializes information the current object
+ * @param CorrelationRecord The instance to serialize from.
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
+ * @param writer Serialization writer to use to serialize this model
+ */
+export declare function serializeCorrelationRecord(writer: SerializationWriter, correlationRecord?: Partial<CorrelationRecord> | undefined | null, isSerializingDerivedType?: boolean): void;

package/bin/sdk/models/architectureReport/index.js

@@ -0,0 +1,25 @@
+export function createCorrelationRecordFromDiscriminatorValue(parseNode) {
+    return deserializeIntoCorrelationRecord;
+}
+export function deserializeIntoCorrelationRecord(correlationRecord = {}) {
+    return {
+        "auditTenantAccount": n => { correlationRecord.auditTenantAccount = n.getStringValue(); },
+        "correlationId": n => { correlationRecord.correlationId = n.getGuidValue(); },
+        "createdAt": n => { correlationRecord.createdAt = n.getDateValue(); },
+        "reportTenantAccount": n => { correlationRecord.reportTenantAccount = n.getStringValue(); },
+        "tenantId": n => { correlationRecord.tenantId = n.getGuidValue(); },
+        "updatedAt": n => { correlationRecord.updatedAt = n.getDateValue(); },
+    };
+}
+export function serializeCorrelationRecord(writer, correlationRecord = {}, isSerializingDerivedType = false) {
+    if (!correlationRecord || isSerializingDerivedType) {
+        return;
+    }
+    writer.writeStringValue("auditTenantAccount", correlationRecord.auditTenantAccount);
+    writer.writeGuidValue("correlationId", correlationRecord.correlationId);
+    writer.writeDateValue("createdAt", correlationRecord.createdAt);
+    writer.writeStringValue("reportTenantAccount", correlationRecord.reportTenantAccount);
+    writer.writeGuidValue("tenantId", correlationRecord.tenantId);
+    writer.writeDateValue("updatedAt", correlationRecord.updatedAt);
+    writer.writeAdditionalData(correlationRecord.additionalData);
+}

package/bin/sdk/models/core/index.d.ts

@@ -0,0 +1,137 @@
+import { type AdditionalDataHolder, type ApiError, type Guid, type Parsable, type ParseNode, type SerializationWriter } from '@microsoft/kiota-abstractions';
+/**
+ * Creates a new instance of the appropriate class based on discriminator value
+ * @param parseNode The parse node to use to read the discriminator value and create the object
+ * @returns {HealthReport}
+ */
+export declare function createHealthReportFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
+/**
+ * Creates a new instance of the appropriate class based on discriminator value
+ * @param parseNode The parse node to use to read the discriminator value and create the object
+ * @returns {ProgressBar}
+ */
+export declare function createProgressBarFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
+/**
+ * Creates a new instance of the appropriate class based on discriminator value
+ * @param parseNode The parse node to use to read the discriminator value and create the object
+ * @returns {SystemRequirements}
+ */
+export declare function createSystemRequirementsFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
+/**
+ * The deserialization information for the current model
+ * @param HealthReport The instance to deserialize into.
+ * @returns {Record<string, (node: ParseNode) => void>}
+ */
+export declare function deserializeIntoHealthReport(healthReport?: Partial<HealthReport> | undefined): Record<string, (node: ParseNode) => void>;
+/**
+ * The deserialization information for the current model
+ * @param ProgressBar The instance to deserialize into.
+ * @returns {Record<string, (node: ParseNode) => void>}
+ */
+export declare function deserializeIntoProgressBar(progressBar?: Partial<ProgressBar> | undefined): Record<string, (node: ParseNode) => void>;
+/**
+ * The deserialization information for the current model
+ * @param SystemRequirements The instance to deserialize into.
+ * @returns {Record<string, (node: ParseNode) => void>}
+ */
+export declare function deserializeIntoSystemRequirements(systemRequirements?: Partial<SystemRequirements> | undefined): Record<string, (node: ParseNode) => void>;
+/**
+ * Health report that indicates if a service is down or not that SHIELD web app relies on.
+ */
+export interface HealthReport extends AdditionalDataHolder, ApiError, Parsable {
+    /**
+     * Flag that indicates if the client side authentication validation is working or not.
+     */
+    authClient?: boolean | null;
+    /**
+     * Flag that indicates if the server side authentication is working or not.
+     */
+    authServer?: boolean | null;
+}
+/**
+ * Used to indicate the progress of a long running operation.
+ */
+export interface ProgressBar extends AdditionalDataHolder, Parsable {
+    /**
+     * Sub progress bar that should appear below the current progress bar for a dependent execution branch.
+     */
+    childBar?: ProgressBar[] | null;
+    /**
+     * Current step/value for the progress bar. This is in relation to the `totalStepCount` property. If undefined, an indeterminate/pulsing progress bar is used instead.
+     */
+    currentStep?: number | null;
+    /**
+     * Long form text describing the current step.
+     */
+    description?: string | null;
+    /**
+     * Text/label to render with the progress bar.
+     */
+    displayName?: string | null;
+    /**
+     * Unique identifier to be able to select this specific instance via search.
+     */
+    id?: Guid | null;
+    /**
+     * Number of steps before the progress bar is completely filed.
+     */
+    totalStepCount?: number | null;
+}
+/**
+ * Serializes information the current object
+ * @param HealthReport The instance to serialize from.
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
+ * @param writer Serialization writer to use to serialize this model
+ */
+export declare function serializeHealthReport(writer: SerializationWriter, healthReport?: Partial<HealthReport> | undefined | null, isSerializingDerivedType?: boolean): void;
+/**
+ * Serializes information the current object
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
+ * @param ProgressBar The instance to serialize from.
+ * @param writer Serialization writer to use to serialize this model
+ */
+export declare function serializeProgressBar(writer: SerializationWriter, progressBar?: Partial<ProgressBar> | undefined | null, isSerializingDerivedType?: boolean): void;
+/**
+ * Serializes information the current object
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
+ * @param SystemRequirements The instance to serialize from.
+ * @param writer Serialization writer to use to serialize this model
+ */
+export declare function serializeSystemRequirements(writer: SerializationWriter, systemRequirements?: Partial<SystemRequirements> | undefined | null, isSerializingDerivedType?: boolean): void;
+/**
+ * Collection of indicators that notify the caller if the system requirements have been met for various sub components to operate.
+ */
+export interface SystemRequirements extends AdditionalDataHolder, Parsable {
+    /**
+     * Flag that indicates if the required core Azure RBAC assignment(s) are present or not.
+     */
+    azurePermissions?: boolean | null;
+    /**
+     * Flag that indicates if the core permissions for the SHI - Data Gateway have been configured properly or not.
+     */
+    dataGatewayPermissions?: boolean | null;
+    /**
+     * Flag that indicates if the required defend licenses are present or not.
+     */
+    defendEntitlement?: boolean | null;
+    /**
+     * Flag that indicates if the required deploy licenses are present or not.
+     */
+    deployEntitlement?: boolean | null;
+    /**
+     * Flag that indicates if the core permissions for the SHIELD - Authenticator App have been configured properly or not.
+     */
+    desktopPermissions?: boolean | null;
+    /**
+     * Flag that indicates if the required discover licenses are present or not.
+     */
+    discoverEntitlement?: boolean | null;
+    /**
+     * Flag that indicates if the core permissions for Entra Directory Role assignment have been configured properly or not.
+     */
+    entraDirectoryRole?: boolean | null;
+    /**
+     * Flag that indicates if the core permissions for the Microsoft Graph API have been configured properly or not.
+     */
+    msGraphPermissions?: boolean | null;
+}

package/bin/sdk/models/core/index.js

@@ -0,0 +1,71 @@
+export function createHealthReportFromDiscriminatorValue(parseNode) {
+    return deserializeIntoHealthReport;
+}
+export function createProgressBarFromDiscriminatorValue(parseNode) {
+    return deserializeIntoProgressBar;
+}
+export function createSystemRequirementsFromDiscriminatorValue(parseNode) {
+    return deserializeIntoSystemRequirements;
+}
+export function deserializeIntoHealthReport(healthReport = {}) {
+    return {
+        "authClient": n => { healthReport.authClient = n.getBooleanValue(); },
+        "authServer": n => { healthReport.authServer = n.getBooleanValue(); },
+    };
+}
+export function deserializeIntoProgressBar(progressBar = {}) {
+    return {
+        "childBar": n => { progressBar.childBar = n.getCollectionOfObjectValues(createProgressBarFromDiscriminatorValue); },
+        "currentStep": n => { progressBar.currentStep = n.getNumberValue(); },
+        "description": n => { progressBar.description = n.getStringValue(); },
+        "displayName": n => { progressBar.displayName = n.getStringValue(); },
+        "id": n => { progressBar.id = n.getGuidValue(); },
+        "totalStepCount": n => { progressBar.totalStepCount = n.getNumberValue(); },
+    };
+}
+export function deserializeIntoSystemRequirements(systemRequirements = {}) {
+    return {
+        "azurePermissions": n => { systemRequirements.azurePermissions = n.getBooleanValue(); },
+        "dataGatewayPermissions": n => { systemRequirements.dataGatewayPermissions = n.getBooleanValue(); },
+        "defendEntitlement": n => { systemRequirements.defendEntitlement = n.getBooleanValue(); },
+        "deployEntitlement": n => { systemRequirements.deployEntitlement = n.getBooleanValue(); },
+        "desktopPermissions": n => { systemRequirements.desktopPermissions = n.getBooleanValue(); },
+        "discoverEntitlement": n => { systemRequirements.discoverEntitlement = n.getBooleanValue(); },
+        "entraDirectoryRole": n => { systemRequirements.entraDirectoryRole = n.getBooleanValue(); },
+        "msGraphPermissions": n => { systemRequirements.msGraphPermissions = n.getBooleanValue(); },
+    };
+}
+export function serializeHealthReport(writer, healthReport = {}, isSerializingDerivedType = false) {
+    if (!healthReport || isSerializingDerivedType) {
+        return;
+    }
+    writer.writeBooleanValue("authClient", healthReport.authClient);
+    writer.writeBooleanValue("authServer", healthReport.authServer);
+    writer.writeAdditionalData(healthReport.additionalData);
+}
+export function serializeProgressBar(writer, progressBar = {}, isSerializingDerivedType = false) {
+    if (!progressBar || isSerializingDerivedType) {
+        return;
+    }
+    writer.writeCollectionOfObjectValues("childBar", progressBar.childBar, serializeProgressBar);
+    writer.writeNumberValue("currentStep", progressBar.currentStep);
+    writer.writeStringValue("description", progressBar.description);
+    writer.writeStringValue("displayName", progressBar.displayName);
+    writer.writeGuidValue("id", progressBar.id);
+    writer.writeNumberValue("totalStepCount", progressBar.totalStepCount);
+    writer.writeAdditionalData(progressBar.additionalData);
+}
+export function serializeSystemRequirements(writer, systemRequirements = {}, isSerializingDerivedType = false) {
+    if (!systemRequirements || isSerializingDerivedType) {
+        return;
+    }
+    writer.writeBooleanValue("azurePermissions", systemRequirements.azurePermissions);
+    writer.writeBooleanValue("dataGatewayPermissions", systemRequirements.dataGatewayPermissions);
+    writer.writeBooleanValue("defendEntitlement", systemRequirements.defendEntitlement);
+    writer.writeBooleanValue("deployEntitlement", systemRequirements.deployEntitlement);
+    writer.writeBooleanValue("desktopPermissions", systemRequirements.desktopPermissions);
+    writer.writeBooleanValue("discoverEntitlement", systemRequirements.discoverEntitlement);
+    writer.writeBooleanValue("entraDirectoryRole", systemRequirements.entraDirectoryRole);
+    writer.writeBooleanValue("msGraphPermissions", systemRequirements.msGraphPermissions);
+    writer.writeAdditionalData(systemRequirements.additionalData);
+}