rocket_stack_sdk 1.0.1

data/lib/rocket_stack_sdk/api/scheduler_api.rb

@@ -0,0 +1,483 @@
+=begin
+#Rocketstack API
+
+#API for Functions, Queues, KV, Storage, Cron, and Scheduler.
+
+The version of the OpenAPI document: 1.0.1
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.19.0
+
+=end
+
+require 'cgi'
+
+module RocketStackSdk
+  class SchedulerApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Cancel a schedule
+    # Cancels a pending schedule by setting it to paused.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [CreateSchedule201Response]
+    def cancel_schedule(id, opts = {})
+      data, _status_code, _headers = cancel_schedule_with_http_info(id, opts)
+      data
+    end
+
+    # Cancel a schedule
+    # Cancels a pending schedule by setting it to paused.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CreateSchedule201Response, Integer, Hash)>] CreateSchedule201Response data, response status code and response headers
+    def cancel_schedule_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SchedulerApi.cancel_schedule ...'
+      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 SchedulerApi.cancel_schedule"
+      end
+      # resource path
+      local_var_path = '/schedules/{id}/cancel'.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']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CreateSchedule201Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"SchedulerApi.cancel_schedule",
+        :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: SchedulerApi#cancel_schedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Create a new one-off schedule
+    # Creates a new one-off scheduled task to run at a specific time.
+    # @param create_schedule_request [CreateScheduleRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [CreateSchedule201Response]
+    def create_schedule(create_schedule_request, opts = {})
+      data, _status_code, _headers = create_schedule_with_http_info(create_schedule_request, opts)
+      data
+    end
+
+    # Create a new one-off schedule
+    # Creates a new one-off scheduled task to run at a specific time.
+    # @param create_schedule_request [CreateScheduleRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CreateSchedule201Response, Integer, Hash)>] CreateSchedule201Response data, response status code and response headers
+    def create_schedule_with_http_info(create_schedule_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SchedulerApi.create_schedule ...'
+      end
+      # verify the required parameter 'create_schedule_request' is set
+      if @api_client.config.client_side_validation && create_schedule_request.nil?
+        fail ArgumentError, "Missing the required parameter 'create_schedule_request' when calling SchedulerApi.create_schedule"
+      end
+      # resource path
+      local_var_path = '/schedules'
+
+      # 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
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(create_schedule_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CreateSchedule201Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"SchedulerApi.create_schedule",
+        :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: SchedulerApi#create_schedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Delete a schedule
+    # Deletes a schedule and its associated AWS resources.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [CreateSchedule201Response]
+    def delete_schedule(id, opts = {})
+      data, _status_code, _headers = delete_schedule_with_http_info(id, opts)
+      data
+    end
+
+    # Delete a schedule
+    # Deletes a schedule and its associated AWS resources.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CreateSchedule201Response, Integer, Hash)>] CreateSchedule201Response data, response status code and response headers
+    def delete_schedule_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SchedulerApi.delete_schedule ...'
+      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 SchedulerApi.delete_schedule"
+      end
+      # resource path
+      local_var_path = '/schedules/{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']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CreateSchedule201Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"SchedulerApi.delete_schedule",
+        :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: SchedulerApi#delete_schedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get a schedule by ID
+    # Retrieves details of a specific schedule including its configuration.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [GetSchedule200Response]
+    def get_schedule(id, opts = {})
+      data, _status_code, _headers = get_schedule_with_http_info(id, opts)
+      data
+    end
+
+    # Get a schedule by ID
+    # Retrieves details of a specific schedule including its configuration.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GetSchedule200Response, Integer, Hash)>] GetSchedule200Response data, response status code and response headers
+    def get_schedule_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SchedulerApi.get_schedule ...'
+      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 SchedulerApi.get_schedule"
+      end
+      # resource path
+      local_var_path = '/schedules/{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']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'GetSchedule200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"SchedulerApi.get_schedule",
+        :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: SchedulerApi#get_schedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get schedule execution status
+    # Retrieves the current execution status of a schedule.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [GetScheduleStatus200Response]
+    def get_schedule_status(id, opts = {})
+      data, _status_code, _headers = get_schedule_status_with_http_info(id, opts)
+      data
+    end
+
+    # Get schedule execution status
+    # Retrieves the current execution status of a schedule.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GetScheduleStatus200Response, Integer, Hash)>] GetScheduleStatus200Response data, response status code and response headers
+    def get_schedule_status_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SchedulerApi.get_schedule_status ...'
+      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 SchedulerApi.get_schedule_status"
+      end
+      # resource path
+      local_var_path = '/schedules/{id}/status'.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']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'GetScheduleStatus200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"SchedulerApi.get_schedule_status",
+        :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: SchedulerApi#get_schedule_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List schedules
+    # Returns a paginated list of one-off schedules for the tenant.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Float] :limit  (default to 50)
+    # @option opts [String] :cursor 
+    # @return [ListSchedules200Response]
+    def list_schedules(opts = {})
+      data, _status_code, _headers = list_schedules_with_http_info(opts)
+      data
+    end
+
+    # List schedules
+    # Returns a paginated list of one-off schedules for the tenant.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Float] :limit  (default to 50)
+    # @option opts [String] :cursor 
+    # @return [Array<(ListSchedules200Response, Integer, Hash)>] ListSchedules200Response data, response status code and response headers
+    def list_schedules_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SchedulerApi.list_schedules ...'
+      end
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling SchedulerApi.list_schedules, must be smaller than or equal to 100.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling SchedulerApi.list_schedules, must be greater than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/schedules'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].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']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ListSchedules200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"SchedulerApi.list_schedules",
+        :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: SchedulerApi#list_schedules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update a schedule
+    # Updates schedule configuration. Changes require AWS reprovisioning.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [UpdateScheduleRequest] :update_schedule_request 
+    # @return [UpdateSchedule200Response]
+    def update_schedule(id, opts = {})
+      data, _status_code, _headers = update_schedule_with_http_info(id, opts)
+      data
+    end
+
+    # Update a schedule
+    # Updates schedule configuration. Changes require AWS reprovisioning.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [UpdateScheduleRequest] :update_schedule_request 
+    # @return [Array<(UpdateSchedule200Response, Integer, Hash)>] UpdateSchedule200Response data, response status code and response headers
+    def update_schedule_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SchedulerApi.update_schedule ...'
+      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 SchedulerApi.update_schedule"
+      end
+      # resource path
+      local_var_path = '/schedules/{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']
+      # 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(opts[:'update_schedule_request'])
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'UpdateSchedule200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"SchedulerApi.update_schedule",
+        :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(:PATCH, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SchedulerApi#update_schedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end