cybersource_rest_client 0.0.22 → 0.0.24

data/lib/cybersource_rest_client/models/ptsv2payments_travel_information_auto_rental_tax_details.rb

@@ -0,0 +1,309 @@
+=begin
+#CyberSource Merged Spec
+
+#All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html
+
+OpenAPI spec version: 0.0.1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.2.3
+
+=end
+
+require 'date'
+
+module CyberSource
+  class Ptsv2paymentsTravelInformationAutoRentalTaxDetails
+    # Indicates the amount of tax based on the `type` field as described in the table below: 
+    attr_accessor :amount
+
+    # Rate of VAT or other tax for the order.  Example 0.040 (=4%)  Valid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional decimal places will be truncated) 
+    attr_accessor :rate
+
+    # Flag that indicates whether the tax amount (`travelInformation.autoRental.taxDetails.amount`) is included in the request.  Possible values: - `false`: tax amount is not included in the request. - `true`:  tax amount is included in the request. 
+    attr_accessor :applied
+
+    # Status code for exemption from sales and use tax. This field is a pass-through, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. 
+    attr_accessor :exemption_code
+
+    # Different taxes the rental agency applies to the rental agreement such as tourist tax, airport tax, or rental tax. 
+    attr_accessor :tax_type
+
+    # Summary of all tax types 
+    attr_accessor :tax_summary
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'amount' => :'amount',
+        :'rate' => :'rate',
+        :'applied' => :'applied',
+        :'exemption_code' => :'exemptionCode',
+        :'tax_type' => :'taxType',
+        :'tax_summary' => :'taxSummary'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'amount' => :'String',
+        :'rate' => :'String',
+        :'applied' => :'BOOLEAN',
+        :'exemption_code' => :'String',
+        :'tax_type' => :'String',
+        :'tax_summary' => :'String'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'amount')
+        self.amount = attributes[:'amount']
+      end
+
+      if attributes.has_key?(:'rate')
+        self.rate = attributes[:'rate']
+      end
+
+      if attributes.has_key?(:'applied')
+        self.applied = attributes[:'applied']
+      end
+
+      if attributes.has_key?(:'exemptionCode')
+        self.exemption_code = attributes[:'exemptionCode']
+      end
+
+      if attributes.has_key?(:'taxType')
+        self.tax_type = attributes[:'taxType']
+      end
+
+      if attributes.has_key?(:'taxSummary')
+        self.tax_summary = attributes[:'taxSummary']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      if !@amount.nil? && @amount.to_s.length > 13
+        invalid_properties.push('invalid value for "amount", the character length must be smaller than or equal to 13.')
+      end
+
+      if !@rate.nil? && @rate.to_s.length > 6
+        invalid_properties.push('invalid value for "rate", the character length must be smaller than or equal to 6.')
+      end
+
+      if !@exemption_code.nil? && @exemption_code.to_s.length > 1
+        invalid_properties.push('invalid value for "exemption_code", the character length must be smaller than or equal to 1.')
+      end
+
+      if !@tax_type.nil? && @tax_type.to_s.length > 10
+        invalid_properties.push('invalid value for "tax_type", the character length must be smaller than or equal to 10.')
+      end
+
+      if !@tax_summary.nil? && @tax_summary.to_s.length > 12
+        invalid_properties.push('invalid value for "tax_summary", the character length must be smaller than or equal to 12.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      return false if !@amount.nil? && @amount.to_s.length > 13
+      return false if !@rate.nil? && @rate.to_s.length > 6
+      return false if !@exemption_code.nil? && @exemption_code.to_s.length > 1
+      return false if !@tax_type.nil? && @tax_type.to_s.length > 10
+      return false if !@tax_summary.nil? && @tax_summary.to_s.length > 12
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] amount Value to be assigned
+    def amount=(amount)
+      if !amount.nil? && amount.to_s.length > 13
+        fail ArgumentError, 'invalid value for "amount", the character length must be smaller than or equal to 13.'
+      end
+
+      @amount = amount
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] rate Value to be assigned
+    def rate=(rate)
+      if !rate.nil? && rate.to_s.length > 6
+        fail ArgumentError, 'invalid value for "rate", the character length must be smaller than or equal to 6.'
+      end
+
+      @rate = rate
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] exemption_code Value to be assigned
+    def exemption_code=(exemption_code)
+      if !exemption_code.nil? && exemption_code.to_s.length > 1
+        fail ArgumentError, 'invalid value for "exemption_code", the character length must be smaller than or equal to 1.'
+      end
+
+      @exemption_code = exemption_code
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] tax_type Value to be assigned
+    def tax_type=(tax_type)
+      if !tax_type.nil? && tax_type.to_s.length > 10
+        fail ArgumentError, 'invalid value for "tax_type", the character length must be smaller than or equal to 10.'
+      end
+
+      @tax_type = tax_type
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] tax_summary Value to be assigned
+    def tax_summary=(tax_summary)
+      if !tax_summary.nil? && tax_summary.to_s.length > 12
+        fail ArgumentError, 'invalid value for "tax_summary", the character length must be smaller than or equal to 12.'
+      end
+
+      @tax_summary = tax_summary
+    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 &&
+          amount == o.amount &&
+          rate == o.rate &&
+          applied == o.applied &&
+          exemption_code == o.exemption_code &&
+          tax_type == o.tax_type &&
+          tax_summary == o.tax_summary
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [amount, rate, applied, exemption_code, tax_type, tax_summary].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.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
+        temp_model = CyberSource.const_get(type).new
+        temp_model.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)
+        next if value.nil?
+        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/cybersource_rest_client/models/ptsv2payments_travel_information_lodging.rb

@@ -14,10 +14,10 @@ require 'date'
 
 module CyberSource
   class Ptsv2paymentsTravelInformationLodging
-    # Date on which the guest checked in. In the case of a no-show or a reservation, the scheduled arrival date. Format: MMDDYY. For best interchange rates, make sure it is a valid date. 
+    # Date on which the guest checked in. In the case of a no-show or a reservation, the scheduled arrival date. Format: `MMDDYY`. For best interchange rates, make sure it is a valid date. 
     attr_accessor :check_in_date
 
-    # Date on which the guest checked out. Format: MMDDYY. For best interchange rates, make sure it is a valid date. 
+    # Date on which the guest checked out. Format: `MMDDYY`. For best interchange rates, make sure it is a valid date. 
     attr_accessor :check_out_date
 
     # The object containing the number of nights and the daily rate that applies for that no of nights. 

data/lib/cybersource_rest_client/models/ptsv2payments_travel_information_lodging_room.rb

@@ -17,7 +17,7 @@ module CyberSource
     # Daily cost of the room. 
     attr_accessor :daily_rate
 
-    # Number of nights billed at the rate specified by lodging_daily_room_rate_1. 
+    # Number of nights billed at the rate specified by `travelInformation.lodging.room[].dailyRate`. 
     attr_accessor :number_of_nights
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/cybersource_rest_client/models/ptsv2payments_travel_information_transit_airline.rb

@@ -17,39 +17,39 @@ module CyberSource
     # Reference number for the airline booking. Required if ticket numbers are not issued. 
     attr_accessor :booking_reference_number
 
-    # Name of the airline. If you do not include this field, CyberSource uses the value for your merchant name that is in the CyberSource merchant configuration database. 
+    # Airline that generated the ticket. Format: English characters only. Optional request field. 
     attr_accessor :carrier_name
 
     attr_accessor :ticket_issuer
 
-    # Ticket number. Format: English characters only 
+    # Ticket number. Format: English characters only. Restricted string data type that indicates a sequence of letters, numbers, and spaces; special characters are not included. Optional request field. 
     attr_accessor :ticket_number
 
     # Check digit for the ticket number. CyberSource recommends that you validate the check digit. With Discover and Diners Club, a valid ticket number has these characteristics: - The value is numeric. - The first three digits are a valid IATA2 license plate carrier code. - The last digit is a check digit or zero (0). - All remaining digits are nonzero. 
     attr_accessor :check_digit
 
-    # Flag that indicates whether or not the ticket is restricted (nonrefundable). Possible values: - 0: No restriction (refundable) - 1: Restricted (nonrefundable) 
+    # Flag that indicates whether or not the ticket is restricted (nonrefundable). Possible values: - 0: No restriction (refundable) - 1: Restricted (nonrefundable) Format: English characters only. Restricted string data type that indicates a sequence of letters, numbers, and spaces; special characters are not included. Optional request field. 
     attr_accessor :restricted_ticket_indicator
 
     # Type of charge. Possible values: - 01: Charge is for an airline ticket - 02: Charge is for an item that is not an airline ticket 
     attr_accessor :transaction_type
 
-    # Airline process identifier. This value is the airline’s three-digit IATA1 code which is used to process extended payment airline tickets.. 
+    # The field is not currently supported. 
     attr_accessor :extended_payment_code
 
-    # Name of the passenger to whom the ticket was issued. This will always be a single passenger's name. If there are more than one passengers, provide only the primary passenger's name. Do not include special characters such as commas, hyphens, or apostrophes. Only ASCII characters are supported. 
+    # Name of the passenger to whom the ticket was issued.  This will always be a single passenger's name. If there are more than one passengers, provide only the primary passenger's name. Do not include special characters such as commas, hyphens, or apostrophes. Only ASCII characters are supported. Format: English characters only. Optional request field. 
     attr_accessor :passenger_name
 
-    # 1.Reference number or code that identifies the cardholder. 2. Code provided by the cardholder. 3. Address of the ticket issuer. The first 13 characters will appear onthe cardholder’s statement. 4. Customer reference. 
+    # Reference number or code that identifies the cardholder. Format: English characters only. Restricted string data type that indicates a sequence of letters, numbers, and spaces; special characters are not included. Optional request field. 
     attr_accessor :customer_code
 
-    # Airline document type code that specifies the purpose of the transaction. For the possible values, see Appendix A, \"Airline Document Type Codes\". 
+    # Airline document type code that specifies the purpose of the transaction. Format: English characters only. Optional request field.  | Code | Description | | --- | --- | | 01 | Passenger ticket | | 02 | Additional collection | | 03 | Excess baggage | | 04 | Miscellaneous charge order (MCO) or prepaid ticket authorization | | 05 | Special service ticket | | 06 | Supported refund | | 07 | Unsupported refund | | 08 | Lost ticket application | | 09 | Tour order voucher | | 10 | Ticket by mail | | 11 | Undercharge adjustment | | 12 | Group ticket | | 13 | Exchange adjustment | | 14 | SPD or air freight | | 15 | In-flight adjustment | | 16 | Agency passenger ticket | | 17 | Agency tour order or voucher | | 18 | Agency miscellaneous charge order (MCO) | | 19 | Agency exchange order | | 20 | Agency group ticket | | 21 | Debit adjustment for duplicate refund or use | | 22 | In-flight merchandise order | | 23 | Catalogue merchandise order | | 24 | In-flight phone charges | | 25 | Frequent flyer fee or purchase | | 26 | Kennel charge | | 27 | Animal transportation charge | | 28 | Firearms case | | 29 | Upgrade charge | | 30 | Credit for unused transportation | | 31 | Credit for class of service adjustment | | 32 | Credit for denied boarding | | 33 | Credit for miscellaneous refund | | 34 | Credit for lost ticket refund | | 35 | Credit for exchange refund | | 36 | Credit for overcharge adjustment | | 37 | Credit for multiple Unused tickets | | 38 | Exchange order | | 39 | Self-service ticket | | 41 | In-flight duty-free purchase | | 42 | Senior citizen discount booklets | | 43 | Club membership fee | | 44 | Coupon book | | 45 | In-flight charges | | 46 | Tour deposit | | 47 | Frequent flyer overnight delivery charge | | 48 | Frequent flyer fulfillment | | 49 | Small package delivery | | 50 | Vendor sale | | 51 | Miscellaneous taxes or fees | | 52 | Travel agency fee | | 60 | Vendor refund or credit | | 64 | Duty free sale | | 65 | Preferred seat upgrade | | 66 | Cabin upgrade | | 67 | Lounge or club access or day pass | | 68 | Agent assisted reservation or ticketing fee | | 69 | Ticket change or cancel fee | | 70 | Trip insurance | | 71 | Unaccompanied minor | | 72 | Standby fee | | 73 | Curbside baggage | | 74 | In-flight medical equipment | | 75 | Ticket or pass print fee | | 76 | Checked sporting or special equipment | | 77 | Dry ice fee | | 78 | Mail or postage fee | | 79 | Club membership fee or temporary trial | | 80 | Frequent flyer activation or reinstatement | | 81 | Gift certificate | | 82 | Onboard or in-flight prepaid voucher | | 83 | Optional services fee | | 84 | Advance purchase for excess baggage | | 85 | Advance purchase for preferred seat upgrade | | 86 | Advance purchase for cabin upgrade | | 87 | Advance purchase for optional services | | 88 | WiFi | | 89 | Packages | | 90 | In-flight entertainment or internet access | | 91 | Overweight bag fee | | 92 | Sleep sets | | 93 | Special purchase fee | 
     attr_accessor :document_type
 
-    # Ticket number or a value that might be a booking reference number. 
+    # The field is not currently supported. 
     attr_accessor :document_number
 
-    # Number of travel legs. Numbering for the travel legs: 0 to 3. 
+    # The field is not currently supported. 
     attr_accessor :document_number_of_parts
 
     # Invoice number for the airline transaction. 
@@ -61,61 +61,61 @@ module CyberSource
     # Description of the charge if the charge does not involve an airline ticket. For example: Excess baggage. 
     attr_accessor :additional_charges
 
-    # Total fee for the ticket. This value cannot exceed 99999999999999999999 (twenty 9s). 
+    # Total fee for the ticket. This value cannot exceed `99999999999999999999` (twenty 9s). Format: English characters only. Optional request field. 
     attr_accessor :total_fee_amount
 
-    # Total number of captures when requesting multiple partial captures for one authorization. Used along with airlineData_clearingCount to keep track of which capture is beingprocessed. For example, the second of five captures would be passed to CyberSource as airlineData_clearingSequence = 2 and airlineData_clearingCount = 5. 
+    # Number that identifies the clearing message when multiple clearing messages are allowed per authorized transaction. Each clearing message linked to one authorization request must include a unique clearing sequence number between 1 and the total number of clearing records. Format: English characters only. Optional request field. 
     attr_accessor :clearing_sequence
 
-    # Total number of clearing messages associated with the authorization request. Format: English characters only. 
+    # Total number of clearing messages associated with the authorization request. Format: English characters only. Optional request field. 
     attr_accessor :clearing_count
 
-    # Total clearing amount for all transactions in the clearing count set. If this field is not set and if the total amount from the original authorization is not NULL, CyberSource sets the total clearing amount to the total amount from the original authorization. 
+    # Total clearing amount for all transactions in the clearing count set. This value cannot exceed `99999999999999999999` (twenty 9s). Format: English characters only. If this field is not set and if the total amount from the original authorization is not NULL, the total clearing amount is set to the total amount from the original authorization. 
     attr_accessor :total_clearing_amount
 
-    # Number of passengers for whom the ticket was issued. If you do not include this field in your request, CyberSource uses a default value of 1. 
+    # Number of passengers for whom the ticket was issued. Format: English characters only. Optional request field. 
     attr_accessor :number_of_passengers
 
-    # Code that specifies the computerized reservation system used to make the reservation and purchase the ticket. Format: English characters only 
+    # Code that specifies the computerized reservation system used to make the reservation and purchase the ticket. Format: English characters only. Restricted string data type that indicates a sequence of letters, numbers, and spaces; special characters are not included. Optional request field. 
     attr_accessor :reservation_system_code
 
     # Airline process identifier. This value is the airline’s three-digit IATA1 code which is used to process extended payment airline tickets. 
     attr_accessor :process_identifier
 
-    # Date on which the transactionoccurred. Format: YYYYMMDD 
+    # Date on which the transaction occurred. Format: `YYYYMMDD` Format: English characters only. Optional request field. 
     attr_accessor :ticket_issue_date
 
-    # Flag that indicates whether an electronic ticket was issued. Possible values: - true - false 
+    # Flag that indicates whether an electronic ticket was issued. Possible values: - `true` - `false` Optional request field. 
     attr_accessor :electronic_ticket_indicator
 
     # Original ticket number when the transaction is for a replacement ticket. 
     attr_accessor :original_ticket_number
 
-    # Type of purchase. Possible values: - EXC: Exchange ticket - MSC: Miscellaneous (not a ticket purchase and not a transaction related to an exchange ticket) - REF: Refund - TKT: Ticket Format: English characters only. 
+    # Type of purchase. Possible values: - `EXC`: Exchange ticket - `MSC`: Miscellaneous (not a ticket purchase and not a transaction related to an exchange ticket) - `REF`: Refund - `TKT`: Ticket Format: English characters only. Optional request field. 
     attr_accessor :purchase_type
 
-    # Reason for the credit. Possible values: - A: Cancellation of the ancillary passenger transport purchase. - B: Cancellation of the airline ticket and the passenger transport ancillary purchase. - C: Cancellation of the airline ticket. - O: Other. - P: Partial refund of the airline ticket. 
+    # Reason for the credit. Possible values: - `A`: Cancellation of the ancillary passenger transport purchase. - `B`: Cancellation of the airline ticket and the passenger transport ancillary purchase. - `C`: Cancellation of the airline ticket. - `O`: Other. - `P`: Partial refund of the airline ticket. Format: English characters only.  Optional request field. 
     attr_accessor :credit_reason_indicator
 
-    # Type of update. Possible values: - C: Change to the existing ticket. - N: New ticket. Format: English characters only 
+    # Type of update. Possible values: - `C`: Change to the existing ticket. - `N`: New ticket. Format: English characters only Optional request field. 
     attr_accessor :ticket_change_indicator
 
-    # Plan number based on the fare. This value is provided by the airline. Format: English characters only 
+    # Plan number based on the fare. This value is provided by the airline. Format: English characters only. Optional request field. 
     attr_accessor :plan_number
 
-    # Date of arrival for the last leg of the trip. Format: MMDDYYYY English characters only. 
+    # Date of arrival for the last leg of the trip. Format: `MMDDYYYY` English characters only. Optional request field. 
     attr_accessor :arrival_date
 
-    # Text that describes the ticket limitations, such as nonrefundable. Format: English characters only. 
+    # Text that describes the ticket limitations, such as _nonrefundable_. Format: English characters only. Optional request field. 
     attr_accessor :restricted_ticket_desciption
 
     # Amount of the exchanged ticket. Format: English characters only. 
     attr_accessor :exchange_ticket_amount
 
-    # Fee for exchanging the ticket. Format: English characters only 
+    # Fee for exchanging the ticket. Format: English characters only. Optional request field. 
     attr_accessor :exchange_ticket_fee_amount
 
-    # Type of journey such as one way or round trip. 
+    # The field is not currently supported. 
     attr_accessor :reservation_type
 
     # Boarding fee.