crimson-falcon 0.4.1 → 1.0.0

data/lib/crimson-falcon/api/host_migration.rb

@@ -0,0 +1,759 @@
+=begin
+Crimson Falcon - Ruby Client SDK
+
+Code auto-generated by OpenAPI Generator; DO NOT EDIT.
+
+MIT License
+
+Copyright (c) 2023 Crowdstrike
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+=end
+
+require 'cgi'
+
+module Falcon
+  class HostMigration
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Create a device migration job.
+    # `device_ids` and `filter` are mutually exclusive. Filter takes precedence.
+    # @param body [ApiCreateMigrationRequestV1]
+    # @param [Hash] opts the optional parameters
+    # @return [ApiCreateMigrationResponseV1]
+    def create_migration_v1(body, opts = {})
+      data, _status_code, _headers = create_migration_v1_with_http_info(body, opts)
+      data
+    end
+
+    # Create a device migration job.
+    # `device_ids` and `filter` are mutually exclusive. Filter takes precedence.
+    # @param body [ApiCreateMigrationRequestV1]
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ApiCreateMigrationResponseV1, Integer, Hash)>] ApiCreateMigrationResponseV1 data, response status code and response headers
+    def create_migration_v1_with_http_info(body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: HostMigration.create_migration_v1 ...'
+      end
+      # verify the required parameter 'body' is set
+      if @api_client.config.client_side_validation && body.nil?
+        fail ArgumentError, "Missing the required parameter 'body' when calling HostMigration.create_migration_v1"
+      end
+      # resource path
+      local_var_path = '/host-migration/entities/migrations/v1'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+        header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(body)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ApiCreateMigrationResponseV1'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['oauth2']
+
+      new_options = opts.merge(
+        :operation => :"HostMigration.create_migration_v1",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: HostMigration#create_migration_v1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Query host migration IDs.
+    # Query host migration IDs.
+    # @param id [String] The migration job to query
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :offset The offset to start retrieving records from
+    # @option opts [Integer] :limit The maximum records to return. [1-10000]
+    # @option opts [String] :sort The property to sort by.
+    # @option opts [String] :filter The filter expression that should be used to limit the results. Valid fields: groups, static_host_groups, status, target_cid, migration_id, created_time, host_migration_id, hostgroups, hostname, source_cid, id
+    # @return [MsaspecQueryResponse]
+    def get_host_migration_ids_v1(id, opts = {})
+      data, _status_code, _headers = get_host_migration_ids_v1_with_http_info(id, opts)
+      data
+    end
+
+    # Query host migration IDs.
+    # Query host migration IDs.
+    # @param id [String] The migration job to query
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :offset The offset to start retrieving records from
+    # @option opts [Integer] :limit The maximum records to return. [1-10000]
+    # @option opts [String] :sort The property to sort by.
+    # @option opts [String] :filter The filter expression that should be used to limit the results. Valid fields: groups, static_host_groups, status, target_cid, migration_id, created_time, host_migration_id, hostgroups, hostname, source_cid, id
+    # @return [Array<(MsaspecQueryResponse, Integer, Hash)>] MsaspecQueryResponse data, response status code and response headers
+    def get_host_migration_ids_v1_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: HostMigration.get_host_migration_ids_v1 ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling HostMigration.get_host_migration_ids_v1"
+      end
+      allowable_values = ["groups|asc", "groups|desc", "groups", "static_host_groups|asc", "static_host_groups|desc", "static_host_groups", "status|asc", "status|desc", "status", "target_cid|asc", "target_cid|desc", "target_cid", "migration_id|asc", "migration_id|desc", "migration_id", "created_time|asc", "created_time|desc", "created_time", "host_migration_id|asc", "host_migration_id|desc", "host_migration_id", "hostgroups|asc", "hostgroups|desc", "hostgroups", "hostname|asc", "hostname|desc", "hostname", "source_cid|asc", "source_cid|desc", "source_cid", "id|asc", "id|desc", "id"]
+      if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
+        fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/host-migration/queries/host-migrations/v1'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'id'] = id
+      query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
+      query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'MsaspecQueryResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['oauth2']
+
+      new_options = opts.merge(
+        :operation => :"HostMigration.get_host_migration_ids_v1",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: HostMigration#get_host_migration_ids_v1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get host migration details.
+    # # Events   The `events` field describes actions that have occurred to the host migration entity. Each object is defined by the `action` field. When `user` is present, it is the user who performed the action. `time` is when the action occurred.  ## Event actions  ### added  This action is emitted when the host migration is created.  ``` { \"action\": \"added\", \"user\": \"example@example.com\", \"time\": \"2024-01-01T00:00:00Z\" } ```  ### assigned_static_host_groups  This action is emitted when a user assigns static host groups to a host migration. `ids` are the ids of the new host groups that have been assigned.  ``` { \"action\": \"assigned_static_host_groups\", \"ids\": [\"foo\", \"bar\"],  \"user\": \"example@example.com\", \"time\": \"2024-01-01T00:00:00Z\" } ```  ### removed_static_host_groups  This action is emitted when a user removes static host groups from a host migration. `ids` are the ids of the host groups that have been removed.  ``` { \"action\": \"removed_static_host_groups\", \"ids\": [\"foo\", \"bar\"],  \"user\": \"example@example.com\", \"time\": \"2024-01-01T00:00:00Z\" } ```  ### queued  This action is emitted when the migration is started.  ``` { \"action\": \"queued\", \"user\": \"example@example.com\", \"time\": \"2024-01-01T00:00:00Z\" } ```  ### failed  This action is emitted when the host migration fails. `reason` is the reason for failure. `reason` can be `unsupported_sensor_version`, `unsupported_sensor_platform`, `host_missing`, `migration_expired`, or `internal_error`.  ``` { \"action\": \"failed\", \"reason\": \"unsupported_sensor_version\", \"time\": \"2024-01-01T00:00:00Z\" } ```  ### cancelled  This action is emitted when the migration has been cancelled.  ``` { \"action\": \"cancelled\", \"user\": \"example@example.com\", \"time\": \"2024-01-01T00:00:00Z\" } ```  ### completed  This action is emitted when the host has successfully migrated.  ``` { \"action\": \"completed\", \"time\": \"2024-01-01T00:00:00Z\" } ```  # Status Details  The `status_details` field is an optional field that provides some more details about the status of a failed host migration. It may be omitted or empty from a response.  ### internal_error  This status detail is provided when an internal occurs during a host migration.  ### canceled_by_user  This status detail is provided when a migration has been canceled by a user.  ### host_missing  This status detail is provided when a host migration is canceled because the source host can no longer be found.  ### migration_expired  This status detail is provided when a host migration is expired because the migration is too old.  ### migration_already_in_progress  This status detail is provided when attempting to start a host migration on a host that is already in progress in another migration.  ### source_host_unsupported_version  This status detail is provided when attempting to create or start a host migration when the sensor is on an unsupported version.  ### source_host_unsupported_platform  This status detail is provided when attempting to create or start a host migration when the sensor is an unsupported platform.
+    # @param body [MsaIdsRequest]
+    # @param [Hash] opts the optional parameters
+    # @return [ApiGetHostMigrationResponseV1]
+    def get_host_migrations_v1(body, opts = {})
+      data, _status_code, _headers = get_host_migrations_v1_with_http_info(body, opts)
+      data
+    end
+
+    # Get host migration details.
+    # # Events   The &#x60;events&#x60; field describes actions that have occurred to the host migration entity. Each object is defined by the &#x60;action&#x60; field. When &#x60;user&#x60; is present, it is the user who performed the action. &#x60;time&#x60; is when the action occurred.  ## Event actions  ### added  This action is emitted when the host migration is created.  &#x60;&#x60;&#x60; { \&quot;action\&quot;: \&quot;added\&quot;, \&quot;user\&quot;: \&quot;example@example.com\&quot;, \&quot;time\&quot;: \&quot;2024-01-01T00:00:00Z\&quot; } &#x60;&#x60;&#x60;  ### assigned_static_host_groups  This action is emitted when a user assigns static host groups to a host migration. &#x60;ids&#x60; are the ids of the new host groups that have been assigned.  &#x60;&#x60;&#x60; { \&quot;action\&quot;: \&quot;assigned_static_host_groups\&quot;, \&quot;ids\&quot;: [\&quot;foo\&quot;, \&quot;bar\&quot;],  \&quot;user\&quot;: \&quot;example@example.com\&quot;, \&quot;time\&quot;: \&quot;2024-01-01T00:00:00Z\&quot; } &#x60;&#x60;&#x60;  ### removed_static_host_groups  This action is emitted when a user removes static host groups from a host migration. &#x60;ids&#x60; are the ids of the host groups that have been removed.  &#x60;&#x60;&#x60; { \&quot;action\&quot;: \&quot;removed_static_host_groups\&quot;, \&quot;ids\&quot;: [\&quot;foo\&quot;, \&quot;bar\&quot;],  \&quot;user\&quot;: \&quot;example@example.com\&quot;, \&quot;time\&quot;: \&quot;2024-01-01T00:00:00Z\&quot; } &#x60;&#x60;&#x60;  ### queued  This action is emitted when the migration is started.  &#x60;&#x60;&#x60; { \&quot;action\&quot;: \&quot;queued\&quot;, \&quot;user\&quot;: \&quot;example@example.com\&quot;, \&quot;time\&quot;: \&quot;2024-01-01T00:00:00Z\&quot; } &#x60;&#x60;&#x60;  ### failed  This action is emitted when the host migration fails. &#x60;reason&#x60; is the reason for failure. &#x60;reason&#x60; can be &#x60;unsupported_sensor_version&#x60;, &#x60;unsupported_sensor_platform&#x60;, &#x60;host_missing&#x60;, &#x60;migration_expired&#x60;, or &#x60;internal_error&#x60;.  &#x60;&#x60;&#x60; { \&quot;action\&quot;: \&quot;failed\&quot;, \&quot;reason\&quot;: \&quot;unsupported_sensor_version\&quot;, \&quot;time\&quot;: \&quot;2024-01-01T00:00:00Z\&quot; } &#x60;&#x60;&#x60;  ### cancelled  This action is emitted when the migration has been cancelled.  &#x60;&#x60;&#x60; { \&quot;action\&quot;: \&quot;cancelled\&quot;, \&quot;user\&quot;: \&quot;example@example.com\&quot;, \&quot;time\&quot;: \&quot;2024-01-01T00:00:00Z\&quot; } &#x60;&#x60;&#x60;  ### completed  This action is emitted when the host has successfully migrated.  &#x60;&#x60;&#x60; { \&quot;action\&quot;: \&quot;completed\&quot;, \&quot;time\&quot;: \&quot;2024-01-01T00:00:00Z\&quot; } &#x60;&#x60;&#x60;  # Status Details  The &#x60;status_details&#x60; field is an optional field that provides some more details about the status of a failed host migration. It may be omitted or empty from a response.  ### internal_error  This status detail is provided when an internal occurs during a host migration.  ### canceled_by_user  This status detail is provided when a migration has been canceled by a user.  ### host_missing  This status detail is provided when a host migration is canceled because the source host can no longer be found.  ### migration_expired  This status detail is provided when a host migration is expired because the migration is too old.  ### migration_already_in_progress  This status detail is provided when attempting to start a host migration on a host that is already in progress in another migration.  ### source_host_unsupported_version  This status detail is provided when attempting to create or start a host migration when the sensor is on an unsupported version.  ### source_host_unsupported_platform  This status detail is provided when attempting to create or start a host migration when the sensor is an unsupported platform.
+    # @param body [MsaIdsRequest]
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ApiGetHostMigrationResponseV1, Integer, Hash)>] ApiGetHostMigrationResponseV1 data, response status code and response headers
+    def get_host_migrations_v1_with_http_info(body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: HostMigration.get_host_migrations_v1 ...'
+      end
+      # verify the required parameter 'body' is set
+      if @api_client.config.client_side_validation && body.nil?
+        fail ArgumentError, "Missing the required parameter 'body' when calling HostMigration.get_host_migrations_v1"
+      end
+      # resource path
+      local_var_path = '/host-migration/entities/host-migrations/GET/v1'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+        header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(body)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ApiGetHostMigrationResponseV1'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['oauth2']
+
+      new_options = opts.merge(
+        :operation => :"HostMigration.get_host_migrations_v1",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: HostMigration#get_host_migrations_v1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get destinations for a migration.
+    # `device_ids` and `filter` are mutually exclusive.
+    # @param body [ApiGetMigrationDestinationsRequestBodyV1]
+    # @param [Hash] opts the optional parameters
+    # @return [ApiGetMigrationDestinationsResponseV1]
+    def get_migration_destinations_v1(body, opts = {})
+      data, _status_code, _headers = get_migration_destinations_v1_with_http_info(body, opts)
+      data
+    end
+
+    # Get destinations for a migration.
+    # &#x60;device_ids&#x60; and &#x60;filter&#x60; are mutually exclusive.
+    # @param body [ApiGetMigrationDestinationsRequestBodyV1]
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ApiGetMigrationDestinationsResponseV1, Integer, Hash)>] ApiGetMigrationDestinationsResponseV1 data, response status code and response headers
+    def get_migration_destinations_v1_with_http_info(body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: HostMigration.get_migration_destinations_v1 ...'
+      end
+      # verify the required parameter 'body' is set
+      if @api_client.config.client_side_validation && body.nil?
+        fail ArgumentError, "Missing the required parameter 'body' when calling HostMigration.get_migration_destinations_v1"
+      end
+      # resource path
+      local_var_path = '/host-migration/entities/migration-destinations/GET/v1'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+        header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(body)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ApiGetMigrationDestinationsResponseV1'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['oauth2']
+
+      new_options = opts.merge(
+        :operation => :"HostMigration.get_migration_destinations_v1",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: HostMigration#get_migration_destinations_v1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Query migration jobs.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :offset The offset to start retrieving records from
+    # @option opts [Integer] :limit The maximum records to return. [1-10000]
+    # @option opts [String] :sort The property to sort by.
+    # @option opts [String] :filter The filter expression that should be used to limit the results. Valid fields: target_cid, status, migration_status, created_by, created_time, name, id, migration_id
+    # @return [MsaspecQueryResponse]
+    def get_migration_ids_v1(opts = {})
+      data, _status_code, _headers = get_migration_ids_v1_with_http_info(opts)
+      data
+    end
+
+    # Query migration jobs.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :offset The offset to start retrieving records from
+    # @option opts [Integer] :limit The maximum records to return. [1-10000]
+    # @option opts [String] :sort The property to sort by.
+    # @option opts [String] :filter The filter expression that should be used to limit the results. Valid fields: target_cid, status, migration_status, created_by, created_time, name, id, migration_id
+    # @return [Array<(MsaspecQueryResponse, Integer, Hash)>] MsaspecQueryResponse data, response status code and response headers
+    def get_migration_ids_v1_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: HostMigration.get_migration_ids_v1 ...'
+      end
+      allowable_values = ["name|asc", "name|desc", "name", "id|asc", "id|desc", "id", "migration_id|asc", "migration_id|desc", "migration_id", "target_cid|asc", "target_cid|desc", "target_cid", "status|asc", "status|desc", "status", "migration_status|asc", "migration_status|desc", "migration_status", "created_by|asc", "created_by|desc", "created_by", "created_time|asc", "created_time|desc", "created_time"]
+      if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
+        fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/host-migration/queries/migrations/v1'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
+      query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'MsaspecQueryResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['oauth2']
+
+      new_options = opts.merge(
+        :operation => :"HostMigration.get_migration_ids_v1",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: HostMigration#get_migration_ids_v1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get migration job details.
+    # @param ids [Array<String>] The migration jobs of interest.
+    # @param [Hash] opts the optional parameters
+    # @return [ApiGetMigrationsResponseV1]
+    def get_migrations_v1(ids, opts = {})
+      data, _status_code, _headers = get_migrations_v1_with_http_info(ids, opts)
+      data
+    end
+
+    # Get migration job details.
+    # @param ids [Array<String>] The migration jobs of interest.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ApiGetMigrationsResponseV1, Integer, Hash)>] ApiGetMigrationsResponseV1 data, response status code and response headers
+    def get_migrations_v1_with_http_info(ids, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: HostMigration.get_migrations_v1 ...'
+      end
+      # verify the required parameter 'ids' is set
+      if @api_client.config.client_side_validation && ids.nil?
+        fail ArgumentError, "Missing the required parameter 'ids' when calling HostMigration.get_migrations_v1"
+      end
+      # resource path
+      local_var_path = '/host-migration/entities/migrations/v1'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'ids'] = @api_client.build_collection_param(ids, :multi)
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ApiGetMigrationsResponseV1'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['oauth2']
+
+      new_options = opts.merge(
+        :operation => :"HostMigration.get_migrations_v1",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: HostMigration#get_migrations_v1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get host migration aggregates as specified via json in request body.
+    # Get host migration aggregates as specified via json in request body.  # Supported Types  Both types support the following FQL filter properties: `groups`, `hostgroups`, `static_host_groups`, `hostname`, `status`, `target_cid`, `source_cid`, `migration_id`, `id`, `host_migration_id`, `created_time`.  The values `groups` and `hostgroups` are aliases for `static_host_groups`.  The value `host_migration_id` is an alias for `id`  ## Terms `\"type\": \"terms\"`  Supported `field` values: `groups`, `hostgroups`, `static_host_groups`, `hostname`, `status`, `target_cid`, `source_cid`, `migration_id`, `id`, `host_migration_id`.  `sort` must be done on the same value as `field` and include a direction (`asc` or `desc`). Supports all FQL fields except for `groups`, `hostgroups`, or `static_host_groups`.  Examples sort value: `status|asc` or `created_by|desc`   ## Date Range `\"type\": \"date_range\"`  Supported `field` fields: `created_time`.  Does not support `sort`, `size`, or `from`.
+    # @param body [Array<MsaAggregateQueryRequest>]
+    # @param [Hash] opts the optional parameters
+    # @return [MsaAggregatesResponse]
+    def host_migration_aggregates_v1(body, opts = {})
+      data, _status_code, _headers = host_migration_aggregates_v1_with_http_info(body, opts)
+      data
+    end
+
+    # Get host migration aggregates as specified via json in request body.
+    # Get host migration aggregates as specified via json in request body.  # Supported Types  Both types support the following FQL filter properties: &#x60;groups&#x60;, &#x60;hostgroups&#x60;, &#x60;static_host_groups&#x60;, &#x60;hostname&#x60;, &#x60;status&#x60;, &#x60;target_cid&#x60;, &#x60;source_cid&#x60;, &#x60;migration_id&#x60;, &#x60;id&#x60;, &#x60;host_migration_id&#x60;, &#x60;created_time&#x60;.  The values &#x60;groups&#x60; and &#x60;hostgroups&#x60; are aliases for &#x60;static_host_groups&#x60;.  The value &#x60;host_migration_id&#x60; is an alias for &#x60;id&#x60;  ## Terms &#x60;\&quot;type\&quot;: \&quot;terms\&quot;&#x60;  Supported &#x60;field&#x60; values: &#x60;groups&#x60;, &#x60;hostgroups&#x60;, &#x60;static_host_groups&#x60;, &#x60;hostname&#x60;, &#x60;status&#x60;, &#x60;target_cid&#x60;, &#x60;source_cid&#x60;, &#x60;migration_id&#x60;, &#x60;id&#x60;, &#x60;host_migration_id&#x60;.  &#x60;sort&#x60; must be done on the same value as &#x60;field&#x60; and include a direction (&#x60;asc&#x60; or &#x60;desc&#x60;). Supports all FQL fields except for &#x60;groups&#x60;, &#x60;hostgroups&#x60;, or &#x60;static_host_groups&#x60;.  Examples sort value: &#x60;status|asc&#x60; or &#x60;created_by|desc&#x60;   ## Date Range &#x60;\&quot;type\&quot;: \&quot;date_range\&quot;&#x60;  Supported &#x60;field&#x60; fields: &#x60;created_time&#x60;.  Does not support &#x60;sort&#x60;, &#x60;size&#x60;, or &#x60;from&#x60;.
+    # @param body [Array<MsaAggregateQueryRequest>]
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(MsaAggregatesResponse, Integer, Hash)>] MsaAggregatesResponse data, response status code and response headers
+    def host_migration_aggregates_v1_with_http_info(body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: HostMigration.host_migration_aggregates_v1 ...'
+      end
+      # verify the required parameter 'body' is set
+      if @api_client.config.client_side_validation && body.nil?
+        fail ArgumentError, "Missing the required parameter 'body' when calling HostMigration.host_migration_aggregates_v1"
+      end
+      # resource path
+      local_var_path = '/host-migration/aggregates/host-migrations/v1'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+        header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(body)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'MsaAggregatesResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['oauth2']
+
+      new_options = opts.merge(
+        :operation => :"HostMigration.host_migration_aggregates_v1",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: HostMigration#host_migration_aggregates_v1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Perform an action on host migrations.
+    # The available actions are `add_host_groups`, `remove_host_groups`, and `remove_hosts`.  FQL filter supports the following fields: `groups`, `hostgroups`, `static_host_groups`, `hostname`, `status`, `target_cid`, `source_cid`, `migration_id`, `id`, `host_migration_id`, `created_time`.  These actions only works if the migration has not started.  `add_host_groups` adds static host groups to the selected hosts in a migration. This action accepts the following action parameter: `{ \"name\": \"host_group\": \"value\": \"$host_group_id\" }`. Action parameters can be repeated to add multiple static host groups in a single request.  `remove_host_groups` removes static host groups from the selected hosts in a migration. This action accepts the following action parameter: `{ \"name\": \"host_group\": \"value\": \"$host_group_id\" }`. Action parameters can be repeated to remove multiple static host groups in a single request.  `remove_hosts` removes the selected hosts from a migration. This action does not accept any action parameters.
+    # @param id [String] The migration job to perform actions on
+    # @param action_name [String] The action to perform
+    # @param body [MsaEntityActionRequestV3]
+    # @param [Hash] opts the optional parameters
+    # @return [MsaspecQueryResponse]
+    def host_migrations_actions_v1(id, action_name, body, opts = {})
+      data, _status_code, _headers = host_migrations_actions_v1_with_http_info(id, action_name, body, opts)
+      data
+    end
+
+    # Perform an action on host migrations.
+    # The available actions are &#x60;add_host_groups&#x60;, &#x60;remove_host_groups&#x60;, and &#x60;remove_hosts&#x60;.  FQL filter supports the following fields: &#x60;groups&#x60;, &#x60;hostgroups&#x60;, &#x60;static_host_groups&#x60;, &#x60;hostname&#x60;, &#x60;status&#x60;, &#x60;target_cid&#x60;, &#x60;source_cid&#x60;, &#x60;migration_id&#x60;, &#x60;id&#x60;, &#x60;host_migration_id&#x60;, &#x60;created_time&#x60;.  These actions only works if the migration has not started.  &#x60;add_host_groups&#x60; adds static host groups to the selected hosts in a migration. This action accepts the following action parameter: &#x60;{ \&quot;name\&quot;: \&quot;host_group\&quot;: \&quot;value\&quot;: \&quot;$host_group_id\&quot; }&#x60;. Action parameters can be repeated to add multiple static host groups in a single request.  &#x60;remove_host_groups&#x60; removes static host groups from the selected hosts in a migration. This action accepts the following action parameter: &#x60;{ \&quot;name\&quot;: \&quot;host_group\&quot;: \&quot;value\&quot;: \&quot;$host_group_id\&quot; }&#x60;. Action parameters can be repeated to remove multiple static host groups in a single request.  &#x60;remove_hosts&#x60; removes the selected hosts from a migration. This action does not accept any action parameters.
+    # @param id [String] The migration job to perform actions on
+    # @param action_name [String] The action to perform
+    # @param body [MsaEntityActionRequestV3]
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(MsaspecQueryResponse, Integer, Hash)>] MsaspecQueryResponse data, response status code and response headers
+    def host_migrations_actions_v1_with_http_info(id, action_name, body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: HostMigration.host_migrations_actions_v1 ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling HostMigration.host_migrations_actions_v1"
+      end
+      # verify the required parameter 'action_name' is set
+      if @api_client.config.client_side_validation && action_name.nil?
+        fail ArgumentError, "Missing the required parameter 'action_name' when calling HostMigration.host_migrations_actions_v1"
+      end
+      # verify enum value
+      allowable_values = ["remove_hosts", "remove_host_groups", "add_host_groups"]
+      if @api_client.config.client_side_validation && !allowable_values.include?(action_name)
+        fail ArgumentError, "invalid value for \"action_name\", must be one of #{allowable_values}"
+      end
+      # verify the required parameter 'body' is set
+      if @api_client.config.client_side_validation && body.nil?
+        fail ArgumentError, "Missing the required parameter 'body' when calling HostMigration.host_migrations_actions_v1"
+      end
+      # resource path
+      local_var_path = '/host-migration/entities/host-migrations-actions/v1'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'id'] = id
+      query_params[:'action_name'] = action_name
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+        header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(body)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'MsaspecQueryResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['oauth2']
+
+      new_options = opts.merge(
+        :operation => :"HostMigration.host_migrations_actions_v1",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: HostMigration#host_migrations_actions_v1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get migration aggregates as specified via json in request body.
+    # Get migration aggregates as specified via json in request body.  # Supported Types  Both types support the following FQL filter props: `name`, `id`, `migration_id`, `target_cid`, `status`, `migration_status`, `created_by`, `created_time`.  The value `migration_status` is an alias for `status`.  The value `migration_id` is an alias for `id`.  ## Terms `\"type\": \"terms\"`  Supported `field` values: `name`, `id`, `migration_id,` `target_cid`, `status`, `migration_status`, `created_by`.  `sort` on `terms` type must be done on the same value as `field` and include a direction (`asc` or `desc`). Supports all supported FQL fields.  Examples sort value: `status|asc` or `created_by|desc`.   ## Date Range `\"type\": \"date_range\"`  Supported `field` fields: `created_time`.  Does not support `sort`, `size`, or `from`.
+    # @param body [Array<MsaAggregateQueryRequest>]
+    # @param [Hash] opts the optional parameters
+    # @return [MsaAggregatesResponse]
+    def migration_aggregates_v1(body, opts = {})
+      data, _status_code, _headers = migration_aggregates_v1_with_http_info(body, opts)
+      data
+    end
+
+    # Get migration aggregates as specified via json in request body.
+    # Get migration aggregates as specified via json in request body.  # Supported Types  Both types support the following FQL filter props: &#x60;name&#x60;, &#x60;id&#x60;, &#x60;migration_id&#x60;, &#x60;target_cid&#x60;, &#x60;status&#x60;, &#x60;migration_status&#x60;, &#x60;created_by&#x60;, &#x60;created_time&#x60;.  The value &#x60;migration_status&#x60; is an alias for &#x60;status&#x60;.  The value &#x60;migration_id&#x60; is an alias for &#x60;id&#x60;.  ## Terms &#x60;\&quot;type\&quot;: \&quot;terms\&quot;&#x60;  Supported &#x60;field&#x60; values: &#x60;name&#x60;, &#x60;id&#x60;, &#x60;migration_id,&#x60; &#x60;target_cid&#x60;, &#x60;status&#x60;, &#x60;migration_status&#x60;, &#x60;created_by&#x60;.  &#x60;sort&#x60; on &#x60;terms&#x60; type must be done on the same value as &#x60;field&#x60; and include a direction (&#x60;asc&#x60; or &#x60;desc&#x60;). Supports all supported FQL fields.  Examples sort value: &#x60;status|asc&#x60; or &#x60;created_by|desc&#x60;.   ## Date Range &#x60;\&quot;type\&quot;: \&quot;date_range\&quot;&#x60;  Supported &#x60;field&#x60; fields: &#x60;created_time&#x60;.  Does not support &#x60;sort&#x60;, &#x60;size&#x60;, or &#x60;from&#x60;.
+    # @param body [Array<MsaAggregateQueryRequest>]
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(MsaAggregatesResponse, Integer, Hash)>] MsaAggregatesResponse data, response status code and response headers
+    def migration_aggregates_v1_with_http_info(body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: HostMigration.migration_aggregates_v1 ...'
+      end
+      # verify the required parameter 'body' is set
+      if @api_client.config.client_side_validation && body.nil?
+        fail ArgumentError, "Missing the required parameter 'body' when calling HostMigration.migration_aggregates_v1"
+      end
+      # resource path
+      local_var_path = '/host-migration/aggregates/migrations/v1'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+        header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(body)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'MsaAggregatesResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['oauth2']
+
+      new_options = opts.merge(
+        :operation => :"HostMigration.migration_aggregates_v1",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: HostMigration#migration_aggregates_v1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Perform an action on a migration job.
+    # The available actions are `start_migration`, `cancel_migration`, `rename_migration`, and `delete_migration`.  `start_migration` starts the selected migrations. This action only works if the migration has not started. This action does not accept any action parameters. Only one migration may be started per request.  `cancel_migration` cancels the selected migrations. This actions only works if the migration has started and not completed. This action does not accept any action parameters.  `rename_migration` renames the selected migrations. This action can be called at any time. Only 1 action parameter may be supplied. Action parameters take the form of `{\"name\": \"migration_name\": \"value\": \"$new_migration_name\"}`.  `delete_migration` deletes the selected migrations. This action only works if the migration has not started. This action does not accept any action parameters.
+    # @param action_name [String] The action to perform
+    # @param body [MsaEntityActionRequestV3]
+    # @param [Hash] opts the optional parameters
+    # @return [MsaspecQueryResponse]
+    def migrations_actions_v1(action_name, body, opts = {})
+      data, _status_code, _headers = migrations_actions_v1_with_http_info(action_name, body, opts)
+      data
+    end
+
+    # Perform an action on a migration job.
+    # The available actions are &#x60;start_migration&#x60;, &#x60;cancel_migration&#x60;, &#x60;rename_migration&#x60;, and &#x60;delete_migration&#x60;.  &#x60;start_migration&#x60; starts the selected migrations. This action only works if the migration has not started. This action does not accept any action parameters. Only one migration may be started per request.  &#x60;cancel_migration&#x60; cancels the selected migrations. This actions only works if the migration has started and not completed. This action does not accept any action parameters.  &#x60;rename_migration&#x60; renames the selected migrations. This action can be called at any time. Only 1 action parameter may be supplied. Action parameters take the form of &#x60;{\&quot;name\&quot;: \&quot;migration_name\&quot;: \&quot;value\&quot;: \&quot;$new_migration_name\&quot;}&#x60;.  &#x60;delete_migration&#x60; deletes the selected migrations. This action only works if the migration has not started. This action does not accept any action parameters.
+    # @param action_name [String] The action to perform
+    # @param body [MsaEntityActionRequestV3]
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(MsaspecQueryResponse, Integer, Hash)>] MsaspecQueryResponse data, response status code and response headers
+    def migrations_actions_v1_with_http_info(action_name, body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: HostMigration.migrations_actions_v1 ...'
+      end
+      # verify the required parameter 'action_name' is set
+      if @api_client.config.client_side_validation && action_name.nil?
+        fail ArgumentError, "Missing the required parameter 'action_name' when calling HostMigration.migrations_actions_v1"
+      end
+      # verify enum value
+      allowable_values = ["delete_migration", "rename_migration", "start_migration", "cancel_migration"]
+      if @api_client.config.client_side_validation && !allowable_values.include?(action_name)
+        fail ArgumentError, "invalid value for \"action_name\", must be one of #{allowable_values}"
+      end
+      # verify the required parameter 'body' is set
+      if @api_client.config.client_side_validation && body.nil?
+        fail ArgumentError, "Missing the required parameter 'body' when calling HostMigration.migrations_actions_v1"
+      end
+      # resource path
+      local_var_path = '/host-migration/entities/migrations-actions/v1'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'action_name'] = action_name
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+        header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(body)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'MsaspecQueryResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['oauth2']
+
+      new_options = opts.merge(
+        :operation => :"HostMigration.migrations_actions_v1",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: HostMigration#migrations_actions_v1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end