payjpv2 1.1.0 → 1.2.0

data/lib/payjpv2/models/payment_flow_create_request.rb

@@ -42,6 +42,9 @@ module PAYJPv2
     # 顧客が支払いを完了後かキャンセルした後にリダイレクトされる URL。アプリにリダイレクトしたい場合は URI Scheme を指定できます。confirm=true の場合のみ指定できます。
     attr_accessor :return_url
 
+    # return_url へリダイレクトする際のオプション
+    attr_accessor :redirect_options
+
     # オブジェクトにセットする任意の文字列。
     attr_accessor :description
 
@@ -82,6 +85,7 @@ module PAYJPv2
         :capture_method => :capture_method,
         :confirm => :confirm,
         :return_url => :return_url,
+        :redirect_options => :redirect_options,
         :description => :description,
         :metadata => :metadata
       }
@@ -109,6 +113,7 @@ module PAYJPv2
         :capture_method => :'CaptureMethod',
         :confirm => :'Boolean',
         :return_url => :'String',
+        :redirect_options => :'RedirectOptionsRequest',
         :description => :'String',
         :metadata => :'Hash<String, MetadataValue>'
       }
@@ -180,6 +185,10 @@ module PAYJPv2
         self.return_url = attributes[:return_url]
       end
 
+      if attributes.key?(:redirect_options)
+        self.redirect_options = attributes[:redirect_options]
+      end
+
       if attributes.key?(:description)
         self.description = attributes[:description]
       end
@@ -233,6 +242,7 @@ module PAYJPv2
           capture_method == o.capture_method &&
           confirm == o.confirm &&
           return_url == o.return_url &&
+          redirect_options == o.redirect_options &&
           description == o.description &&
           metadata == o.metadata
     end
@@ -246,7 +256,7 @@ module PAYJPv2
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [amount, customer_id, payment_method_id, payment_method_options, payment_method_types, currency, capture_method, confirm, return_url, description, metadata].hash
+      [amount, customer_id, payment_method_id, payment_method_options, payment_method_types, currency, capture_method, confirm, return_url, redirect_options, description, metadata].hash
     end
 
     # Builds the object from hash

data/lib/payjpv2/models/payment_flow_response.rb

@@ -54,6 +54,9 @@ module PAYJPv2
 
     attr_accessor :return_url
 
+    # return_url へリダイレクトする際のオプション
+    attr_accessor :redirect_options
+
     # 支払いの確定方法  | 値 | |:---| | **automatic**: (デフォルト) 顧客が支払いを承認すると、自動的に確定させます。 | | **manual**: 顧客が支払いを承認すると一旦確定を保留し、後で Capture API を使用して確定します。（すべての支払い方法がこれをサポートしているわけではありません）。 |
     attr_accessor :capture_method
 
@@ -115,6 +118,7 @@ module PAYJPv2
         :status => :status,
         :next_action => :next_action,
         :return_url => :return_url,
+        :redirect_options => :redirect_options,
         :capture_method => :capture_method,
         :last_payment_error => :last_payment_error,
         :cancellation_reason => :cancellation_reason,
@@ -155,6 +159,7 @@ module PAYJPv2
         :status => :'PaymentFlowStatus',
         :next_action => :'Hash<String, Object>',
         :return_url => :'String',
+        :redirect_options => :'RedirectOptionsResponse',
         :capture_method => :'CaptureMethod',
         :last_payment_error => :'Hash<String, Object>',
         :cancellation_reason => :'PaymentFlowCancellationReason',
@@ -302,6 +307,12 @@ module PAYJPv2
         self.return_url = nil
       end
 
+      if attributes.key?(:redirect_options)
+        self.redirect_options = attributes[:redirect_options]
+      else
+        self.redirect_options = nil
+      end
+
       if attributes.key?(:capture_method)
         self.capture_method = attributes[:capture_method]
       else
@@ -433,6 +444,16 @@ module PAYJPv2
       @status = status
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] redirect_options Value to be assigned
+    def redirect_options=(redirect_options)
+      if redirect_options.nil?
+        raise ArgumentError, 'redirect_options cannot be nil'
+      end
+
+      @redirect_options = redirect_options
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] capture_method Value to be assigned
     def capture_method=(capture_method)
@@ -494,6 +515,7 @@ module PAYJPv2
           status == o.status &&
           next_action == o.next_action &&
           return_url == o.return_url &&
+          redirect_options == o.redirect_options &&
           capture_method == o.capture_method &&
           last_payment_error == o.last_payment_error &&
           cancellation_reason == o.cancellation_reason &&
@@ -513,7 +535,7 @@ module PAYJPv2
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [object, id, livemode, amount, currency, amount_capturable, amount_received, client_secret, customer_id, description, payment_method_id, payment_method_options, payment_method_types, status, next_action, return_url, capture_method, last_payment_error, cancellation_reason, canceled_at, expired_at, metadata, created_at, updated_at].hash
+      [object, id, livemode, amount, currency, amount_capturable, amount_received, client_secret, customer_id, description, payment_method_id, payment_method_options, payment_method_types, status, next_action, return_url, redirect_options, capture_method, last_payment_error, cancellation_reason, canceled_at, expired_at, metadata, created_at, updated_at].hash
     end
 
     # Builds the object from hash

data/lib/payjpv2/models/payment_flow_update_request.rb

@@ -33,6 +33,9 @@ module PAYJPv2
     # 顧客が支払いを完了後かキャンセルした後にリダイレクトされる URL。アプリにリダイレクトしたい場合は URI Scheme を指定できます。
     attr_accessor :return_url
 
+    # return_url へリダイレクトする際のオプション
+    attr_accessor :redirect_options
+
     # オブジェクトにセットする任意の文字列。
     attr_accessor :description
 
@@ -48,6 +51,7 @@ module PAYJPv2
         :payment_method_options => :payment_method_options,
         :payment_method_types => :payment_method_types,
         :return_url => :return_url,
+        :redirect_options => :redirect_options,
         :description => :description,
         :metadata => :metadata
       }
@@ -72,6 +76,7 @@ module PAYJPv2
         :payment_method_options => :'PaymentFlowPaymentMethodOptionsRequest',
         :payment_method_types => :'Array<PaymentMethodTypes>',
         :return_url => :'String',
+        :redirect_options => :'RedirectOptionsRequest',
         :description => :'String',
         :metadata => :'Hash<String, MetadataValue>'
       }
@@ -125,6 +130,10 @@ module PAYJPv2
         self.return_url = attributes[:return_url]
       end
 
+      if attributes.key?(:redirect_options)
+        self.redirect_options = attributes[:redirect_options]
+      end
+
       if attributes.key?(:description)
         self.description = attributes[:description]
       end
@@ -165,6 +174,7 @@ module PAYJPv2
           payment_method_options == o.payment_method_options &&
           payment_method_types == o.payment_method_types &&
           return_url == o.return_url &&
+          redirect_options == o.redirect_options &&
           description == o.description &&
           metadata == o.metadata
     end
@@ -178,7 +188,7 @@ module PAYJPv2
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [amount, customer_id, payment_method_id, payment_method_options, payment_method_types, return_url, description, metadata].hash
+      [amount, customer_id, payment_method_id, payment_method_options, payment_method_types, return_url, redirect_options, description, metadata].hash
     end
 
     # Builds the object from hash

data/lib/payjpv2/models/redirect_options_request.rb

@@ -0,0 +1,206 @@
+=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 'date'
+require 'time'
+
+module PAYJPv2
+  class RedirectOptionsRequest
+    # return_url へリダイレクトする際、クエリパラメーターに client_secret を付与するかどうか。デフォルトは `true` です。
+    attr_accessor :include_client_secret
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :include_client_secret => :include_client_secret
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :include_client_secret => :'Boolean'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        raise ArgumentError, "The input argument (attributes) must be a hash in `PAYJPv2::RedirectOptionsRequest` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          raise ArgumentError, "`#{k}` is not a valid attribute in `PAYJPv2::RedirectOptionsRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:include_client_secret)
+        self.include_client_secret = attributes[:include_client_secret]
+      end
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          include_client_secret == o.include_client_secret
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [include_client_secret].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = PAYJPv2.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end

data/lib/payjpv2/models/redirect_options_response.rb

@@ -0,0 +1,208 @@
+=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 'date'
+require 'time'
+
+module PAYJPv2
+  class RedirectOptionsResponse
+    # return_url へリダイレクトする際、クエリパラメーターに client_secret を付与するかどうか。デフォルトは `true` です。
+    attr_accessor :include_client_secret
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :include_client_secret => :include_client_secret
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :include_client_secret => :'Boolean'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        raise ArgumentError, "The input argument (attributes) must be a hash in `PAYJPv2::RedirectOptionsResponse` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          raise ArgumentError, "`#{k}` is not a valid attribute in `PAYJPv2::RedirectOptionsResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:include_client_secret)
+        self.include_client_secret = attributes[:include_client_secret]
+      else
+        self.include_client_secret = true
+      end
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          include_client_secret == o.include_client_secret
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [include_client_secret].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = PAYJPv2.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end

data/lib/payjpv2/models/setup_flow_cancel_request.rb

@@ -15,7 +15,7 @@ require 'time'
 
 module PAYJPv2
   class SetupFlowCancelRequest
-    # この SetupFlow のキャンセル理由。  | 値 | |:---| | **abandoned**: 顧客が SetupFlow を完了しなかった場合。 | | **requested_by_customer**: 顧客がキャンセルを要求した場合。 | | **duplicate**: 支払い方法が重複している場合。 |
+    # この SetupFlow のキャンセル理由。  | 値 | |:---| | **abandoned**: 顧客が SetupFlow を完了しなかった場合。 | | **requested_by_customer**: 顧客がキャンセルを要求した場合。 | | **duplicate**: 支払い方法が重複している場合。 |  `expired` はシステムが自動的に設定する値のため、リクエストでは指定できません。
     attr_accessor :cancellation_reason
 
     class EnumAttributeValidator

data/lib/payjpv2/models/setup_flow_cancellation_reason.rb

@@ -17,10 +17,11 @@ module PAYJPv2
   class SetupFlowCancellationReason
     ABANDONED = "abandoned".freeze
     DUPLICATE = "duplicate".freeze
+    EXPIRED = "expired".freeze
     REQUESTED_BY_CUSTOMER = "requested_by_customer".freeze
 
     def self.all_vars
-      @all_vars ||= [ABANDONED, DUPLICATE, REQUESTED_BY_CUSTOMER].freeze
+      @all_vars ||= [ABANDONED, DUPLICATE, EXPIRED, REQUESTED_BY_CUSTOMER].freeze
     end
 
     # Builds the enum from string

data/lib/payjpv2/models/setup_flow_create_request.rb

@@ -27,6 +27,9 @@ module PAYJPv2
     # 支払い方法が今後どのように使用されるかを指定します。指定されていない場合、この値はデフォルトで `off_session` になります。  | 値 | |:---| | **off_session**: 定期課金など、顧客がカートなどの決済フローにいるかどうか不明な場合は `off_session` を使用してください。 | | **on_session**: 顧客がカートなどの決済フローにいる場合にのみ支払い方法を利用する場合は `on_session` を使用してください。 |
     attr_accessor :usage
 
+    # return_url へリダイレクトする際のオプション
+    attr_accessor :redirect_options
+
     # 説明。
     attr_accessor :description
 
@@ -62,6 +65,7 @@ module PAYJPv2
         :payment_method_options => :payment_method_options,
         :payment_method_types => :payment_method_types,
         :usage => :usage,
+        :redirect_options => :redirect_options,
         :description => :description,
         :metadata => :metadata
       }
@@ -84,6 +88,7 @@ module PAYJPv2
         :payment_method_options => :'SetupFlowPaymentMethodOptionsRequest',
         :payment_method_types => :'Array<String>',
         :usage => :'Usage',
+        :redirect_options => :'RedirectOptionsRequest',
         :description => :'String',
         :metadata => :'Hash<String, MetadataValue>'
       }
@@ -129,6 +134,10 @@ module PAYJPv2
         self.usage = attributes[:usage]
       end
 
+      if attributes.key?(:redirect_options)
+        self.redirect_options = attributes[:redirect_options]
+      end
+
       if attributes.key?(:description)
         self.description = attributes[:description]
       end
@@ -149,6 +158,7 @@ module PAYJPv2
           payment_method_options == o.payment_method_options &&
           payment_method_types == o.payment_method_types &&
           usage == o.usage &&
+          redirect_options == o.redirect_options &&
           description == o.description &&
           metadata == o.metadata
     end
@@ -162,7 +172,7 @@ module PAYJPv2
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [customer_id, payment_method_options, payment_method_types, usage, description, metadata].hash
+      [customer_id, payment_method_options, payment_method_types, usage, redirect_options, description, metadata].hash
     end
 
     # Builds the object from hash