nightona_api_client 0.191.0

data/lib/nightona_api_client/api/snapshots_api.rb

@@ -0,0 +1,567 @@
+=begin
+#Nightona
+
+#Nightona AI platform API Docs
+
+The version of the OpenAPI document: 1.0
+Contact: amaraaamka0404@gmail.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.21.0
+
+=end
+
+require 'cgi'
+
+module NightonaApiClient
+  class SnapshotsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Activate a snapshot
+    # @param id [String] Snapshot ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :x_nightona_organization_id Use with JWT to specify the organization ID
+    # @return [SnapshotDto]
+    def activate_snapshot(id, opts = {})
+      data, _status_code, _headers = activate_snapshot_with_http_info(id, opts)
+      data
+    end
+
+    # Activate a snapshot
+    # @param id [String] Snapshot ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :x_nightona_organization_id Use with JWT to specify the organization ID
+    # @return [Array<(SnapshotDto, Integer, Hash)>] SnapshotDto data, response status code and response headers
+    def activate_snapshot_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SnapshotsApi.activate_snapshot ...'
+      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 SnapshotsApi.activate_snapshot"
+      end
+      # resource path
+      local_var_path = '/snapshots/{id}/activate'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # 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']) unless header_params['Accept']
+      header_params[:'X-Nightona-Organization-ID'] = opts[:'x_nightona_organization_id'] if !opts[:'x_nightona_organization_id'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SnapshotDto'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer', 'oauth2']
+
+      new_options = opts.merge(
+        :operation => :"SnapshotsApi.activate_snapshot",
+        :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: SnapshotsApi#activate_snapshot\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Create a new snapshot
+    # @param create_snapshot [CreateSnapshot] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :x_nightona_organization_id Use with JWT to specify the organization ID
+    # @return [SnapshotDto]
+    def create_snapshot(create_snapshot, opts = {})
+      data, _status_code, _headers = create_snapshot_with_http_info(create_snapshot, opts)
+      data
+    end
+
+    # Create a new snapshot
+    # @param create_snapshot [CreateSnapshot] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :x_nightona_organization_id Use with JWT to specify the organization ID
+    # @return [Array<(SnapshotDto, Integer, Hash)>] SnapshotDto data, response status code and response headers
+    def create_snapshot_with_http_info(create_snapshot, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SnapshotsApi.create_snapshot ...'
+      end
+      # verify the required parameter 'create_snapshot' is set
+      if @api_client.config.client_side_validation && create_snapshot.nil?
+        fail ArgumentError, "Missing the required parameter 'create_snapshot' when calling SnapshotsApi.create_snapshot"
+      end
+      # resource path
+      local_var_path = '/snapshots'
+
+      # 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']) unless header_params['Accept']
+      # 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
+      header_params[:'X-Nightona-Organization-ID'] = opts[:'x_nightona_organization_id'] if !opts[:'x_nightona_organization_id'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(create_snapshot)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SnapshotDto'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer', 'oauth2']
+
+      new_options = opts.merge(
+        :operation => :"SnapshotsApi.create_snapshot",
+        :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: SnapshotsApi#create_snapshot\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Deactivate a snapshot
+    # @param id [String] Snapshot ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :x_nightona_organization_id Use with JWT to specify the organization ID
+    # @return [nil]
+    def deactivate_snapshot(id, opts = {})
+      deactivate_snapshot_with_http_info(id, opts)
+      nil
+    end
+
+    # Deactivate a snapshot
+    # @param id [String] Snapshot ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :x_nightona_organization_id Use with JWT to specify the organization ID
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def deactivate_snapshot_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SnapshotsApi.deactivate_snapshot ...'
+      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 SnapshotsApi.deactivate_snapshot"
+      end
+      # resource path
+      local_var_path = '/snapshots/{id}/deactivate'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      header_params[:'X-Nightona-Organization-ID'] = opts[:'x_nightona_organization_id'] if !opts[:'x_nightona_organization_id'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer', 'oauth2']
+
+      new_options = opts.merge(
+        :operation => :"SnapshotsApi.deactivate_snapshot",
+        :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: SnapshotsApi#deactivate_snapshot\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List all snapshots
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :x_nightona_organization_id Use with JWT to specify the organization ID
+    # @option opts [Float] :page Page number of the results (default to 1)
+    # @option opts [Float] :limit Number of results per page (default to 100)
+    # @option opts [String] :name Filter by partial name match
+    # @option opts [String] :sort Field to sort by (default to 'lastUsedAt')
+    # @option opts [String] :order Direction to sort by (default to 'desc')
+    # @return [PaginatedSnapshots]
+    def get_all_snapshots(opts = {})
+      data, _status_code, _headers = get_all_snapshots_with_http_info(opts)
+      data
+    end
+
+    # List all snapshots
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :x_nightona_organization_id Use with JWT to specify the organization ID
+    # @option opts [Float] :page Page number of the results (default to 1)
+    # @option opts [Float] :limit Number of results per page (default to 100)
+    # @option opts [String] :name Filter by partial name match
+    # @option opts [String] :sort Field to sort by (default to 'lastUsedAt')
+    # @option opts [String] :order Direction to sort by (default to 'desc')
+    # @return [Array<(PaginatedSnapshots, Integer, Hash)>] PaginatedSnapshots data, response status code and response headers
+    def get_all_snapshots_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SnapshotsApi.get_all_snapshots ...'
+      end
+      if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SnapshotsApi.get_all_snapshots, must be greater than or equal to 1.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 200
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling SnapshotsApi.get_all_snapshots, must be smaller than or equal to 200.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling SnapshotsApi.get_all_snapshots, must be greater than or equal to 1.'
+      end
+
+      allowable_values = ["name", "state", "lastUsedAt", "createdAt", "unknown_default_open_api"]
+      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
+      allowable_values = ["asc", "desc", "unknown_default_open_api"]
+      if @api_client.config.client_side_validation && opts[:'order'] && !allowable_values.include?(opts[:'order'])
+        fail ArgumentError, "invalid value for \"order\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/snapshots'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
+      query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
+      query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      header_params[:'X-Nightona-Organization-ID'] = opts[:'x_nightona_organization_id'] if !opts[:'x_nightona_organization_id'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'PaginatedSnapshots'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer', 'oauth2']
+
+      new_options = opts.merge(
+        :operation => :"SnapshotsApi.get_all_snapshots",
+        :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: SnapshotsApi#get_all_snapshots\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get snapshot by ID or name
+    # @param id [String] Snapshot ID or name
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :x_nightona_organization_id Use with JWT to specify the organization ID
+    # @return [SnapshotDto]
+    def get_snapshot(id, opts = {})
+      data, _status_code, _headers = get_snapshot_with_http_info(id, opts)
+      data
+    end
+
+    # Get snapshot by ID or name
+    # @param id [String] Snapshot ID or name
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :x_nightona_organization_id Use with JWT to specify the organization ID
+    # @return [Array<(SnapshotDto, Integer, Hash)>] SnapshotDto data, response status code and response headers
+    def get_snapshot_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SnapshotsApi.get_snapshot ...'
+      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 SnapshotsApi.get_snapshot"
+      end
+      # resource path
+      local_var_path = '/snapshots/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # 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']) unless header_params['Accept']
+      header_params[:'X-Nightona-Organization-ID'] = opts[:'x_nightona_organization_id'] if !opts[:'x_nightona_organization_id'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SnapshotDto'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer', 'oauth2']
+
+      new_options = opts.merge(
+        :operation => :"SnapshotsApi.get_snapshot",
+        :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: SnapshotsApi#get_snapshot\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get snapshot build logs
+    # This endpoint is deprecated. Use `getSnapshotBuildLogsUrl` instead.
+    # @param id [String] Snapshot ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :x_nightona_organization_id Use with JWT to specify the organization ID
+    # @option opts [Boolean] :follow Whether to follow the logs stream
+    # @return [nil]
+    def get_snapshot_build_logs(id, opts = {})
+      get_snapshot_build_logs_with_http_info(id, opts)
+      nil
+    end
+
+    # Get snapshot build logs
+    # This endpoint is deprecated. Use &#x60;getSnapshotBuildLogsUrl&#x60; instead.
+    # @param id [String] Snapshot ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :x_nightona_organization_id Use with JWT to specify the organization ID
+    # @option opts [Boolean] :follow Whether to follow the logs stream
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def get_snapshot_build_logs_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SnapshotsApi.get_snapshot_build_logs ...'
+      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 SnapshotsApi.get_snapshot_build_logs"
+      end
+      # resource path
+      local_var_path = '/snapshots/{id}/build-logs'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'follow'] = opts[:'follow'] if !opts[:'follow'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      header_params[:'X-Nightona-Organization-ID'] = opts[:'x_nightona_organization_id'] if !opts[:'x_nightona_organization_id'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer', 'oauth2']
+
+      new_options = opts.merge(
+        :operation => :"SnapshotsApi.get_snapshot_build_logs",
+        :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: SnapshotsApi#get_snapshot_build_logs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get snapshot build logs URL
+    # @param id [String] Snapshot ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :x_nightona_organization_id Use with JWT to specify the organization ID
+    # @return [Url]
+    def get_snapshot_build_logs_url(id, opts = {})
+      data, _status_code, _headers = get_snapshot_build_logs_url_with_http_info(id, opts)
+      data
+    end
+
+    # Get snapshot build logs URL
+    # @param id [String] Snapshot ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :x_nightona_organization_id Use with JWT to specify the organization ID
+    # @return [Array<(Url, Integer, Hash)>] Url data, response status code and response headers
+    def get_snapshot_build_logs_url_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SnapshotsApi.get_snapshot_build_logs_url ...'
+      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 SnapshotsApi.get_snapshot_build_logs_url"
+      end
+      # resource path
+      local_var_path = '/snapshots/{id}/build-logs-url'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # 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']) unless header_params['Accept']
+      header_params[:'X-Nightona-Organization-ID'] = opts[:'x_nightona_organization_id'] if !opts[:'x_nightona_organization_id'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Url'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer', 'oauth2']
+
+      new_options = opts.merge(
+        :operation => :"SnapshotsApi.get_snapshot_build_logs_url",
+        :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: SnapshotsApi#get_snapshot_build_logs_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Delete snapshot
+    # @param id [String] Snapshot ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :x_nightona_organization_id Use with JWT to specify the organization ID
+    # @return [nil]
+    def remove_snapshot(id, opts = {})
+      remove_snapshot_with_http_info(id, opts)
+      nil
+    end
+
+    # Delete snapshot
+    # @param id [String] Snapshot ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :x_nightona_organization_id Use with JWT to specify the organization ID
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def remove_snapshot_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SnapshotsApi.remove_snapshot ...'
+      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 SnapshotsApi.remove_snapshot"
+      end
+      # resource path
+      local_var_path = '/snapshots/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      header_params[:'X-Nightona-Organization-ID'] = opts[:'x_nightona_organization_id'] if !opts[:'x_nightona_organization_id'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer', 'oauth2']
+
+      new_options = opts.merge(
+        :operation => :"SnapshotsApi.remove_snapshot",
+        :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(:DELETE, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SnapshotsApi#remove_snapshot\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end