payjpv2 1.0.2

data/lib/payjpv2/api/payment_flows_api.rb

@@ -0,0 +1,561 @@
+=begin
+#PAY.JP API v2
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: 2.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.14.0
+
+=end
+
+require 'cgi'
+
+module PAYJPv2
+  class PaymentFlowsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Cancel Payment Flow
+    # @param payment_flow_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [PaymentFlowCancelRequest] :payment_flow_cancel_request 
+    # @option opts [String] :idempotency_key Idempotency key for the request
+    # @option opts [Boolean] :include_http_info If true, returns [data, status_code, headers] instead of just data
+    # @return [PaymentFlowResponse, Array] Returns data or [data, status_code, headers] if include_http_info is true
+    def cancel_payment_flow(payment_flow_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PaymentFlowsApi.cancel_payment_flow ...'
+      end
+      # verify the required parameter 'payment_flow_id' is set
+      if @api_client.config.client_side_validation && payment_flow_id.nil?
+        raise ArgumentError, "Missing the required parameter 'payment_flow_id' when calling PaymentFlowsApi.cancel_payment_flow"
+      end
+      # resource path
+      local_var_path = '/v2/payment_flows/{payment_flow_id}/cancel'.sub('{' + 'payment_flow_id' + '}', CGI.escape(payment_flow_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      header_params['Idempotency-Key'] = opts[:idempotency_key] if opts[:idempotency_key]
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+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[:payment_flow_cancel_request])
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'PaymentFlowResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['HTTPBasic', 'HTTPBearer']
+
+      new_options = opts.merge(
+        :operation => :"PaymentFlowsApi.cancel_payment_flow",
+        :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: PaymentFlowsApi#cancel_payment_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+
+      if opts[:include_http_info]
+        [data, status_code, headers]
+      else
+        data
+      end
+    end
+
+    # Capture Payment Flow
+    # @param payment_flow_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [PaymentFlowCaptureRequest] :payment_flow_capture_request 
+    # @option opts [String] :idempotency_key Idempotency key for the request
+    # @option opts [Boolean] :include_http_info If true, returns [data, status_code, headers] instead of just data
+    # @return [PaymentFlowResponse, Array] Returns data or [data, status_code, headers] if include_http_info is true
+    def capture_payment_flow(payment_flow_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PaymentFlowsApi.capture_payment_flow ...'
+      end
+      # verify the required parameter 'payment_flow_id' is set
+      if @api_client.config.client_side_validation && payment_flow_id.nil?
+        raise ArgumentError, "Missing the required parameter 'payment_flow_id' when calling PaymentFlowsApi.capture_payment_flow"
+      end
+      # resource path
+      local_var_path = '/v2/payment_flows/{payment_flow_id}/capture'.sub('{' + 'payment_flow_id' + '}', CGI.escape(payment_flow_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      header_params['Idempotency-Key'] = opts[:idempotency_key] if opts[:idempotency_key]
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+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[:payment_flow_capture_request])
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'PaymentFlowResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['HTTPBasic', 'HTTPBearer']
+
+      new_options = opts.merge(
+        :operation => :"PaymentFlowsApi.capture_payment_flow",
+        :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: PaymentFlowsApi#capture_payment_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+
+      if opts[:include_http_info]
+        [data, status_code, headers]
+      else
+        data
+      end
+    end
+
+    # Confirm Payment Flow
+    # @param payment_flow_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [PaymentFlowConfirmRequest] :payment_flow_confirm_request 
+    # @option opts [String] :idempotency_key Idempotency key for the request
+    # @option opts [Boolean] :include_http_info If true, returns [data, status_code, headers] instead of just data
+    # @return [PaymentFlowResponse, Array] Returns data or [data, status_code, headers] if include_http_info is true
+    def confirm_payment_flow(payment_flow_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PaymentFlowsApi.confirm_payment_flow ...'
+      end
+      # verify the required parameter 'payment_flow_id' is set
+      if @api_client.config.client_side_validation && payment_flow_id.nil?
+        raise ArgumentError, "Missing the required parameter 'payment_flow_id' when calling PaymentFlowsApi.confirm_payment_flow"
+      end
+      # resource path
+      local_var_path = '/v2/payment_flows/{payment_flow_id}/confirm'.sub('{' + 'payment_flow_id' + '}', CGI.escape(payment_flow_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      header_params['Idempotency-Key'] = opts[:idempotency_key] if opts[:idempotency_key]
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+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[:payment_flow_confirm_request])
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'PaymentFlowResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['HTTPBasic', 'HTTPBearer']
+
+      new_options = opts.merge(
+        :operation => :"PaymentFlowsApi.confirm_payment_flow",
+        :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: PaymentFlowsApi#confirm_payment_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+
+      if opts[:include_http_info]
+        [data, status_code, headers]
+      else
+        data
+      end
+    end
+
+    # Create Payment Flow
+    # @param payment_flow_create_request [PaymentFlowCreateRequest] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key Idempotency key for the request
+    # @option opts [Boolean] :include_http_info If true, returns [data, status_code, headers] instead of just data
+    # @return [PaymentFlowResponse, Array] Returns data or [data, status_code, headers] if include_http_info is true
+    def create_payment_flow(payment_flow_create_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PaymentFlowsApi.create_payment_flow ...'
+      end
+      # verify the required parameter 'payment_flow_create_request' is set
+      if @api_client.config.client_side_validation && payment_flow_create_request.nil?
+        raise ArgumentError, "Missing the required parameter 'payment_flow_create_request' when calling PaymentFlowsApi.create_payment_flow"
+      end
+      # resource path
+      local_var_path = '/v2/payment_flows'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      header_params['Idempotency-Key'] = opts[:idempotency_key] if opts[:idempotency_key]
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+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(payment_flow_create_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'PaymentFlowResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['HTTPBasic', 'HTTPBearer']
+
+      new_options = opts.merge(
+        :operation => :"PaymentFlowsApi.create_payment_flow",
+        :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: PaymentFlowsApi#create_payment_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+
+      if opts[:include_http_info]
+        [data, status_code, headers]
+      else
+        data
+      end
+    end
+
+    # Get All Payment Flows
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :limit 取得するデータの最大件数 (default to 10)
+    # @option opts [String] :starting_after このIDより後のデータを取得
+    # @option opts [String] :ending_before このIDより前のデータを取得
+    # @option opts [String] :customer_id 指定した顧客のデータのみを取得
+    # @option opts [String] :idempotency_key Idempotency key for the request
+    # @option opts [Boolean] :include_http_info If true, returns [data, status_code, headers] instead of just data
+    # @return [PaymentFlowListResponse, Array] Returns data or [data, status_code, headers] if include_http_info is true
+    def get_all_payment_flows(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PaymentFlowsApi.get_all_payment_flows ...'
+      end
+      if @api_client.config.client_side_validation && !opts[:limit].nil? && opts[:limit] > 100
+        raise ArgumentError, 'invalid value for "opts[:limit]" when calling PaymentFlowsApi.get_all_payment_flows, must be smaller than or equal to 100.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:limit].nil? && opts[:limit] < 1
+        raise ArgumentError, 'invalid value for "opts[:limit]" when calling PaymentFlowsApi.get_all_payment_flows, must be greater than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/v2/payment_flows'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:limit] = opts[:limit] if !opts[:limit].nil?
+      query_params[:starting_after] = opts[:starting_after] if !opts[:starting_after].nil?
+      query_params[:ending_before] = opts[:ending_before] if !opts[:ending_before].nil?
+      query_params[:customer_id] = opts[:customer_id] if !opts[:customer_id].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      header_params['Idempotency-Key'] = opts[:idempotency_key] if opts[:idempotency_key]
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+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] || 'PaymentFlowListResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['HTTPBasic', 'HTTPBearer']
+
+      new_options = opts.merge(
+        :operation => :"PaymentFlowsApi.get_all_payment_flows",
+        :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: PaymentFlowsApi#get_all_payment_flows\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+
+      if opts[:include_http_info]
+        [data, status_code, headers]
+      else
+        data
+      end
+    end
+
+    # Get Payment Flow
+    # @param payment_flow_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key Idempotency key for the request
+    # @option opts [Boolean] :include_http_info If true, returns [data, status_code, headers] instead of just data
+    # @return [PaymentFlowResponse, Array] Returns data or [data, status_code, headers] if include_http_info is true
+    def get_payment_flow(payment_flow_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PaymentFlowsApi.get_payment_flow ...'
+      end
+      # verify the required parameter 'payment_flow_id' is set
+      if @api_client.config.client_side_validation && payment_flow_id.nil?
+        raise ArgumentError, "Missing the required parameter 'payment_flow_id' when calling PaymentFlowsApi.get_payment_flow"
+      end
+      # resource path
+      local_var_path = '/v2/payment_flows/{payment_flow_id}'.sub('{' + 'payment_flow_id' + '}', CGI.escape(payment_flow_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      header_params['Idempotency-Key'] = opts[:idempotency_key] if opts[:idempotency_key]
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+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] || 'PaymentFlowResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['HTTPBasic', 'HTTPBearer']
+
+      new_options = opts.merge(
+        :operation => :"PaymentFlowsApi.get_payment_flow",
+        :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: PaymentFlowsApi#get_payment_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+
+      if opts[:include_http_info]
+        [data, status_code, headers]
+      else
+        data
+      end
+    end
+
+    # Get Payment Flow Refunds
+    # Payment Flowに紐づくRefundsをリスト取得する
+    # @param payment_flow_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :limit 取得するデータの最大件数 (default to 10)
+    # @option opts [String] :starting_after このIDより後のデータを取得
+    # @option opts [String] :ending_before このIDより前のデータを取得
+    # @option opts [String] :idempotency_key Idempotency key for the request
+    # @option opts [Boolean] :include_http_info If true, returns [data, status_code, headers] instead of just data
+    # @return [PaymentRefundListResponse, Array] Returns data or [data, status_code, headers] if include_http_info is true
+    def get_payment_flow_refunds(payment_flow_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PaymentFlowsApi.get_payment_flow_refunds ...'
+      end
+      # verify the required parameter 'payment_flow_id' is set
+      if @api_client.config.client_side_validation && payment_flow_id.nil?
+        raise ArgumentError, "Missing the required parameter 'payment_flow_id' when calling PaymentFlowsApi.get_payment_flow_refunds"
+      end
+      if @api_client.config.client_side_validation && !opts[:limit].nil? && opts[:limit] > 100
+        raise ArgumentError, 'invalid value for "opts[:limit]" when calling PaymentFlowsApi.get_payment_flow_refunds, must be smaller than or equal to 100.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:limit].nil? && opts[:limit] < 1
+        raise ArgumentError, 'invalid value for "opts[:limit]" when calling PaymentFlowsApi.get_payment_flow_refunds, must be greater than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/v2/payment_flows/{payment_flow_id}/refunds'.sub('{' + 'payment_flow_id' + '}', CGI.escape(payment_flow_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:limit] = opts[:limit] if !opts[:limit].nil?
+      query_params[:starting_after] = opts[:starting_after] if !opts[:starting_after].nil?
+      query_params[:ending_before] = opts[:ending_before] if !opts[:ending_before].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      header_params['Idempotency-Key'] = opts[:idempotency_key] if opts[:idempotency_key]
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+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] || 'PaymentRefundListResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['HTTPBasic', 'HTTPBearer']
+
+      new_options = opts.merge(
+        :operation => :"PaymentFlowsApi.get_payment_flow_refunds",
+        :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: PaymentFlowsApi#get_payment_flow_refunds\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+
+      if opts[:include_http_info]
+        [data, status_code, headers]
+      else
+        data
+      end
+    end
+
+    # Update Payment Flow
+    # @param payment_flow_id [String] 
+    # @param payment_flow_update_request [PaymentFlowUpdateRequest] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key Idempotency key for the request
+    # @option opts [Boolean] :include_http_info If true, returns [data, status_code, headers] instead of just data
+    # @return [PaymentFlowResponse, Array] Returns data or [data, status_code, headers] if include_http_info is true
+    def update_payment_flow(payment_flow_id, payment_flow_update_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PaymentFlowsApi.update_payment_flow ...'
+      end
+      # verify the required parameter 'payment_flow_id' is set
+      if @api_client.config.client_side_validation && payment_flow_id.nil?
+        raise ArgumentError, "Missing the required parameter 'payment_flow_id' when calling PaymentFlowsApi.update_payment_flow"
+      end
+      # verify the required parameter 'payment_flow_update_request' is set
+      if @api_client.config.client_side_validation && payment_flow_update_request.nil?
+        raise ArgumentError, "Missing the required parameter 'payment_flow_update_request' when calling PaymentFlowsApi.update_payment_flow"
+      end
+      # resource path
+      local_var_path = '/v2/payment_flows/{payment_flow_id}'.sub('{' + 'payment_flow_id' + '}', CGI.escape(payment_flow_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      header_params['Idempotency-Key'] = opts[:idempotency_key] if opts[:idempotency_key]
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+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(payment_flow_update_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'PaymentFlowResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['HTTPBasic', 'HTTPBearer']
+
+      new_options = opts.merge(
+        :operation => :"PaymentFlowsApi.update_payment_flow",
+        :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: PaymentFlowsApi#update_payment_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+
+      if opts[:include_http_info]
+        [data, status_code, headers]
+      else
+        data
+      end
+    end
+  end
+end