@nexgencloud/hyperstack-sdk-javascript 1.22.0-alpha

package/README.md

@@ -0,0 +1,640 @@
+# @nexgencloud/hyperstack-sdk-javascript
+
+HyperstackApi - JavaScript client for @nexgencloud/hyperstack-sdk-javascript
+Leverage the Infrahub API and Hyperstack platform to easily create, manage, and scale powerful GPU virtual machines and their associated resources. 
+
+Access this SDK to automate the deployment of your workloads and streamline your infrastructure management.
+
+To contribute, please raise an issue with a bug report, feature request, feedback, or general inquiry.
+This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 1.0
+- Package version: v1.22.0-alpha
+- Generator version: 7.10.0
+- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen
+
+## Installation
+
+### For [Node.js](https://nodejs.org/)
+
+#### npm
+
+To publish the library as a [npm](https://www.npmjs.com/), please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages).
+
+Then install it via:
+
+```shell
+npm install @nexgencloud/hyperstack-sdk-javascript --save
+```
+
+Finally, you need to build the module:
+
+```shell
+npm run build
+```
+
+##### Local development
+
+To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing `package.json` (and this README). Let's call this `JAVASCRIPT_CLIENT_DIR`. Then run:
+
+```shell
+npm install
+```
+
+Next, [link](https://docs.npmjs.com/cli/link) it globally in npm with the following, also from `JAVASCRIPT_CLIENT_DIR`:
+
+```shell
+npm link
+```
+
+To use the link you just defined in your project, switch to the directory you want to use your @nexgencloud/hyperstack-sdk-javascript from, and run:
+
+```shell
+npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
+```
+
+Finally, you need to build the module:
+
+```shell
+npm run build
+```
+
+#### git
+
+If the library is hosted at a git repository, e.g.https://github.com/NexGenCloud/hyperstack-sdk-javascript
+then install it via:
+
+```shell
+    npm install NexGenCloud/hyperstack-sdk-javascript --save
+```
+
+### For browser
+
+The library also works in the browser environment via npm and [browserify](http://browserify.org/). After following
+the above steps with Node.js and installing browserify with `npm install -g browserify`,
+perform the following (assuming *main.js* is your entry file):
+
+```shell
+browserify main.js > bundle.js
+```
+
+Then include *bundle.js* in the HTML pages.
+
+### Webpack Configuration
+
+Using Webpack you may encounter the following error: "Module not found: Error:
+Cannot resolve module", most certainly you should disable AMD loader. Add/merge
+the following section to your webpack config:
+
+```javascript
+module: {
+  rules: [
+    {
+      parser: {
+        amd: false
+      }
+    }
+  ]
+}
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) instruction and execute the following JS code:
+
+```javascript
+var HyperstackApi = require('@nexgencloud/hyperstack-sdk-javascript');
+
+
+var api = new HyperstackApi.AliveApi()
+api.getAlive().then(function() {
+  console.log('API called successfully.');
+}, function(error) {
+  console.error(error);
+});
+
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://infrahub-api.nexgencloud.com/v1*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*HyperstackApi.AliveApi* | [**getAlive**](docs/AliveApi.md#getAlive) | **GET** /billing/alive | GET: Alive
+*HyperstackApi.ApiKeyApi* | [**deleteApiKey**](docs/ApiKeyApi.md#deleteApiKey) | **DELETE** /api-key/{api_key_id} | Delete API Key
+*HyperstackApi.ApiKeyApi* | [**generateApiKey**](docs/ApiKeyApi.md#generateApiKey) | **POST** /api-key/generate | Generate API Key
+*HyperstackApi.ApiKeyApi* | [**retrieveApiKeys**](docs/ApiKeyApi.md#retrieveApiKeys) | **GET** /api-key | Retrieve API Keys
+*HyperstackApi.ApiKeyApi* | [**updateApiKey**](docs/ApiKeyApi.md#updateApiKey) | **PUT** /api-key/{api_key_id} | Update API Key
+*HyperstackApi.AssigningMemberRoleApi* | [**assignRbacRole**](docs/AssigningMemberRoleApi.md#assignRbacRole) | **PUT** /auth/users/{user_id}/assign-roles | Assign RBAC Role
+*HyperstackApi.AssigningMemberRoleApi* | [**removeRbacRoleFromUser**](docs/AssigningMemberRoleApi.md#removeRbacRoleFromUser) | **DELETE** /auth/users/{user_id}/roles | Remove RBAC Role From User
+*HyperstackApi.AuthApi* | [**retrieveAuthenticatedUserDetails**](docs/AuthApi.md#retrieveAuthenticatedUserDetails) | **GET** /auth/me | Retrieve Authenticated User Details
+*HyperstackApi.BillingApi* | [**getAllThresholdsForOrganization**](docs/BillingApi.md#getAllThresholdsForOrganization) | **GET** /billing/billing/threshold | GET: All Thresholds for Organization
+*HyperstackApi.BillingApi* | [**getBillingUsage**](docs/BillingApi.md#getBillingUsage) | **GET** /billing/billing/usage | GET: Billing usage
+*HyperstackApi.BillingApi* | [**getLastDayCost**](docs/BillingApi.md#getLastDayCost) | **GET** /billing/billing/last-day-cost | GET: Last Day Cost
+*HyperstackApi.BillingApi* | [**retrieveBillingHistoryForASpecificBillingCycle**](docs/BillingApi.md#retrieveBillingHistoryForASpecificBillingCycle) | **GET** /billing/billing/history | Retrieve Billing History for a specific Billing Cycle
+*HyperstackApi.BillingApi* | [**retrieveBillingHistoryOfASpecificSnapshotForASpecificBillingCycle**](docs/BillingApi.md#retrieveBillingHistoryOfASpecificSnapshotForASpecificBillingCycle) | **GET** /billing/billing/history/snapshot/{snapshot_id} | Retrieve Billing History of a Specific Snapshot for a specific Billing Cycle
+*HyperstackApi.BillingApi* | [**retrieveBillingHistoryOfASpecificVirtualMachineForASpecificBillingCycle**](docs/BillingApi.md#retrieveBillingHistoryOfASpecificVirtualMachineForASpecificBillingCycle) | **GET** /billing/billing/history/virtual-machine/{vm_id} | Retrieve Billing History of a Specific Virtual Machine for a specific Billing Cycle
+*HyperstackApi.BillingApi* | [**retrieveBillingHistoryOfASpecificVolumeForASpecificBillingCycle**](docs/BillingApi.md#retrieveBillingHistoryOfASpecificVolumeForASpecificBillingCycle) | **GET** /billing/billing/history/volume/{volume_id} | Retrieve Billing History of a Specific Volume for a specific Billing Cycle
+*HyperstackApi.BillingApi* | [**retrieveBillingHistoryOfContractForASpecificBillingCycle**](docs/BillingApi.md#retrieveBillingHistoryOfContractForASpecificBillingCycle) | **GET** /billing/billing/history/contract | Retrieve Billing History of Contract for a specific Billing Cycle
+*HyperstackApi.BillingApi* | [**retrieveBillingHistoryOfSnapshotForASpecificBillingCycle**](docs/BillingApi.md#retrieveBillingHistoryOfSnapshotForASpecificBillingCycle) | **GET** /billing/billing/history/snapshot | Retrieve Billing History of Snapshot for a specific Billing Cycle
+*HyperstackApi.BillingApi* | [**retrieveBillingHistoryOfVirtualMachineForASpecificBillingCycle**](docs/BillingApi.md#retrieveBillingHistoryOfVirtualMachineForASpecificBillingCycle) | **GET** /billing/billing/history/virtual-machine | Retrieve Billing History of Virtual Machine for a specific Billing Cycle
+*HyperstackApi.BillingApi* | [**retrieveBillingHistoryOfVolumeForASpecificBillingCycle**](docs/BillingApi.md#retrieveBillingHistoryOfVolumeForASpecificBillingCycle) | **GET** /billing/billing/history/volume | Retrieve Billing History of Volume for a specific Billing Cycle
+*HyperstackApi.BillingApi* | [**retrieveHourlyCostDatapointsOfASpecificSnapshotForASpecificBillingCycle**](docs/BillingApi.md#retrieveHourlyCostDatapointsOfASpecificSnapshotForASpecificBillingCycle) | **GET** /billing/billing/history/snapshot/{snapshot_id}/graph | Retrieve hourly cost datapoints of a Specific Snapshot for a specific billing cycle
+*HyperstackApi.BillingApi* | [**retrieveHourlyCostDatapointsOfASpecificVirtualMachineForASpecificBillingCycle**](docs/BillingApi.md#retrieveHourlyCostDatapointsOfASpecificVirtualMachineForASpecificBillingCycle) | **GET** /billing/billing/history/virtual-machine/{vm_id}/graph | Retrieve hourly cost datapoints of a Specific Virtual Machine for a specific billing cycle
+*HyperstackApi.BillingApi* | [**retrieveHourlyCostDatapointsOfASpecificVolumeForASpecificBillingCycle**](docs/BillingApi.md#retrieveHourlyCostDatapointsOfASpecificVolumeForASpecificBillingCycle) | **GET** /billing/billing/history/volume/{volume_id}/graph | Retrieve hourly cost datapoints of a Specific Volume for a specific billing cycle
+*HyperstackApi.BillingApi* | [**retrieveSubResourcesHistoricalCostDatapointsOfAVirtual**](docs/BillingApi.md#retrieveSubResourcesHistoricalCostDatapointsOfAVirtual) | **GET** /billing/billing/virtual-machine/{vm_id}/sub-resource/graph | Retrieve Sub-Resources Historical Cost datapoints of a Virtual
+*HyperstackApi.BillingApi* | [**retrieveTotalCostsAndNonDiscountCostsForSubResources**](docs/BillingApi.md#retrieveTotalCostsAndNonDiscountCostsForSubResources) | **GET** /billing/billing/virtual-machine/{vm_id}/sub-resource | Retrieve Total Costs and Non Discount Costs for Sub Resources
+*HyperstackApi.BillingApi* | [**retrieveVmBillingEventsHistory**](docs/BillingApi.md#retrieveVmBillingEventsHistory) | **GET** /billing/billing/virtual-machine/{vm_id}/billing-events | Retrieve VM billing events history
+*HyperstackApi.BillingApi* | [**retrieveVolumeBillingEventsHistory**](docs/BillingApi.md#retrieveVolumeBillingEventsHistory) | **GET** /billing/billing/volume/{volume_id}/billing-events | Retrieve Volume billing events history
+*HyperstackApi.BillingApi* | [**updateSubscribeOrUnsubscribeNotificationThreshold**](docs/BillingApi.md#updateSubscribeOrUnsubscribeNotificationThreshold) | **PUT** /billing/billing/threshold/{threshold_id} | Update: Subscribe or Unsubscribe Notification Threshold
+*HyperstackApi.CalculateApi* | [**retrieveBillingRateForResource**](docs/CalculateApi.md#retrieveBillingRateForResource) | **GET** /pricebook/calculate/resource/{resource_type}/{id} | Retrieve Billing Rate for Resource
+*HyperstackApi.CallbacksApi* | [**attachCallbackToVirtualMachine**](docs/CallbacksApi.md#attachCallbackToVirtualMachine) | **POST** /core/virtual-machines/{id}/attach-callback | Attach callback to virtual machine
+*HyperstackApi.CallbacksApi* | [**attachCallbackToVolume**](docs/CallbacksApi.md#attachCallbackToVolume) | **POST** /core/volumes/{id}/attach-callback | Attach callback to volume
+*HyperstackApi.CallbacksApi* | [**deleteVirtualMachineCallback**](docs/CallbacksApi.md#deleteVirtualMachineCallback) | **DELETE** /core/virtual-machines/{id}/delete-callback | Delete virtual machine callback
+*HyperstackApi.CallbacksApi* | [**deleteVolumeCallback**](docs/CallbacksApi.md#deleteVolumeCallback) | **DELETE** /core/volumes/{id}/delete-callback | Delete volume callback
+*HyperstackApi.CallbacksApi* | [**updateVirtualMachineCallback**](docs/CallbacksApi.md#updateVirtualMachineCallback) | **PUT** /core/virtual-machines/{id}/update-callback | Update virtual machine callback
+*HyperstackApi.CallbacksApi* | [**updateVolumeCallback**](docs/CallbacksApi.md#updateVolumeCallback) | **PUT** /core/volumes/{id}/update-callback | Update volume callback
+*HyperstackApi.ClusterEventsApi* | [**fetchAllOfAClusterEvents**](docs/ClusterEventsApi.md#fetchAllOfAClusterEvents) | **GET** /core/clusters/{cluster_id}/events | Fetch all of a cluster events
+*HyperstackApi.ClustersApi* | [**createCluster**](docs/ClustersApi.md#createCluster) | **POST** /core/clusters | Create Cluster
+*HyperstackApi.ClustersApi* | [**deleteACluster**](docs/ClustersApi.md#deleteACluster) | **DELETE** /core/clusters/{id} | Delete a cluster
+*HyperstackApi.ClustersApi* | [**fetchClusterNameAvailability**](docs/ClustersApi.md#fetchClusterNameAvailability) | **GET** /core/clusters/name-availability/{name} | Fetch cluster name availability
+*HyperstackApi.ClustersApi* | [**getClusterVersions**](docs/ClustersApi.md#getClusterVersions) | **GET** /core/clusters/versions | GET Cluster Versions
+*HyperstackApi.ClustersApi* | [**gettingClusterDetail**](docs/ClustersApi.md#gettingClusterDetail) | **GET** /core/clusters/{id} | Getting Cluster Detail
+*HyperstackApi.ClustersApi* | [**listClusters**](docs/ClustersApi.md#listClusters) | **GET** /core/clusters | List Clusters
+*HyperstackApi.ComplianceApi* | [**createCompliance**](docs/ComplianceApi.md#createCompliance) | **POST** /core/compliance | Create compliance
+*HyperstackApi.ComplianceApi* | [**deleteACompliance**](docs/ComplianceApi.md#deleteACompliance) | **DELETE** /core/compliance/{gpu_model} | Delete a compliance
+*HyperstackApi.ComplianceApi* | [**retrieveGpuCompliance**](docs/ComplianceApi.md#retrieveGpuCompliance) | **GET** /core/compliance | Retrieve GPU compliance
+*HyperstackApi.ComplianceApi* | [**updateACompliance**](docs/ComplianceApi.md#updateACompliance) | **PUT** /core/compliance | Update a compliance
+*HyperstackApi.CreditApi* | [**getViewCreditAndThreshold**](docs/CreditApi.md#getViewCreditAndThreshold) | **GET** /billing/user-credit/credit | GET: View credit and threshold
+*HyperstackApi.CustomerContractApi* | [**listContracts**](docs/CustomerContractApi.md#listContracts) | **GET** /pricebook/contracts | List Contracts
+*HyperstackApi.CustomerContractApi* | [**retrieveContractDetails**](docs/CustomerContractApi.md#retrieveContractDetails) | **GET** /pricebook/contracts/{contract_id} | Retrieve Contract Details
+*HyperstackApi.CustomerContractApi* | [**retrieveGpuAllocationGraphForContract**](docs/CustomerContractApi.md#retrieveGpuAllocationGraphForContract) | **GET** /pricebook/contracts/{contract_id}/gpu_allocation_graph | Retrieve GPU Allocation Graph for Contract
+*HyperstackApi.DashboardApi* | [**retrieveDashboard**](docs/DashboardApi.md#retrieveDashboard) | **GET** /core/dashboard | Retrieve Dashboard
+*HyperstackApi.DeploymentApi* | [**deleteDeployment**](docs/DeploymentApi.md#deleteDeployment) | **DELETE** /core/marketplace/deployments/{id} | Delete Deployment
+*HyperstackApi.DeploymentApi* | [**detailsOfDeploymentById**](docs/DeploymentApi.md#detailsOfDeploymentById) | **GET** /core/marketplace/deployments/{id} | Details of Deployment by ID
+*HyperstackApi.DeploymentApi* | [**listDeployments**](docs/DeploymentApi.md#listDeployments) | **GET** /core/marketplace/deployments | List Deployments
+*HyperstackApi.DeploymentApi* | [**startDeployment**](docs/DeploymentApi.md#startDeployment) | **POST** /core/marketplace/deployments | Start Deployment
+*HyperstackApi.EnvironmentApi* | [**createEnvironment**](docs/EnvironmentApi.md#createEnvironment) | **POST** /core/environments | Create environment
+*HyperstackApi.EnvironmentApi* | [**deleteEnvironment**](docs/EnvironmentApi.md#deleteEnvironment) | **DELETE** /core/environments/{id} | Delete environment
+*HyperstackApi.EnvironmentApi* | [**listEnvironments**](docs/EnvironmentApi.md#listEnvironments) | **GET** /core/environments | List environments
+*HyperstackApi.EnvironmentApi* | [**retrieveEnvironment**](docs/EnvironmentApi.md#retrieveEnvironment) | **GET** /core/environments/{id} | Retrieve environment
+*HyperstackApi.EnvironmentApi* | [**updateEnvironment**](docs/EnvironmentApi.md#updateEnvironment) | **PUT** /core/environments/{id} | Update environment
+*HyperstackApi.FirewallAttachmentApi* | [**attachFirewallsToVms**](docs/FirewallAttachmentApi.md#attachFirewallsToVms) | **POST** /core/firewalls/{firewall_id}/update-attachments | Attach Firewalls to VMs
+*HyperstackApi.FirewallsApi* | [**addFirewallRuleToFirewall**](docs/FirewallsApi.md#addFirewallRuleToFirewall) | **POST** /core/firewalls/{firewall_id}/firewall-rules | Add firewall rule to firewall
+*HyperstackApi.FirewallsApi* | [**createFirewall**](docs/FirewallsApi.md#createFirewall) | **POST** /core/firewalls | Create firewall
+*HyperstackApi.FirewallsApi* | [**deleteFirewall**](docs/FirewallsApi.md#deleteFirewall) | **DELETE** /core/firewalls/{id} | Delete firewall
+*HyperstackApi.FirewallsApi* | [**deleteFirewallRulesFromFirewall**](docs/FirewallsApi.md#deleteFirewallRulesFromFirewall) | **DELETE** /core/firewalls/{firewall_id}/firewall-rules/{firewall_rule_id} | Delete firewall rules from firewall
+*HyperstackApi.FirewallsApi* | [**listFirewalls**](docs/FirewallsApi.md#listFirewalls) | **GET** /core/firewalls | List firewalls
+*HyperstackApi.FirewallsApi* | [**retrieveFirewallDetails**](docs/FirewallsApi.md#retrieveFirewallDetails) | **GET** /core/firewalls/{id} | Retrieve firewall details
+*HyperstackApi.FlavorApi* | [**listFlavors**](docs/FlavorApi.md#listFlavors) | **GET** /core/flavors | List Flavors
+*HyperstackApi.FloatingIpApi* | [**attachPublicIpToVirtualMachine**](docs/FloatingIpApi.md#attachPublicIpToVirtualMachine) | **POST** /core/virtual-machines/{id}/attach-floatingip | Attach public IP to virtual machine
+*HyperstackApi.FloatingIpApi* | [**detachPublicIpFromVirtualMachine**](docs/FloatingIpApi.md#detachPublicIpFromVirtualMachine) | **POST** /core/virtual-machines/{id}/detach-floatingip | Detach public IP from virtual machine
+*HyperstackApi.GpuApi* | [**listGpus**](docs/GpuApi.md#listGpus) | **GET** /core/gpus | List GPUs
+*HyperstackApi.ImageApi* | [**deleteAnImage**](docs/ImageApi.md#deleteAnImage) | **DELETE** /core/images/{id} | Delete an image
+*HyperstackApi.ImageApi* | [**fetchNameAvailabilityForImages**](docs/ImageApi.md#fetchNameAvailabilityForImages) | **GET** /core/image/name-availability/{name} | Fetch name availability for Images
+*HyperstackApi.ImageApi* | [**getPrivateImageDetails**](docs/ImageApi.md#getPrivateImageDetails) | **GET** /core/images/{id} | Get Private Image Details
+*HyperstackApi.ImageApi* | [**listImages**](docs/ImageApi.md#listImages) | **GET** /core/images | List Images
+*HyperstackApi.InviteApi* | [**deleteInvite**](docs/InviteApi.md#deleteInvite) | **DELETE** /auth/invites/{id} | Delete Invite
+*HyperstackApi.InviteApi* | [**inviteUserToOrganization**](docs/InviteApi.md#inviteUserToOrganization) | **POST** /auth/invites | Invite User to Organization
+*HyperstackApi.InviteApi* | [**listInvites**](docs/InviteApi.md#listInvites) | **GET** /auth/invites | List Invites
+*HyperstackApi.KeypairApi* | [**deleteKeyPair**](docs/KeypairApi.md#deleteKeyPair) | **DELETE** /core/keypair/{id} | Delete key pair
+*HyperstackApi.KeypairApi* | [**importKeyPair**](docs/KeypairApi.md#importKeyPair) | **POST** /core/keypairs | Import key pair
+*HyperstackApi.KeypairApi* | [**listKeyPairs**](docs/KeypairApi.md#listKeyPairs) | **GET** /core/keypairs | List key pairs
+*HyperstackApi.KeypairApi* | [**updateKeyPairName**](docs/KeypairApi.md#updateKeyPairName) | **PUT** /core/keypair/{id} | Update key pair name
+*HyperstackApi.OrganizationApi* | [**removeOrganizationMember**](docs/OrganizationApi.md#removeOrganizationMember) | **POST** /auth/organizations/remove-member | Remove Organization Member
+*HyperstackApi.OrganizationApi* | [**retrieveOrganizationInformation**](docs/OrganizationApi.md#retrieveOrganizationInformation) | **GET** /auth/organizations | Retrieve Organization Information
+*HyperstackApi.OrganizationApi* | [**updateOrganizationInformation**](docs/OrganizationApi.md#updateOrganizationInformation) | **PUT** /auth/organizations/update | Update Organization Information
+*HyperstackApi.PaymentApi* | [**getViewPaymentDetails**](docs/PaymentApi.md#getViewPaymentDetails) | **GET** /billing/payment/payment-details | GET: View payment details
+*HyperstackApi.PaymentApi* | [**postInitiatePayment**](docs/PaymentApi.md#postInitiatePayment) | **POST** /billing/payment/payment-initiate | POST: Initiate payment
+*HyperstackApi.PermissionApi* | [**listPermissions**](docs/PermissionApi.md#listPermissions) | **GET** /auth/permissions | List Permissions
+*HyperstackApi.PolicyApi* | [**listPolicies**](docs/PolicyApi.md#listPolicies) | **GET** /auth/policies | List Policies
+*HyperstackApi.PricebookApi* | [**retrivePricebook**](docs/PricebookApi.md#retrivePricebook) | **GET** /pricebook | 
+*HyperstackApi.ProfileApi* | [**createProfile**](docs/ProfileApi.md#createProfile) | **POST** /core/profiles | Create profile
+*HyperstackApi.ProfileApi* | [**deleteProfile**](docs/ProfileApi.md#deleteProfile) | **DELETE** /core/profiles/{id} | Delete profile
+*HyperstackApi.ProfileApi* | [**listProfiles**](docs/ProfileApi.md#listProfiles) | **GET** /core/profiles | List profiles
+*HyperstackApi.ProfileApi* | [**retrieveProfileDetails**](docs/ProfileApi.md#retrieveProfileDetails) | **GET** /core/profiles/{id} | Retrieve profile details
+*HyperstackApi.RbacRoleApi* | [**createRbacRole**](docs/RbacRoleApi.md#createRbacRole) | **POST** /auth/roles | Create RBAC Role
+*HyperstackApi.RbacRoleApi* | [**deleteRbacRole**](docs/RbacRoleApi.md#deleteRbacRole) | **DELETE** /auth/roles/{id} | Delete RBAC Role
+*HyperstackApi.RbacRoleApi* | [**listRbacRoles**](docs/RbacRoleApi.md#listRbacRoles) | **GET** /auth/roles | List RBAC Roles
+*HyperstackApi.RbacRoleApi* | [**retrieveRbacRoleDetails**](docs/RbacRoleApi.md#retrieveRbacRoleDetails) | **GET** /auth/roles/{id} | Retrieve RBAC Role Details
+*HyperstackApi.RbacRoleApi* | [**updateRbacRole**](docs/RbacRoleApi.md#updateRbacRole) | **PUT** /auth/roles/{id} | Update RBAC Role
+*HyperstackApi.RegionApi* | [**listRegions**](docs/RegionApi.md#listRegions) | **GET** /core/regions | List regions
+*HyperstackApi.SecurityRulesApi* | [**listFirewallRuleProtocols**](docs/SecurityRulesApi.md#listFirewallRuleProtocols) | **GET** /core/sg-rules-protocols | List firewall rule protocols
+*HyperstackApi.SnapshotEventsApi* | [**fetchAllEventsForASnapshot**](docs/SnapshotEventsApi.md#fetchAllEventsForASnapshot) | **GET** /core/snapshots/{snapshot_id}/events | Fetch all events for a snapshot
+*HyperstackApi.SnapshotsApi* | [**createAnImageFromASnapshot**](docs/SnapshotsApi.md#createAnImageFromASnapshot) | **POST** /core/snapshots/{snapshot_id}/image | Create an image from a snapshot
+*HyperstackApi.SnapshotsApi* | [**deleteSnapshot**](docs/SnapshotsApi.md#deleteSnapshot) | **DELETE** /core/snapshots/{id} | Delete snapshot
+*HyperstackApi.SnapshotsApi* | [**fetchSnapshotNameAvailability**](docs/SnapshotsApi.md#fetchSnapshotNameAvailability) | **GET** /core/snapshots/name-availability/{name} | Fetch snapshot name availability
+*HyperstackApi.SnapshotsApi* | [**restoreASnapshot**](docs/SnapshotsApi.md#restoreASnapshot) | **POST** /core/snapshots/{id}/restore | Restore a snapshot
+*HyperstackApi.SnapshotsApi* | [**retrieveASnapshot**](docs/SnapshotsApi.md#retrieveASnapshot) | **GET** /core/snapshots/{id} | Retrieve a snapshot
+*HyperstackApi.SnapshotsApi* | [**retrieveListOfSnapshotsWithPagination**](docs/SnapshotsApi.md#retrieveListOfSnapshotsWithPagination) | **GET** /core/snapshots | Retrieve list of snapshots with pagination
+*HyperstackApi.StockApi* | [**retrieveGpuStocks**](docs/StockApi.md#retrieveGpuStocks) | **GET** /core/stocks | Retrieve GPU stocks
+*HyperstackApi.TemplateApi* | [**createTemplate**](docs/TemplateApi.md#createTemplate) | **POST** /core/marketplace/templates | Create template
+*HyperstackApi.TemplateApi* | [**deleteTemplate**](docs/TemplateApi.md#deleteTemplate) | **DELETE** /core/marketplace/templates/{id} | Delete template
+*HyperstackApi.TemplateApi* | [**listTemplates**](docs/TemplateApi.md#listTemplates) | **GET** /core/marketplace/templates | List templates
+*HyperstackApi.TemplateApi* | [**retrieveTemplateDetails**](docs/TemplateApi.md#retrieveTemplateDetails) | **GET** /core/marketplace/templates/{id} | Retrieve template details
+*HyperstackApi.TemplateApi* | [**updateTemplate**](docs/TemplateApi.md#updateTemplate) | **PUT** /core/marketplace/templates/{id} | Update template
+*HyperstackApi.UserApi* | [**getFetchUserInfo**](docs/UserApi.md#getFetchUserInfo) | **GET** /billing/user/info | GET: Fetch User Info
+*HyperstackApi.UserApi* | [**postInsertUserInfo**](docs/UserApi.md#postInsertUserInfo) | **POST** /billing/user/info | POST: Insert user info
+*HyperstackApi.UserApi* | [**putUpdateUserInfo**](docs/UserApi.md#putUpdateUserInfo) | **PUT** /billing/user/info | PUT: Update user info
+*HyperstackApi.UserDetailChoiceApi* | [**retrieveDefaultFlavorsAndImages**](docs/UserDetailChoiceApi.md#retrieveDefaultFlavorsAndImages) | **GET** /core/user/resources/defaults | Retrieve Default Flavors and Images
+*HyperstackApi.UserPermissionApi* | [**listMyUserPermissions**](docs/UserPermissionApi.md#listMyUserPermissions) | **GET** /auth/users/me/permissions | List My User Permissions
+*HyperstackApi.UserPermissionApi* | [**listUserPermissions**](docs/UserPermissionApi.md#listUserPermissions) | **GET** /auth/users/{id}/permissions | List User Permissions
+*HyperstackApi.VirtualMachineApi* | [**addFirewallRuleToVirtualMachine**](docs/VirtualMachineApi.md#addFirewallRuleToVirtualMachine) | **POST** /core/virtual-machines/{id}/sg-rules | Add firewall rule to virtual machine
+*HyperstackApi.VirtualMachineApi* | [**attachFirewallsToAVirtualMachine**](docs/VirtualMachineApi.md#attachFirewallsToAVirtualMachine) | **POST** /core/virtual-machines/{vm_id}/attach-firewalls | Attach firewalls to a virtual machine
+*HyperstackApi.VirtualMachineApi* | [**createSnapshotFromAVirtualMachine**](docs/VirtualMachineApi.md#createSnapshotFromAVirtualMachine) | **POST** /core/virtual-machines/{vm_id}/snapshots | Create snapshot from a virtual machine
+*HyperstackApi.VirtualMachineApi* | [**createVirtualMachines**](docs/VirtualMachineApi.md#createVirtualMachines) | **POST** /core/virtual-machines | Create virtual machines
+*HyperstackApi.VirtualMachineApi* | [**deleteFirewallRuleFromVirtualMachine**](docs/VirtualMachineApi.md#deleteFirewallRuleFromVirtualMachine) | **DELETE** /core/virtual-machines/{virtual_machine_id}/sg-rules/{sg_rule_id} | Delete firewall rule from virtual machine
+*HyperstackApi.VirtualMachineApi* | [**deleteVirtualMachine**](docs/VirtualMachineApi.md#deleteVirtualMachine) | **DELETE** /core/virtual-machines/{id} | Delete virtual machine
+*HyperstackApi.VirtualMachineApi* | [**editVirtualMachineLabels**](docs/VirtualMachineApi.md#editVirtualMachineLabels) | **PUT** /core/virtual-machines/{virtual_machine_id}/label | Edit virtual machine labels
+*HyperstackApi.VirtualMachineApi* | [**fetchVirtualMachineNameAvailability**](docs/VirtualMachineApi.md#fetchVirtualMachineNameAvailability) | **GET** /core/virtual-machines/name-availability/{name} | Fetch virtual machine name availability
+*HyperstackApi.VirtualMachineApi* | [**hardRebootVirtualMachine**](docs/VirtualMachineApi.md#hardRebootVirtualMachine) | **GET** /core/virtual-machines/{id}/hard-reboot | Hard reboot virtual machine
+*HyperstackApi.VirtualMachineApi* | [**hibernateVirtualMachine**](docs/VirtualMachineApi.md#hibernateVirtualMachine) | **GET** /core/virtual-machines/{virtual_machine_id}/hibernate | Hibernate virtual machine
+*HyperstackApi.VirtualMachineApi* | [**listVirtualMachines**](docs/VirtualMachineApi.md#listVirtualMachines) | **GET** /core/virtual-machines | List virtual machines
+*HyperstackApi.VirtualMachineApi* | [**resizeVirtualMachine**](docs/VirtualMachineApi.md#resizeVirtualMachine) | **POST** /core/virtual-machines/{virtual_machine_id}/resize | Resize virtual machine
+*HyperstackApi.VirtualMachineApi* | [**restoreVirtualMachineFromHibernation**](docs/VirtualMachineApi.md#restoreVirtualMachineFromHibernation) | **GET** /core/virtual-machines/{virtual_machine_id}/hibernate-restore | Restore virtual machine from hibernation
+*HyperstackApi.VirtualMachineApi* | [**retrieveVirtualMachineDetails**](docs/VirtualMachineApi.md#retrieveVirtualMachineDetails) | **GET** /core/virtual-machines/{id} | Retrieve virtual machine details
+*HyperstackApi.VirtualMachineApi* | [**retrieveVirtualMachinePerformanceMetrics**](docs/VirtualMachineApi.md#retrieveVirtualMachinePerformanceMetrics) | **GET** /core/virtual-machines/{virtual_machine_id}/metrics | Retrieve virtual machine performance metrics
+*HyperstackApi.VirtualMachineApi* | [**retrieveVirtualMachinesAssociatedWithAContract**](docs/VirtualMachineApi.md#retrieveVirtualMachinesAssociatedWithAContract) | **GET** /core/virtual-machines/contract/{contract_id}/virtual-machines | Retrieve virtual machines associated with a contract
+*HyperstackApi.VirtualMachineApi* | [**startVirtualMachine**](docs/VirtualMachineApi.md#startVirtualMachine) | **GET** /core/virtual-machines/{id}/start | Start virtual machine
+*HyperstackApi.VirtualMachineApi* | [**stopVirtualMachine**](docs/VirtualMachineApi.md#stopVirtualMachine) | **GET** /core/virtual-machines/{id}/stop | Stop virtual machine
+*HyperstackApi.VirtualMachineEventsApi* | [**listVirtualMachineEvents**](docs/VirtualMachineEventsApi.md#listVirtualMachineEvents) | **GET** /core/virtual-machines/{virtual_machine_id}/events | List virtual machine events
+*HyperstackApi.VncUrlApi* | [**getVncConsoleLink**](docs/VncUrlApi.md#getVncConsoleLink) | **GET** /core/virtual-machines/{virtual_machine_id}/console/{job_id} | Get VNC Console Link
+*HyperstackApi.VncUrlApi* | [**requestInstanceConsole**](docs/VncUrlApi.md#requestInstanceConsole) | **GET** /core/virtual-machines/{id}/request-console | Request Instance Console
+*HyperstackApi.VolumeApi* | [**createVolume**](docs/VolumeApi.md#createVolume) | **POST** /core/volumes | Create volume
+*HyperstackApi.VolumeApi* | [**deleteVolume**](docs/VolumeApi.md#deleteVolume) | **DELETE** /core/volumes/{id} | Delete volume
+*HyperstackApi.VolumeApi* | [**fetchVolumeDetails**](docs/VolumeApi.md#fetchVolumeDetails) | **GET** /core/volume/{volume_id} | Fetch Volume Details
+*HyperstackApi.VolumeApi* | [**fetchVolumeNameAvailability**](docs/VolumeApi.md#fetchVolumeNameAvailability) | **GET** /core/volume/name-availability/{name} | Fetch volume name availability
+*HyperstackApi.VolumeApi* | [**listVolumeTypes**](docs/VolumeApi.md#listVolumeTypes) | **GET** /core/volume-types | List volume types
+*HyperstackApi.VolumeApi* | [**listVolumes**](docs/VolumeApi.md#listVolumes) | **GET** /core/volumes | List volumes
+*HyperstackApi.VolumeAttachmentApi* | [**attachVolumesToVirtualMachine**](docs/VolumeAttachmentApi.md#attachVolumesToVirtualMachine) | **POST** /core/virtual-machines/{virtual_machine_id}/attach-volumes | Attach volumes to virtual machine
+*HyperstackApi.VolumeAttachmentApi* | [**detachVolumesFromVirtualMachine**](docs/VolumeAttachmentApi.md#detachVolumesFromVirtualMachine) | **POST** /core/virtual-machines/{virtual_machine_id}/detach-volumes | Detach volumes from virtual machine
+
+
+## Documentation for Models
+
+ - [HyperstackApi.AddUpdateFlavorOrganizationPayload](docs/AddUpdateFlavorOrganizationPayload.md)
+ - [HyperstackApi.AddUserInfoSuccessResponseModel](docs/AddUserInfoSuccessResponseModel.md)
+ - [HyperstackApi.AllocatedGPUCountGraph](docs/AllocatedGPUCountGraph.md)
+ - [HyperstackApi.ApiKeyFields](docs/ApiKeyFields.md)
+ - [HyperstackApi.ApiKeyVerifyFields](docs/ApiKeyVerifyFields.md)
+ - [HyperstackApi.AssignRbacRolePayload](docs/AssignRbacRolePayload.md)
+ - [HyperstackApi.AttachCallbackPayload](docs/AttachCallbackPayload.md)
+ - [HyperstackApi.AttachCallbackResponse](docs/AttachCallbackResponse.md)
+ - [HyperstackApi.AttachFirewallWithVM](docs/AttachFirewallWithVM.md)
+ - [HyperstackApi.AttachFirewallsToVMPayload](docs/AttachFirewallsToVMPayload.md)
+ - [HyperstackApi.AttachVolumeFields](docs/AttachVolumeFields.md)
+ - [HyperstackApi.AttachVolumes](docs/AttachVolumes.md)
+ - [HyperstackApi.AttachVolumesPayload](docs/AttachVolumesPayload.md)
+ - [HyperstackApi.AuthGetTokenResponseModel](docs/AuthGetTokenResponseModel.md)
+ - [HyperstackApi.AuthRequestLoginFields](docs/AuthRequestLoginFields.md)
+ - [HyperstackApi.AuthRequestLoginResponseModel](docs/AuthRequestLoginResponseModel.md)
+ - [HyperstackApi.AuthUserFields](docs/AuthUserFields.md)
+ - [HyperstackApi.AuthUserInfoResponseModel](docs/AuthUserInfoResponseModel.md)
+ - [HyperstackApi.BillingImmuneResourcesResponse](docs/BillingImmuneResourcesResponse.md)
+ - [HyperstackApi.BillingResponse](docs/BillingResponse.md)
+ - [HyperstackApi.Billingmetricesfields](docs/Billingmetricesfields.md)
+ - [HyperstackApi.Billingmetricesresponse](docs/Billingmetricesresponse.md)
+ - [HyperstackApi.ClusterEvents](docs/ClusterEvents.md)
+ - [HyperstackApi.ClusterEventsFields](docs/ClusterEventsFields.md)
+ - [HyperstackApi.ClusterFields](docs/ClusterFields.md)
+ - [HyperstackApi.ClusterListResponse](docs/ClusterListResponse.md)
+ - [HyperstackApi.ClusterResponse](docs/ClusterResponse.md)
+ - [HyperstackApi.ClusterVersions](docs/ClusterVersions.md)
+ - [HyperstackApi.CommonResponseModel](docs/CommonResponseModel.md)
+ - [HyperstackApi.ComplianceFields](docs/ComplianceFields.md)
+ - [HyperstackApi.ComplianceModelFields](docs/ComplianceModelFields.md)
+ - [HyperstackApi.CompliancePayload](docs/CompliancePayload.md)
+ - [HyperstackApi.ComplianceResponse](docs/ComplianceResponse.md)
+ - [HyperstackApi.ContainerOverviewFields](docs/ContainerOverviewFields.md)
+ - [HyperstackApi.Contract](docs/Contract.md)
+ - [HyperstackApi.ContractBillingHistory](docs/ContractBillingHistory.md)
+ - [HyperstackApi.ContractBillingHistoryResponseAttributes](docs/ContractBillingHistoryResponseAttributes.md)
+ - [HyperstackApi.ContractBillingHistoryResponseModel](docs/ContractBillingHistoryResponseModel.md)
+ - [HyperstackApi.ContractChangePayload](docs/ContractChangePayload.md)
+ - [HyperstackApi.ContractDiscountPlanFields](docs/ContractDiscountPlanFields.md)
+ - [HyperstackApi.ContractEligibleInstanceFields](docs/ContractEligibleInstanceFields.md)
+ - [HyperstackApi.ContractEligibleInstancesResponse](docs/ContractEligibleInstancesResponse.md)
+ - [HyperstackApi.ContractEventCreateModel](docs/ContractEventCreateModel.md)
+ - [HyperstackApi.ContractGPUAllocationGraphResponse](docs/ContractGPUAllocationGraphResponse.md)
+ - [HyperstackApi.ContractInstanceFields](docs/ContractInstanceFields.md)
+ - [HyperstackApi.ContractInstancesResponse](docs/ContractInstancesResponse.md)
+ - [HyperstackApi.ContractResourcePayload](docs/ContractResourcePayload.md)
+ - [HyperstackApi.ContractlBillingHistoryResponseMetrics](docs/ContractlBillingHistoryResponseMetrics.md)
+ - [HyperstackApi.CreateClusterPayload](docs/CreateClusterPayload.md)
+ - [HyperstackApi.CreateContractFields](docs/CreateContractFields.md)
+ - [HyperstackApi.CreateContractPayload](docs/CreateContractPayload.md)
+ - [HyperstackApi.CreateDiscountResponse](docs/CreateDiscountResponse.md)
+ - [HyperstackApi.CreateDiscountsPayload](docs/CreateDiscountsPayload.md)
+ - [HyperstackApi.CreateEnvironment](docs/CreateEnvironment.md)
+ - [HyperstackApi.CreateFirewallPayload](docs/CreateFirewallPayload.md)
+ - [HyperstackApi.CreateFirewallRulePayload](docs/CreateFirewallRulePayload.md)
+ - [HyperstackApi.CreateGPU](docs/CreateGPU.md)
+ - [HyperstackApi.CreateImage](docs/CreateImage.md)
+ - [HyperstackApi.CreateImagePayload](docs/CreateImagePayload.md)
+ - [HyperstackApi.CreateInstancesPayload](docs/CreateInstancesPayload.md)
+ - [HyperstackApi.CreateInstancesResponse](docs/CreateInstancesResponse.md)
+ - [HyperstackApi.CreateProfilePayload](docs/CreateProfilePayload.md)
+ - [HyperstackApi.CreateProfileResponse](docs/CreateProfileResponse.md)
+ - [HyperstackApi.CreateSecurityRulePayload](docs/CreateSecurityRulePayload.md)
+ - [HyperstackApi.CreateSnapshotPayload](docs/CreateSnapshotPayload.md)
+ - [HyperstackApi.CreateSnapshotResponse](docs/CreateSnapshotResponse.md)
+ - [HyperstackApi.CreateUpdateComplianceResponse](docs/CreateUpdateComplianceResponse.md)
+ - [HyperstackApi.CreateUpdatePermissionPayload](docs/CreateUpdatePermissionPayload.md)
+ - [HyperstackApi.CreateUpdatePermissionResponseModel](docs/CreateUpdatePermissionResponseModel.md)
+ - [HyperstackApi.CreateUpdatePolicyPayload](docs/CreateUpdatePolicyPayload.md)
+ - [HyperstackApi.CreateUpdatePolicyResponseModel](docs/CreateUpdatePolicyResponseModel.md)
+ - [HyperstackApi.CreateUpdateRbacRolePayload](docs/CreateUpdateRbacRolePayload.md)
+ - [HyperstackApi.CreateVolumePayload](docs/CreateVolumePayload.md)
+ - [HyperstackApi.Creditrechargelimitfield](docs/Creditrechargelimitfield.md)
+ - [HyperstackApi.Creditrechargelimitresponse](docs/Creditrechargelimitresponse.md)
+ - [HyperstackApi.Creditrequestresponse](docs/Creditrequestresponse.md)
+ - [HyperstackApi.Creditrequests](docs/Creditrequests.md)
+ - [HyperstackApi.CustomerContractDetailResponseModel](docs/CustomerContractDetailResponseModel.md)
+ - [HyperstackApi.CustomerContractFields](docs/CustomerContractFields.md)
+ - [HyperstackApi.CustomerFields](docs/CustomerFields.md)
+ - [HyperstackApi.CustomerPayload](docs/CustomerPayload.md)
+ - [HyperstackApi.DashboardInfoResponse](docs/DashboardInfoResponse.md)
+ - [HyperstackApi.Data](docs/Data.md)
+ - [HyperstackApi.DeploymentFields](docs/DeploymentFields.md)
+ - [HyperstackApi.DeploymentFieldsforstartdeployments](docs/DeploymentFieldsforstartdeployments.md)
+ - [HyperstackApi.Deployments](docs/Deployments.md)
+ - [HyperstackApi.DetachVolumes](docs/DetachVolumes.md)
+ - [HyperstackApi.DetachVolumesPayload](docs/DetachVolumesPayload.md)
+ - [HyperstackApi.DiscountEntityModel](docs/DiscountEntityModel.md)
+ - [HyperstackApi.DiscountFields](docs/DiscountFields.md)
+ - [HyperstackApi.DiscountPlanFields](docs/DiscountPlanFields.md)
+ - [HyperstackApi.DiscountResourceFields](docs/DiscountResourceFields.md)
+ - [HyperstackApi.DiscountResourcePayload](docs/DiscountResourcePayload.md)
+ - [HyperstackApi.EditlabelofanexistingVMPayload](docs/EditlabelofanexistingVMPayload.md)
+ - [HyperstackApi.Environment](docs/Environment.md)
+ - [HyperstackApi.EnvironmentFeatures](docs/EnvironmentFeatures.md)
+ - [HyperstackApi.EnvironmentFields](docs/EnvironmentFields.md)
+ - [HyperstackApi.EnvironmentFieldsforVolume](docs/EnvironmentFieldsforVolume.md)
+ - [HyperstackApi.Environments](docs/Environments.md)
+ - [HyperstackApi.ErrorResponseModel](docs/ErrorResponseModel.md)
+ - [HyperstackApi.ExcludeBillingPostPayload](docs/ExcludeBillingPostPayload.md)
+ - [HyperstackApi.ExcludeBillingPostResponse](docs/ExcludeBillingPostResponse.md)
+ - [HyperstackApi.ExportBillingDataRequest](docs/ExportBillingDataRequest.md)
+ - [HyperstackApi.ExportBillingDataResponse](docs/ExportBillingDataResponse.md)
+ - [HyperstackApi.FieldChange](docs/FieldChange.md)
+ - [HyperstackApi.FirewallAttachmentModel](docs/FirewallAttachmentModel.md)
+ - [HyperstackApi.FirewallAttachmentVMModel](docs/FirewallAttachmentVMModel.md)
+ - [HyperstackApi.FirewallDetailFields](docs/FirewallDetailFields.md)
+ - [HyperstackApi.FirewallDetailResponse](docs/FirewallDetailResponse.md)
+ - [HyperstackApi.FirewallEnvironmentFields](docs/FirewallEnvironmentFields.md)
+ - [HyperstackApi.FirewallFields](docs/FirewallFields.md)
+ - [HyperstackApi.FirewallResponse](docs/FirewallResponse.md)
+ - [HyperstackApi.FirewallRule](docs/FirewallRule.md)
+ - [HyperstackApi.FirewallsListResponse](docs/FirewallsListResponse.md)
+ - [HyperstackApi.FlavorFields](docs/FlavorFields.md)
+ - [HyperstackApi.FlavorItemGetResponse](docs/FlavorItemGetResponse.md)
+ - [HyperstackApi.FlavorListResponse](docs/FlavorListResponse.md)
+ - [HyperstackApi.FlavorObjectFields](docs/FlavorObjectFields.md)
+ - [HyperstackApi.FlavorPayload](docs/FlavorPayload.md)
+ - [HyperstackApi.FlavorResponse](docs/FlavorResponse.md)
+ - [HyperstackApi.FlavorVMFields](docs/FlavorVMFields.md)
+ - [HyperstackApi.FlavorVMsResponse](docs/FlavorVMsResponse.md)
+ - [HyperstackApi.FutureNodeModel](docs/FutureNodeModel.md)
+ - [HyperstackApi.FutureNodeResponseModel](docs/FutureNodeResponseModel.md)
+ - [HyperstackApi.FutureNodeStockModel](docs/FutureNodeStockModel.md)
+ - [HyperstackApi.FutureNodeUpdateModel](docs/FutureNodeUpdateModel.md)
+ - [HyperstackApi.FutureNodesStockModel](docs/FutureNodesStockModel.md)
+ - [HyperstackApi.GPU](docs/GPU.md)
+ - [HyperstackApi.GPUFields](docs/GPUFields.md)
+ - [HyperstackApi.GPUList](docs/GPUList.md)
+ - [HyperstackApi.GPURegionFields](docs/GPURegionFields.md)
+ - [HyperstackApi.GenerateUpdateApiKeyPayload](docs/GenerateUpdateApiKeyPayload.md)
+ - [HyperstackApi.GenerateUpdateApiKeyResponseModel](docs/GenerateUpdateApiKeyResponseModel.md)
+ - [HyperstackApi.GetAllContractFields](docs/GetAllContractFields.md)
+ - [HyperstackApi.GetAllContractsResponseModel](docs/GetAllContractsResponseModel.md)
+ - [HyperstackApi.GetAllDiscountForAllOrganizationResponse](docs/GetAllDiscountForAllOrganizationResponse.md)
+ - [HyperstackApi.GetAllDiscountsFields](docs/GetAllDiscountsFields.md)
+ - [HyperstackApi.GetApiKeysResponseModel](docs/GetApiKeysResponseModel.md)
+ - [HyperstackApi.GetCustomerContractsListResponseModel](docs/GetCustomerContractsListResponseModel.md)
+ - [HyperstackApi.GetDiscountDetailResponse](docs/GetDiscountDetailResponse.md)
+ - [HyperstackApi.GetDiscountResponse](docs/GetDiscountResponse.md)
+ - [HyperstackApi.GetEntityDiscountDetailResponse](docs/GetEntityDiscountDetailResponse.md)
+ - [HyperstackApi.GetInvitesResponseModel](docs/GetInvitesResponseModel.md)
+ - [HyperstackApi.GetOrganizationResponseModel](docs/GetOrganizationResponseModel.md)
+ - [HyperstackApi.GetPermissionsResponseModel](docs/GetPermissionsResponseModel.md)
+ - [HyperstackApi.GetPoliciesResponseModel](docs/GetPoliciesResponseModel.md)
+ - [HyperstackApi.GetRbacRolesResponseModel](docs/GetRbacRolesResponseModel.md)
+ - [HyperstackApi.GetTokenPayload](docs/GetTokenPayload.md)
+ - [HyperstackApi.GetUserPermissionsResponseModel](docs/GetUserPermissionsResponseModel.md)
+ - [HyperstackApi.GetVersionResponse](docs/GetVersionResponse.md)
+ - [HyperstackApi.Getcreditandthresholdinfo](docs/Getcreditandthresholdinfo.md)
+ - [HyperstackApi.Getcreditandthresholdinfoinresponse](docs/Getcreditandthresholdinfoinresponse.md)
+ - [HyperstackApi.GraphDatetimeValueModel](docs/GraphDatetimeValueModel.md)
+ - [HyperstackApi.HistoricalInstance](docs/HistoricalInstance.md)
+ - [HyperstackApi.HistoricalInstancesFields](docs/HistoricalInstancesFields.md)
+ - [HyperstackApi.Image](docs/Image.md)
+ - [HyperstackApi.ImageFields](docs/ImageFields.md)
+ - [HyperstackApi.ImageGetResponse](docs/ImageGetResponse.md)
+ - [HyperstackApi.ImageLogos](docs/ImageLogos.md)
+ - [HyperstackApi.Images](docs/Images.md)
+ - [HyperstackApi.ImportKeypairPayload](docs/ImportKeypairPayload.md)
+ - [HyperstackApi.ImportKeypairResponse](docs/ImportKeypairResponse.md)
+ - [HyperstackApi.InfrahubResourceObjectResponse](docs/InfrahubResourceObjectResponse.md)
+ - [HyperstackApi.InfrahubResourceObjectResponseForCustomer](docs/InfrahubResourceObjectResponseForCustomer.md)
+ - [HyperstackApi.InsertDiscountPlanFields](docs/InsertDiscountPlanFields.md)
+ - [HyperstackApi.Instance](docs/Instance.md)
+ - [HyperstackApi.InstanceEnvironmentFields](docs/InstanceEnvironmentFields.md)
+ - [HyperstackApi.InstanceEvents](docs/InstanceEvents.md)
+ - [HyperstackApi.InstanceEventsFields](docs/InstanceEventsFields.md)
+ - [HyperstackApi.InstanceFields](docs/InstanceFields.md)
+ - [HyperstackApi.InstanceFlavorFields](docs/InstanceFlavorFields.md)
+ - [HyperstackApi.InstanceImageFields](docs/InstanceImageFields.md)
+ - [HyperstackApi.InstanceKeypairFields](docs/InstanceKeypairFields.md)
+ - [HyperstackApi.InstanceOverviewFields](docs/InstanceOverviewFields.md)
+ - [HyperstackApi.InstanceResizePayload](docs/InstanceResizePayload.md)
+ - [HyperstackApi.Instances](docs/Instances.md)
+ - [HyperstackApi.InstancesSummaryFields](docs/InstancesSummaryFields.md)
+ - [HyperstackApi.InternalEnvironmentFields](docs/InternalEnvironmentFields.md)
+ - [HyperstackApi.InternalInstanceFields](docs/InternalInstanceFields.md)
+ - [HyperstackApi.InternalInstanceFlavorFields](docs/InternalInstanceFlavorFields.md)
+ - [HyperstackApi.InternalInstanceImageFields](docs/InternalInstanceImageFields.md)
+ - [HyperstackApi.InternalInstanceKeypairFields](docs/InternalInstanceKeypairFields.md)
+ - [HyperstackApi.InternalInstancesResponse](docs/InternalInstancesResponse.md)
+ - [HyperstackApi.InternalSecurityRulesFieldsForInstance](docs/InternalSecurityRulesFieldsForInstance.md)
+ - [HyperstackApi.InternalVolumeAttachmentFields](docs/InternalVolumeAttachmentFields.md)
+ - [HyperstackApi.InternalVolumeFields](docs/InternalVolumeFields.md)
+ - [HyperstackApi.InternalVolumesResponse](docs/InternalVolumesResponse.md)
+ - [HyperstackApi.InviteFields](docs/InviteFields.md)
+ - [HyperstackApi.InviteUserPayload](docs/InviteUserPayload.md)
+ - [HyperstackApi.InviteUserResponseModel](docs/InviteUserResponseModel.md)
+ - [HyperstackApi.KeypairFields](docs/KeypairFields.md)
+ - [HyperstackApi.Keypairs](docs/Keypairs.md)
+ - [HyperstackApi.LableResonse](docs/LableResonse.md)
+ - [HyperstackApi.Lastdaycostfields](docs/Lastdaycostfields.md)
+ - [HyperstackApi.Lastdaycostresponse](docs/Lastdaycostresponse.md)
+ - [HyperstackApi.LogoGetResponse](docs/LogoGetResponse.md)
+ - [HyperstackApi.LogoutPayload](docs/LogoutPayload.md)
+ - [HyperstackApi.MetricItemFields](docs/MetricItemFields.md)
+ - [HyperstackApi.MetricsFields](docs/MetricsFields.md)
+ - [HyperstackApi.NameAvailableModel](docs/NameAvailableModel.md)
+ - [HyperstackApi.NewConfigurationsResponse](docs/NewConfigurationsResponse.md)
+ - [HyperstackApi.NewModelResponse](docs/NewModelResponse.md)
+ - [HyperstackApi.NewStockResponse](docs/NewStockResponse.md)
+ - [HyperstackApi.NewStockRetriveResponse](docs/NewStockRetriveResponse.md)
+ - [HyperstackApi.NewStockUpdateResponseModel](docs/NewStockUpdateResponseModel.md)
+ - [HyperstackApi.NodeModel](docs/NodeModel.md)
+ - [HyperstackApi.NodePayloadModel](docs/NodePayloadModel.md)
+ - [HyperstackApi.NodePowerUsageModel](docs/NodePowerUsageModel.md)
+ - [HyperstackApi.NodeResponseModel](docs/NodeResponseModel.md)
+ - [HyperstackApi.NodeStockPayloadModel](docs/NodeStockPayloadModel.md)
+ - [HyperstackApi.NodeStockResponseModel](docs/NodeStockResponseModel.md)
+ - [HyperstackApi.NodeStocksPayload](docs/NodeStocksPayload.md)
+ - [HyperstackApi.OrganizationFields](docs/OrganizationFields.md)
+ - [HyperstackApi.OrganizationLevelBillingHistory](docs/OrganizationLevelBillingHistory.md)
+ - [HyperstackApi.OrganizationLevelBillingHistoryResources](docs/OrganizationLevelBillingHistoryResources.md)
+ - [HyperstackApi.OrganizationLevelBillingHistoryResponseAttributes](docs/OrganizationLevelBillingHistoryResponseAttributes.md)
+ - [HyperstackApi.OrganizationLevelBillingHistoryResponseMetrics](docs/OrganizationLevelBillingHistoryResponseMetrics.md)
+ - [HyperstackApi.OrganizationLevelBillingHistoryResponseModel](docs/OrganizationLevelBillingHistoryResponseModel.md)
+ - [HyperstackApi.OrganizationObjectResponse](docs/OrganizationObjectResponse.md)
+ - [HyperstackApi.OrganizationThresholdfields](docs/OrganizationThresholdfields.md)
+ - [HyperstackApi.OrganizationUserResponseModel](docs/OrganizationUserResponseModel.md)
+ - [HyperstackApi.Organizationcreditrechargelimitresponse](docs/Organizationcreditrechargelimitresponse.md)
+ - [HyperstackApi.Organizationthresholdsresponse](docs/Organizationthresholdsresponse.md)
+ - [HyperstackApi.Organizationthresholdupdateresponse](docs/Organizationthresholdupdateresponse.md)
+ - [HyperstackApi.OverviewInfo](docs/OverviewInfo.md)
+ - [HyperstackApi.PaginationData](docs/PaginationData.md)
+ - [HyperstackApi.PaymentDetailsFields](docs/PaymentDetailsFields.md)
+ - [HyperstackApi.PaymentDetailsResponse](docs/PaymentDetailsResponse.md)
+ - [HyperstackApi.PaymentInitiateFields](docs/PaymentInitiateFields.md)
+ - [HyperstackApi.PaymentInitiatePayload](docs/PaymentInitiatePayload.md)
+ - [HyperstackApi.PaymentInitiateResponse](docs/PaymentInitiateResponse.md)
+ - [HyperstackApi.PermissionFields](docs/PermissionFields.md)
+ - [HyperstackApi.PolicyFields](docs/PolicyFields.md)
+ - [HyperstackApi.PolicyPermissionFields](docs/PolicyPermissionFields.md)
+ - [HyperstackApi.PowerUsageModel](docs/PowerUsageModel.md)
+ - [HyperstackApi.PricebookModel](docs/PricebookModel.md)
+ - [HyperstackApi.PricebookResourceObjectResponse](docs/PricebookResourceObjectResponse.md)
+ - [HyperstackApi.PricebookResourceObjectResponseForCustomer](docs/PricebookResourceObjectResponseForCustomer.md)
+ - [HyperstackApi.ProfileFields](docs/ProfileFields.md)
+ - [HyperstackApi.ProfileListResponse](docs/ProfileListResponse.md)
+ - [HyperstackApi.ProfileObjectFields](docs/ProfileObjectFields.md)
+ - [HyperstackApi.RbacRoleDetailResponseModel](docs/RbacRoleDetailResponseModel.md)
+ - [HyperstackApi.RbacRoleDetailResponseModelFixed](docs/RbacRoleDetailResponseModelFixed.md)
+ - [HyperstackApi.RbacRoleField](docs/RbacRoleField.md)
+ - [HyperstackApi.RbacRoleFields](docs/RbacRoleFields.md)
+ - [HyperstackApi.RefreshTokenPayload](docs/RefreshTokenPayload.md)
+ - [HyperstackApi.RegionFields](docs/RegionFields.md)
+ - [HyperstackApi.RegionPayload](docs/RegionPayload.md)
+ - [HyperstackApi.RegionResponse](docs/RegionResponse.md)
+ - [HyperstackApi.Regions](docs/Regions.md)
+ - [HyperstackApi.RemoveMemberFromOrganizationResponseModel](docs/RemoveMemberFromOrganizationResponseModel.md)
+ - [HyperstackApi.RemoveMemberPayload](docs/RemoveMemberPayload.md)
+ - [HyperstackApi.RequestConsole](docs/RequestConsole.md)
+ - [HyperstackApi.ResourceBillingEventsHistoryMetrics](docs/ResourceBillingEventsHistoryMetrics.md)
+ - [HyperstackApi.ResourceBillingEventsHistoryResponse](docs/ResourceBillingEventsHistoryResponse.md)
+ - [HyperstackApi.ResourceBillingResponseForCustomer](docs/ResourceBillingResponseForCustomer.md)
+ - [HyperstackApi.ResourceLevelBillingDetailsAttributes](docs/ResourceLevelBillingDetailsAttributes.md)
+ - [HyperstackApi.ResourceLevelBillingDetailsMetrics](docs/ResourceLevelBillingDetailsMetrics.md)
+ - [HyperstackApi.ResourceLevelBillingDetailsVM](docs/ResourceLevelBillingDetailsVM.md)
+ - [HyperstackApi.ResourceLevelBillingDetailsVolume](docs/ResourceLevelBillingDetailsVolume.md)
+ - [HyperstackApi.ResourceLevelBillingDetailsVolumeAttributes](docs/ResourceLevelBillingDetailsVolumeAttributes.md)
+ - [HyperstackApi.ResourceLevelBillingDetailsVolumeMetrics](docs/ResourceLevelBillingDetailsVolumeMetrics.md)
+ - [HyperstackApi.ResourceLevelBillingHistory](docs/ResourceLevelBillingHistory.md)
+ - [HyperstackApi.ResourceLevelBillingHistoryResources](docs/ResourceLevelBillingHistoryResources.md)
+ - [HyperstackApi.ResourceLevelBillingHistoryResponseAttributes](docs/ResourceLevelBillingHistoryResponseAttributes.md)
+ - [HyperstackApi.ResourceLevelBillingHistoryResponseMetrics](docs/ResourceLevelBillingHistoryResponseMetrics.md)
+ - [HyperstackApi.ResourceLevelBillingVMDetailsResources](docs/ResourceLevelBillingVMDetailsResources.md)
+ - [HyperstackApi.ResourceLevelBillingVolumeDetailsResources](docs/ResourceLevelBillingVolumeDetailsResources.md)
+ - [HyperstackApi.ResourceLevelGraphBillingDetailVolume](docs/ResourceLevelGraphBillingDetailVolume.md)
+ - [HyperstackApi.ResourceLevelGraphBillingDetailsAttributes](docs/ResourceLevelGraphBillingDetailsAttributes.md)
+ - [HyperstackApi.ResourceLevelGraphBillingDetailsMetrics](docs/ResourceLevelGraphBillingDetailsMetrics.md)
+ - [HyperstackApi.ResourceLevelGraphBillingDetailsVM](docs/ResourceLevelGraphBillingDetailsVM.md)
+ - [HyperstackApi.ResourceLevelGraphBillingVMDetailsResources](docs/ResourceLevelGraphBillingVMDetailsResources.md)
+ - [HyperstackApi.ResourceLevelGraphBillingVolumeDetailsResources](docs/ResourceLevelGraphBillingVolumeDetailsResources.md)
+ - [HyperstackApi.ResourceLevelVMBillingDetailsResponseModel](docs/ResourceLevelVMBillingDetailsResponseModel.md)
+ - [HyperstackApi.ResourceLevelVmBillingHistoryResponseModel](docs/ResourceLevelVmBillingHistoryResponseModel.md)
+ - [HyperstackApi.ResourceLevelVmGraphBillingDetailsResponseModel](docs/ResourceLevelVmGraphBillingDetailsResponseModel.md)
+ - [HyperstackApi.ResourceLevelVolumeBillingDetailsResponseModel](docs/ResourceLevelVolumeBillingDetailsResponseModel.md)
+ - [HyperstackApi.ResourceLevelVolumeBillingHistoryResponseModel](docs/ResourceLevelVolumeBillingHistoryResponseModel.md)
+ - [HyperstackApi.ResourceLevelVolumeGraphBillingDetailsResponseModel](docs/ResourceLevelVolumeGraphBillingDetailsResponseModel.md)
+ - [HyperstackApi.ResourceObjectResponseForCustomer](docs/ResourceObjectResponseForCustomer.md)
+ - [HyperstackApi.ResponseModel](docs/ResponseModel.md)
+ - [HyperstackApi.RolePermissionFields](docs/RolePermissionFields.md)
+ - [HyperstackApi.RolePolicyFields](docs/RolePolicyFields.md)
+ - [HyperstackApi.SecurityGroupRule](docs/SecurityGroupRule.md)
+ - [HyperstackApi.SecurityGroupRuleFields](docs/SecurityGroupRuleFields.md)
+ - [HyperstackApi.SecurityRulesFieldsforInstance](docs/SecurityRulesFieldsforInstance.md)
+ - [HyperstackApi.SecurityRulesProtocolFields](docs/SecurityRulesProtocolFields.md)
+ - [HyperstackApi.SetDefaultsPayload](docs/SetDefaultsPayload.md)
+ - [HyperstackApi.SingleVisibilityUserResponse](docs/SingleVisibilityUserResponse.md)
+ - [HyperstackApi.SnapshotFields](docs/SnapshotFields.md)
+ - [HyperstackApi.SnapshotRestoreRequest](docs/SnapshotRestoreRequest.md)
+ - [HyperstackApi.SnapshotRetrieve](docs/SnapshotRetrieve.md)
+ - [HyperstackApi.SnapshotRetrieveFields](docs/SnapshotRetrieveFields.md)
+ - [HyperstackApi.Snapshots](docs/Snapshots.md)
+ - [HyperstackApi.StartDeployment](docs/StartDeployment.md)
+ - [HyperstackApi.StartDeploymentPayload](docs/StartDeploymentPayload.md)
+ - [HyperstackApi.StockVisibilityUserListResponse](docs/StockVisibilityUserListResponse.md)
+ - [HyperstackApi.StockVisibilityUserPayload](docs/StockVisibilityUserPayload.md)
+ - [HyperstackApi.SubResourceGraphBillingDetailsMetrics](docs/SubResourceGraphBillingDetailsMetrics.md)
+ - [HyperstackApi.SubResourcesCostsResponseModel](docs/SubResourcesCostsResponseModel.md)
+ - [HyperstackApi.SubResourcesGraphBillingHistoryFields](docs/SubResourcesGraphBillingHistoryFields.md)
+ - [HyperstackApi.SubResourcesGraphResponseModel](docs/SubResourcesGraphResponseModel.md)
+ - [HyperstackApi.Subscribeorunsubscribeupdatepayload](docs/Subscribeorunsubscribeupdatepayload.md)
+ - [HyperstackApi.SuccessResponseModel](docs/SuccessResponseModel.md)
+ - [HyperstackApi.Template](docs/Template.md)
+ - [HyperstackApi.TemplateFields](docs/TemplateFields.md)
+ - [HyperstackApi.Templates](docs/Templates.md)
+ - [HyperstackApi.TokenFields](docs/TokenFields.md)
+ - [HyperstackApi.UpdateContractPayload](docs/UpdateContractPayload.md)
+ - [HyperstackApi.UpdateDiscountsPayload](docs/UpdateDiscountsPayload.md)
+ - [HyperstackApi.UpdateDiscountsStatusPayload](docs/UpdateDiscountsStatusPayload.md)
+ - [HyperstackApi.UpdateEnvironment](docs/UpdateEnvironment.md)
+ - [HyperstackApi.UpdateGPU](docs/UpdateGPU.md)
+ - [HyperstackApi.UpdateKeypairName](docs/UpdateKeypairName.md)
+ - [HyperstackApi.UpdateKeypairnameresponse](docs/UpdateKeypairnameresponse.md)
+ - [HyperstackApi.UpdateOrganizationPayload](docs/UpdateOrganizationPayload.md)
+ - [HyperstackApi.UpdateOrganizationResponseModel](docs/UpdateOrganizationResponseModel.md)
+ - [HyperstackApi.UpdateTemplate](docs/UpdateTemplate.md)
+ - [HyperstackApi.UserDefaultChoiceForUserFields](docs/UserDefaultChoiceForUserFields.md)
+ - [HyperstackApi.UserDefaultChoicesForUserResponse](docs/UserDefaultChoicesForUserResponse.md)
+ - [HyperstackApi.UserPermissionFields](docs/UserPermissionFields.md)
+ - [HyperstackApi.UserTransferPayload](docs/UserTransferPayload.md)
+ - [HyperstackApi.Userinfopostpayload](docs/Userinfopostpayload.md)
+ - [HyperstackApi.UsersInfoFields](docs/UsersInfoFields.md)
+ - [HyperstackApi.UsersInfoListResponse](docs/UsersInfoListResponse.md)
+ - [HyperstackApi.VMUsageRequestPayload](docs/VMUsageRequestPayload.md)
+ - [HyperstackApi.VMUsageResponse](docs/VMUsageResponse.md)
+ - [HyperstackApi.VNCURL](docs/VNCURL.md)
+ - [HyperstackApi.VNCURLFields](docs/VNCURLFields.md)
+ - [HyperstackApi.VerifyApiKeyPayload](docs/VerifyApiKeyPayload.md)
+ - [HyperstackApi.VerifyApiKeyResponseModel](docs/VerifyApiKeyResponseModel.md)
+ - [HyperstackApi.VirtualMachineUsage](docs/VirtualMachineUsage.md)
+ - [HyperstackApi.Volume](docs/Volume.md)
+ - [HyperstackApi.VolumeAttachmentFields](docs/VolumeAttachmentFields.md)
+ - [HyperstackApi.VolumeFields](docs/VolumeFields.md)
+ - [HyperstackApi.VolumeFieldsforInstance](docs/VolumeFieldsforInstance.md)
+ - [HyperstackApi.VolumeOverviewFields](docs/VolumeOverviewFields.md)
+ - [HyperstackApi.VolumeStatusChangeFields](docs/VolumeStatusChangeFields.md)
+ - [HyperstackApi.VolumeTypes](docs/VolumeTypes.md)
+ - [HyperstackApi.Volumes](docs/Volumes.md)
+ - [HyperstackApi.VolumesLastStatusChangeResponse](docs/VolumesLastStatusChangeResponse.md)
+ - [HyperstackApi.WarningMailLogFields](docs/WarningMailLogFields.md)
+ - [HyperstackApi.WarningMailLogResponse](docs/WarningMailLogResponse.md)
+
+
+## Documentation for Authorization
+
+
+Authentication schemes defined for the API:
+### accessToken
+
+
+- **Type**: API key
+- **API key parameter name**: Authorization
+- **Location**: HTTP header
+
+### apiKey
+
+
+- **Type**: API key
+- **API key parameter name**: api_key
+- **Location**: HTTP header
+