payjpv2 1.0.2

data/lib/payjpv2/models/card_config_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 CardConfigRequest
+    attr_accessor :display_preference
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :display_preference => :display_preference
+      }
+    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
+      {
+        :display_preference => :'DisplayPreferenceRequest'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :display_preference
+      ])
+    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::CardConfigRequest` 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::CardConfigRequest`. 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?(:display_preference)
+        self.display_preference = attributes[:display_preference]
+      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 &&
+          display_preference == o.display_preference
+    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
+      [display_preference].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/checkout_session_create_request.rb

@@ -0,0 +1,430 @@
+=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 CheckoutSessionCreateRequest
+    # Checkout Session のモード  | 指定できる値 | |:---| | **payment**: 支払いモードで Checkout Session を作成します。 | | **setup**: セットアップモードで Checkout Session を作成します。 |
+    attr_accessor :mode
+
+    # ID
+    attr_accessor :client_reference_id
+
+    # 顧客 ID
+    attr_accessor :customer_id
+
+    # 顧客オブジェクトを作成する時に使われます。指定されていない場合、顧客にメールアドレスの入力を求めます。すでに顧客のメールアドレスを持っている場合は、このパラメータを使ってあらかじめ情報を入力しておくことが可能です。
+    attr_accessor :customer_email
+
+    # Checkout Session の確定時に Customer を作成するかどうかを指定します。<br> `payment` および `setup` モードでのみ設定可能です。
+    attr_accessor :customer_creation
+
+    # 顧客が購入する商品のリストです。このパラメーターを使用して、1回限りまたは定期的な料金を渡します。  `payment` モードの場合、最大100個のラインアイテムを使用できます。
+    attr_accessor :line_items
+
+    # キーバリューの任意のデータを格納できます。20件まで登録可能で、空文字列を指定するとそのキーを削除できます。<a href=\"https://docs.pay.jp/v2/guide/developers/metadata\">詳細はメタデータのドキュメントを参照してください。</a>
+    attr_accessor :metadata
+
+    # 支払いや設定が完了した際に、PAY.JP が顧客をリダイレクトする URL。成功した Checkout Session からの情報をページで使用したい場合は、成功ページのカスタマイズに関するガイドをお読みください。
+    attr_accessor :success_url
+
+    # キャンセル時のリダイレクト URL
+    attr_accessor :cancel_url
+
+    # 価格の通貨。現在は `jpy` のみサポートしています。
+    attr_accessor :currency
+
+    # Checkout Session の有効期限が失効する日時
+    attr_accessor :expires_at
+
+    # Checkout 画面の表示言語を指定します。  | 指定できる値 | |:---| | **ja**: 日本語で表示します。 |
+    attr_accessor :locale
+
+    # この PaymentFlow で使用できる支払い方法の種類（カードなど）のリストです。指定しない場合、管理画面で利用可能な状態にしている支払い方法を自動的に表示します。
+    attr_accessor :payment_method_types
+
+    # この PaymentFlow の支払い方法の個別設定
+    attr_accessor :payment_method_options
+
+    # `payment` モード指定時に PaymentFlow 作成に使用するパラメーター
+    attr_accessor :payment_flow_data
+
+    # Checkout の画面上に表示される送信ボタンなど、ページ上の関連テキストをカスタマイズするために使用されます。<br> `submit_type` は、`payment` モードの Checkout Session でのみ指定できます。未指定時、あるいは `auto` の場合、`pay` が使用されます。  | 指定できる値 | |:---| | **auto**: `pay` が使用されます。 | | **pay**: 「支払う」（デフォルト） | | **book**: 「予約する」 | | **donate**: 「寄付する」 |
+    attr_accessor :submit_type
+
+    # `setup` モードの Checkout Session を作成する際、SetupFlow の作成に渡されるパラメーター
+    attr_accessor :setup_flow_data
+
+    # Checkout Session の UI モード。デフォルトは `hosted` です。  | 指定できる値 | |:---| | **hosted**: PAY.JP でホスティングしている画面を使用します。 |
+    attr_accessor :ui_mode
+
+    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
+      {
+        :mode => :mode,
+        :client_reference_id => :client_reference_id,
+        :customer_id => :customer_id,
+        :customer_email => :customer_email,
+        :customer_creation => :customer_creation,
+        :line_items => :line_items,
+        :metadata => :metadata,
+        :success_url => :success_url,
+        :cancel_url => :cancel_url,
+        :currency => :currency,
+        :expires_at => :expires_at,
+        :locale => :locale,
+        :payment_method_types => :payment_method_types,
+        :payment_method_options => :payment_method_options,
+        :payment_flow_data => :payment_flow_data,
+        :submit_type => :submit_type,
+        :setup_flow_data => :setup_flow_data,
+        :ui_mode => :ui_mode
+      }
+    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
+      {
+        :mode => :'CheckoutSessionMode',
+        :client_reference_id => :'String',
+        :customer_id => :'String',
+        :customer_email => :'String',
+        :customer_creation => :'CustomerCreation',
+        :line_items => :'Array<LineItemRequest>',
+        :metadata => :'Hash<String, MetadataValue>',
+        :success_url => :'String',
+        :cancel_url => :'String',
+        :currency => :'Currency',
+        :expires_at => :'Time',
+        :locale => :'Locale',
+        :payment_method_types => :'Array<PaymentMethodTypes>',
+        :payment_method_options => :'CheckoutSessionPaymentMethodOptionsRequest',
+        :payment_flow_data => :'PaymentFlowDataRequest',
+        :submit_type => :'CheckoutSessionSubmitType',
+        :setup_flow_data => :'SetupFlowDataRequest',
+        :ui_mode => :'CheckoutSessionUIMode'
+      }
+    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::CheckoutSessionCreateRequest` 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::CheckoutSessionCreateRequest`. 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?(:mode)
+        self.mode = attributes[:mode]
+      else
+        self.mode = nil
+      end
+
+      if attributes.key?(:client_reference_id)
+        self.client_reference_id = attributes[:client_reference_id]
+      end
+
+      if attributes.key?(:customer_id)
+        self.customer_id = attributes[:customer_id]
+      end
+
+      if attributes.key?(:customer_email)
+        self.customer_email = attributes[:customer_email]
+      end
+
+      if attributes.key?(:customer_creation)
+        self.customer_creation = attributes[:customer_creation]
+      end
+
+      if attributes.key?(:line_items)
+        if (value = attributes[:line_items]).is_a?(Array)
+          self.line_items = value
+        end
+      end
+
+      if attributes.key?(:metadata)
+        if (value = attributes[:metadata]).is_a?(Hash)
+          self.metadata = value
+        end
+      end
+
+      if attributes.key?(:success_url)
+        self.success_url = attributes[:success_url]
+      end
+
+      if attributes.key?(:cancel_url)
+        self.cancel_url = attributes[:cancel_url]
+      end
+
+      if attributes.key?(:currency)
+        self.currency = attributes[:currency]
+      end
+
+      if attributes.key?(:expires_at)
+        self.expires_at = attributes[:expires_at]
+      end
+
+      if attributes.key?(:locale)
+        self.locale = attributes[:locale]
+      end
+
+      if attributes.key?(:payment_method_types)
+        if (value = attributes[:payment_method_types]).is_a?(Array)
+          self.payment_method_types = value
+        end
+      end
+
+      if attributes.key?(:payment_method_options)
+        self.payment_method_options = attributes[:payment_method_options]
+      end
+
+      if attributes.key?(:payment_flow_data)
+        self.payment_flow_data = attributes[:payment_flow_data]
+      end
+
+      if attributes.key?(:submit_type)
+        self.submit_type = attributes[:submit_type]
+      end
+
+      if attributes.key?(:setup_flow_data)
+        self.setup_flow_data = attributes[:setup_flow_data]
+      end
+
+      if attributes.key?(:ui_mode)
+        self.ui_mode = attributes[:ui_mode]
+      end
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] mode Value to be assigned
+    def mode=(mode)
+      if mode.nil?
+        raise ArgumentError, 'mode cannot be nil'
+      end
+
+      @mode = mode
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] line_items Value to be assigned
+    def line_items=(line_items)
+      if line_items.nil?
+        raise ArgumentError, 'line_items cannot be nil'
+      end
+
+      if line_items.length > 100
+        raise ArgumentError, 'invalid value for "line_items", number of items must be less than or equal to 100.'
+      end
+
+      @line_items = line_items
+    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 &&
+          mode == o.mode &&
+          client_reference_id == o.client_reference_id &&
+          customer_id == o.customer_id &&
+          customer_email == o.customer_email &&
+          customer_creation == o.customer_creation &&
+          line_items == o.line_items &&
+          metadata == o.metadata &&
+          success_url == o.success_url &&
+          cancel_url == o.cancel_url &&
+          currency == o.currency &&
+          expires_at == o.expires_at &&
+          locale == o.locale &&
+          payment_method_types == o.payment_method_types &&
+          payment_method_options == o.payment_method_options &&
+          payment_flow_data == o.payment_flow_data &&
+          submit_type == o.submit_type &&
+          setup_flow_data == o.setup_flow_data &&
+          ui_mode == o.ui_mode
+    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
+      [mode, client_reference_id, customer_id, customer_email, customer_creation, line_items, metadata, success_url, cancel_url, currency, expires_at, locale, payment_method_types, payment_method_options, payment_flow_data, submit_type, setup_flow_data, ui_mode].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