payjpv2 1.0.2

data/lib/payjpv2/models/payment_flow_response.rb

@@ -0,0 +1,623 @@
+=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 PaymentFlowResponse
+    attr_accessor :object
+
+    # 支払いフロー ID
+    attr_accessor :id
+
+    # 本番環境かどうか
+    attr_accessor :livemode
+
+    # 支払い予定の金額
+    attr_accessor :amount
+
+    # 価格の通貨。現在は `jpy` のみサポートしています。
+    attr_accessor :currency
+
+    attr_accessor :amount_capturable
+
+    attr_accessor :amount_received
+
+    # この PaymentFlow のクライアントシークレットです。フロントエンドで公開 API キーと合わせて使用し PaymentFlow の情報を取得や支払い処理を行います。**この値はこの PaymentFlow の支払いを行う顧客以外へ公開しないでください。**また保存やログへの記録なども行わないでください。
+    attr_accessor :client_secret
+
+    attr_accessor :customer_id
+
+    attr_accessor :description
+
+    attr_accessor :payment_method_id
+
+    attr_accessor :payment_method_options
+
+    # この PaymentFlow で使用できる支払い方法の種類のリスト
+    attr_accessor :payment_method_types
+
+    # この PaymentFlow のステータス。<a href=\"https://docs.pay.jp/v2/payment_flows#status\" target=\"_blank\">ステータスの詳細についてはこちらをご覧ください。</a>  | 値 | |:---| | **requires_payment_method**: 支払い方法が必要です。 | | **requires_confirmation**: 確認が必要です。 | | **requires_action**: 顧客のアクションが必要です。 | | **processing**: 処理中です。 | | **requires_capture**: 確定が必要です。 | | **canceled**: キャンセルされました。 | | **succeeded**: 成功しました。 |
+    attr_accessor :status
+
+    attr_accessor :next_action
+
+    attr_accessor :return_url
+
+    # 支払いの確定方法  | 値 | |:---| | **automatic**: (デフォルト) 顧客が支払いを承認すると、自動的に確定させます。 | | **manual**: 顧客が支払いを承認すると一旦確定を保留し、後で Capture API を使用して確定します。（すべての支払い方法がこれをサポートしているわけではありません）。 |
+    attr_accessor :capture_method
+
+    attr_accessor :last_payment_error
+
+    attr_accessor :cancellation_reason
+
+    attr_accessor :canceled_at
+
+    # メタデータ
+    attr_accessor :metadata
+
+    # 作成日時 (UTC, ISO 8601 形式)
+    attr_accessor :created_at
+
+    # 更新日時 (UTC, ISO 8601 形式)
+    attr_accessor :updated_at
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :object => :object,
+        :id => :id,
+        :livemode => :livemode,
+        :amount => :amount,
+        :currency => :currency,
+        :amount_capturable => :amount_capturable,
+        :amount_received => :amount_received,
+        :client_secret => :client_secret,
+        :customer_id => :customer_id,
+        :description => :description,
+        :payment_method_id => :payment_method_id,
+        :payment_method_options => :payment_method_options,
+        :payment_method_types => :payment_method_types,
+        :status => :status,
+        :next_action => :next_action,
+        :return_url => :return_url,
+        :capture_method => :capture_method,
+        :last_payment_error => :last_payment_error,
+        :cancellation_reason => :cancellation_reason,
+        :canceled_at => :canceled_at,
+        :metadata => :metadata,
+        :created_at => :created_at,
+        :updated_at => :updated_at
+      }
+    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
+      {
+        :object => :'String',
+        :id => :'String',
+        :livemode => :'Boolean',
+        :amount => :'Integer',
+        :currency => :'Currency',
+        :amount_capturable => :'Integer',
+        :amount_received => :'Integer',
+        :client_secret => :'String',
+        :customer_id => :'String',
+        :description => :'String',
+        :payment_method_id => :'String',
+        :payment_method_options => :'Hash<String, Object>',
+        :payment_method_types => :'Array<PaymentMethodTypes>',
+        :status => :'PaymentFlowStatus',
+        :next_action => :'Hash<String, Object>',
+        :return_url => :'String',
+        :capture_method => :'CaptureMethod',
+        :last_payment_error => :'Hash<String, Object>',
+        :cancellation_reason => :'PaymentFlowCancellationReason',
+        :canceled_at => :'Time',
+        :metadata => :'Hash<String, MetadataValue>',
+        :created_at => :'Time',
+        :updated_at => :'Time'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :amount_capturable,
+        :amount_received,
+        :customer_id,
+        :description,
+        :payment_method_id,
+        :payment_method_options,
+        :next_action,
+        :return_url,
+        :last_payment_error,
+        :cancellation_reason,
+        :canceled_at,
+      ])
+    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::PaymentFlowResponse` 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::PaymentFlowResponse`. 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?(:object)
+        self.object = attributes[:object]
+      else
+        self.object = 'payment_flow'
+      end
+
+      if attributes.key?(:id)
+        self.id = attributes[:id]
+      else
+        self.id = nil
+      end
+
+      if attributes.key?(:livemode)
+        self.livemode = attributes[:livemode]
+      else
+        self.livemode = nil
+      end
+
+      if attributes.key?(:amount)
+        self.amount = attributes[:amount]
+      else
+        self.amount = nil
+      end
+
+      if attributes.key?(:currency)
+        self.currency = attributes[:currency]
+      else
+        self.currency = nil
+      end
+
+      if attributes.key?(:amount_capturable)
+        self.amount_capturable = attributes[:amount_capturable]
+      else
+        self.amount_capturable = nil
+      end
+
+      if attributes.key?(:amount_received)
+        self.amount_received = attributes[:amount_received]
+      else
+        self.amount_received = nil
+      end
+
+      if attributes.key?(:client_secret)
+        self.client_secret = attributes[:client_secret]
+      else
+        self.client_secret = nil
+      end
+
+      if attributes.key?(:customer_id)
+        self.customer_id = attributes[:customer_id]
+      else
+        self.customer_id = nil
+      end
+
+      if attributes.key?(:description)
+        self.description = attributes[:description]
+      else
+        self.description = nil
+      end
+
+      if attributes.key?(:payment_method_id)
+        self.payment_method_id = attributes[:payment_method_id]
+      else
+        self.payment_method_id = nil
+      end
+
+      if attributes.key?(:payment_method_options)
+        if (value = attributes[:payment_method_options]).is_a?(Hash)
+          self.payment_method_options = value
+        end
+      else
+        self.payment_method_options = nil
+      end
+
+      if attributes.key?(:payment_method_types)
+        if (value = attributes[:payment_method_types]).is_a?(Array)
+          self.payment_method_types = value
+        end
+      else
+        self.payment_method_types = nil
+      end
+
+      if attributes.key?(:status)
+        self.status = attributes[:status]
+      else
+        self.status = nil
+      end
+
+      if attributes.key?(:next_action)
+        if (value = attributes[:next_action]).is_a?(Hash)
+          self.next_action = value
+        end
+      else
+        self.next_action = nil
+      end
+
+      if attributes.key?(:return_url)
+        self.return_url = attributes[:return_url]
+      else
+        self.return_url = nil
+      end
+
+      if attributes.key?(:capture_method)
+        self.capture_method = attributes[:capture_method]
+      else
+        self.capture_method = nil
+      end
+
+      if attributes.key?(:last_payment_error)
+        if (value = attributes[:last_payment_error]).is_a?(Hash)
+          self.last_payment_error = value
+        end
+      else
+        self.last_payment_error = nil
+      end
+
+      if attributes.key?(:cancellation_reason)
+        self.cancellation_reason = attributes[:cancellation_reason]
+      else
+        self.cancellation_reason = nil
+      end
+
+      if attributes.key?(:canceled_at)
+        self.canceled_at = attributes[:canceled_at]
+      else
+        self.canceled_at = nil
+      end
+
+      if attributes.key?(:metadata)
+        if (value = attributes[:metadata]).is_a?(Hash)
+          self.metadata = value
+        end
+      else
+        self.metadata = nil
+      end
+
+      if attributes.key?(:created_at)
+        self.created_at = attributes[:created_at]
+      else
+        self.created_at = nil
+      end
+
+      if attributes.key?(:updated_at)
+        self.updated_at = attributes[:updated_at]
+      else
+        self.updated_at = nil
+      end
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] object Object to be assigned
+    def object=(object)
+      validator = EnumAttributeValidator.new('String', ["payment_flow"])
+      unless validator.valid?(object)
+        raise ArgumentError, "invalid value for \"object\", must be one of #{validator.allowable_values}."
+      end
+      @object = object
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] id Value to be assigned
+    def id=(id)
+      if id.nil?
+        raise ArgumentError, 'id cannot be nil'
+      end
+
+      @id = id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] livemode Value to be assigned
+    def livemode=(livemode)
+      if livemode.nil?
+        raise ArgumentError, 'livemode cannot be nil'
+      end
+
+      @livemode = livemode
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] amount Value to be assigned
+    def amount=(amount)
+      if amount.nil?
+        raise ArgumentError, 'amount cannot be nil'
+      end
+
+      @amount = amount
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] currency Value to be assigned
+    def currency=(currency)
+      if currency.nil?
+        raise ArgumentError, 'currency cannot be nil'
+      end
+
+      @currency = currency
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] client_secret Value to be assigned
+    def client_secret=(client_secret)
+      if client_secret.nil?
+        raise ArgumentError, 'client_secret cannot be nil'
+      end
+
+      @client_secret = client_secret
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] payment_method_types Value to be assigned
+    def payment_method_types=(payment_method_types)
+      if payment_method_types.nil?
+        raise ArgumentError, 'payment_method_types cannot be nil'
+      end
+
+      @payment_method_types = payment_method_types
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] status Value to be assigned
+    def status=(status)
+      if status.nil?
+        raise ArgumentError, 'status cannot be nil'
+      end
+
+      @status = status
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] capture_method Value to be assigned
+    def capture_method=(capture_method)
+      if capture_method.nil?
+        raise ArgumentError, 'capture_method cannot be nil'
+      end
+
+      @capture_method = capture_method
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] metadata Value to be assigned
+    def metadata=(metadata)
+      if metadata.nil?
+        raise ArgumentError, 'metadata cannot be nil'
+      end
+
+      @metadata = metadata
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] created_at Value to be assigned
+    def created_at=(created_at)
+      if created_at.nil?
+        raise ArgumentError, 'created_at cannot be nil'
+      end
+
+      @created_at = created_at
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] updated_at Value to be assigned
+    def updated_at=(updated_at)
+      if updated_at.nil?
+        raise ArgumentError, 'updated_at cannot be nil'
+      end
+
+      @updated_at = updated_at
+    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 &&
+          object == o.object &&
+          id == o.id &&
+          livemode == o.livemode &&
+          amount == o.amount &&
+          currency == o.currency &&
+          amount_capturable == o.amount_capturable &&
+          amount_received == o.amount_received &&
+          client_secret == o.client_secret &&
+          customer_id == o.customer_id &&
+          description == o.description &&
+          payment_method_id == o.payment_method_id &&
+          payment_method_options == o.payment_method_options &&
+          payment_method_types == o.payment_method_types &&
+          status == o.status &&
+          next_action == o.next_action &&
+          return_url == o.return_url &&
+          capture_method == o.capture_method &&
+          last_payment_error == o.last_payment_error &&
+          cancellation_reason == o.cancellation_reason &&
+          canceled_at == o.canceled_at &&
+          metadata == o.metadata &&
+          created_at == o.created_at &&
+          updated_at == o.updated_at
+    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
+      [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, metadata, created_at, updated_at].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/payment_flow_status.rb

@@ -0,0 +1,45 @@
+=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 PaymentFlowStatus
+    CANCELED = "canceled".freeze
+    PROCESSING = "processing".freeze
+    REQUIRES_ACTION = "requires_action".freeze
+    REQUIRES_CAPTURE = "requires_capture".freeze
+    REQUIRES_CONFIRMATION = "requires_confirmation".freeze
+    REQUIRES_PAYMENT_METHOD = "requires_payment_method".freeze
+    SUCCEEDED = "succeeded".freeze
+
+    def self.all_vars
+      @all_vars ||= [CANCELED, PROCESSING, REQUIRES_ACTION, REQUIRES_CAPTURE, REQUIRES_CONFIRMATION, REQUIRES_PAYMENT_METHOD, SUCCEEDED].freeze
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      return value if PaymentFlowStatus.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #PaymentFlowStatus"
+    end
+  end
+end