cybersource-apimatic-sdk 0.0.1

data/lib/cyber_source_merged_spec/models/line_item12.rb

@@ -0,0 +1,464 @@
+# cyber_source_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module CyberSourceMergedSpec
+  # LineItem12 Model.
+  class LineItem12 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Total amount for the item. Normally calculated as the unit price times
+    # quantity.
+    # When `orderInformation.lineItems[].productCode` is "gift_card", this is
+    # the purchase amount total
+    # for prepaid gift cards in major units.
+    # Example: 123.45 USD = 123
+    # @return [String]
+    attr_accessor :total_amount
+
+    # Per-item price of the product. This value for this field cannot be
+    # negative.
+    # You must include either this field or the request-level field
+    # `orderInformation.amountDetails.totalAmount` in your request.
+    # You can include a decimal point (.), but you cannot include any other
+    # special characters.
+    # The value is truncated to the correct number of decimal places.
+    # #### DCC with a Third-Party Provider
+    # Set this field to the converted amount that was returned by the DCC
+    # provider. You must include either
+    # the 1st line item in the order and this field, or the request-level field
+    # `orderInformation.amountDetails.totalAmount` in your request.
+    # #### Tax Calculation
+    # Required field for U.S., Canadian, international and value added taxes.
+    # #### Zero Amount Authorizations
+    # If your processor supports zero amount authorizations, you can set this
+    # field to 0 for the
+    # authorization to check if the card is lost or stolen.
+    # #### Maximum Field Lengths
+    # For GPN and JCN Gateway: Decimal (10)
+    # All other processors: Decimal (15)
+    # @return [String]
+    attr_accessor :unit_price
+
+    # Number of units for this order. Must be a non-negative integer.
+    # The default is `1`. For an authorization or capture transaction
+    # (`processingOptions.capture` is set to `true` or `false`),
+    # this field is required when `orderInformation.lineItems[].productCode` is
+    # not `default` or one of the other values
+    # related to shipping and/or handling.
+    # #### Tax Calculation
+    # Optional field for U.S., Canadian, international tax, and value added
+    # taxes.
+    # @return [Integer]
+    attr_accessor :quantity
+
+    # When `orderInformation.lineItems[].productCode` is "gift_card", this is
+    # the
+    # currency used for the gift card purchase.
+    # For the possible values, see the [ISO Standard Currency
+    # Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/cur
+    # rencies.pdf)
+    # @return [Integer]
+    attr_accessor :gift_card_currency
+
+    # Product identifier code. Also known as the Stock Keeping Unit (SKU) code
+    # for the product.
+    # For an authorization or capture transaction (`processingOptions.capture`
+    # is set to `true` or `false`), this field is required when
+    # `orderInformation.lineItems[].productCode` is not set to **default** or
+    # one of the other values that are related to shipping and/or handling.
+    # #### Tax Calculation
+    # Optional field for U.S. and Canadian taxes. Not applicable to
+    # international and value added taxes.
+    # For an authorization or capture transaction (`processingOptions.capture`
+    # is set to `true` or `false`), this field is
+    # required when `orderInformation.lineItems[].productCode` is not `default`
+    # or one of the values related to shipping and/or handling.
+    # @return [String]
+    attr_accessor :product_sku
+
+    # Brief description of item.
+    # @return [String]
+    attr_accessor :product_description
+
+    # For an authorization or capture transaction (`processingOptions.capture`
+    # is `true` or `false`),
+    # this field is required when `orderInformation.lineItems[].productCode` is
+    # not `default` or one of
+    # the other values that are related to shipping and/or handling.
+    # #### Tax Calculation
+    # Optional field for U.S., Canadian, international tax, and value added
+    # taxes.
+    # @return [String]
+    attr_accessor :product_name
+
+    # Contains travel-related passenger details used by DM service only.
+    # @return [Passenger]
+    attr_accessor :passenger
+
+    # Destination to where the item will be shipped. Example: Commercial,
+    # Residential, Store
+    # @return [String]
+    attr_accessor :shipping_destination_types
+
+    # Total tax to apply to the product. This value cannot be negative. The tax
+    # amount and the offer amount must
+    # be in the same currency. The tax amount field is additive.
+    # The following example uses a two-exponent currency such as USD:
+    #  1. You include each line item in your request.
+    #  ..- 1st line item has amount=10.00, quantity=1, and taxAmount=0.80
+    #  ..- 2nd line item has amount=20.00, quantity=1, and taxAmount=1.60
+    #  2. The total amount authorized will be 32.40, not 30.00 with 2.40 of tax
+    # included.
+    # Optional field.
+    # #### Airlines processing
+    # Tax portion of the order amount. This value cannot exceed 99999999999999
+    # (fourteen 9s).
+    # Format: English characters only.
+    # Optional request field for a line item.
+    # #### Tax Calculation
+    # Optional field for U.S., Canadian, international tax, and value added
+    # taxes.
+    # Note if you send this field in your tax request, the value in the field
+    # will override the tax engine
+    # @return [String]
+    attr_accessor :tax_amount
+
+    # Address where item will be shipped
+    # @return [String]
+    attr_accessor :shipping_address1
+
+    # Address where item will be shipped
+    # @return [String]
+    attr_accessor :shipping_address2
+
+    # City where item will be shipped
+    # @return [String]
+    attr_accessor :shipping_city
+
+    # Country where item will be shipped
+    # @return [String]
+    attr_accessor :shipping_country_code
+
+    # Customer's first name
+    # @return [String]
+    attr_accessor :shipping_first_name
+
+    # Customer's last name
+    # @return [String]
+    attr_accessor :shipping_last_name
+
+    # Customer's middle name
+    # @return [String]
+    attr_accessor :shipping_middle_name
+
+    # Phone number where item will be shipped
+    # @return [Integer]
+    attr_accessor :shipping_phone
+
+    # Postal code where item will be shipped
+    # @return [Integer]
+    attr_accessor :shipping_postal_code
+
+    # State where item will be shipped
+    # @return [String]
+    attr_accessor :shipping_state
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['total_amount'] = 'totalAmount'
+      @_hash['unit_price'] = 'unitPrice'
+      @_hash['quantity'] = 'quantity'
+      @_hash['gift_card_currency'] = 'giftCardCurrency'
+      @_hash['product_sku'] = 'productSKU'
+      @_hash['product_description'] = 'productDescription'
+      @_hash['product_name'] = 'productName'
+      @_hash['passenger'] = 'passenger'
+      @_hash['shipping_destination_types'] = 'shippingDestinationTypes'
+      @_hash['tax_amount'] = 'taxAmount'
+      @_hash['shipping_address1'] = 'shippingAddress1'
+      @_hash['shipping_address2'] = 'shippingAddress2'
+      @_hash['shipping_city'] = 'shippingCity'
+      @_hash['shipping_country_code'] = 'shippingCountryCode'
+      @_hash['shipping_first_name'] = 'shippingFirstName'
+      @_hash['shipping_last_name'] = 'shippingLastName'
+      @_hash['shipping_middle_name'] = 'shippingMiddleName'
+      @_hash['shipping_phone'] = 'shippingPhone'
+      @_hash['shipping_postal_code'] = 'shippingPostalCode'
+      @_hash['shipping_state'] = 'shippingState'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        total_amount
+        quantity
+        gift_card_currency
+        product_sku
+        product_description
+        product_name
+        passenger
+        shipping_destination_types
+        tax_amount
+        shipping_address1
+        shipping_address2
+        shipping_city
+        shipping_country_code
+        shipping_first_name
+        shipping_last_name
+        shipping_middle_name
+        shipping_phone
+        shipping_postal_code
+        shipping_state
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(unit_price:, total_amount: SKIP, quantity: 1,
+                   gift_card_currency: SKIP, product_sku: SKIP,
+                   product_description: SKIP, product_name: SKIP,
+                   passenger: SKIP, shipping_destination_types: SKIP,
+                   tax_amount: SKIP, shipping_address1: SKIP,
+                   shipping_address2: SKIP, shipping_city: SKIP,
+                   shipping_country_code: SKIP, shipping_first_name: SKIP,
+                   shipping_last_name: SKIP, shipping_middle_name: SKIP,
+                   shipping_phone: SKIP, shipping_postal_code: SKIP,
+                   shipping_state: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @total_amount = total_amount unless total_amount == SKIP
+      @unit_price = unit_price
+      @quantity = quantity unless quantity == SKIP
+      @gift_card_currency = gift_card_currency unless gift_card_currency == SKIP
+      @product_sku = product_sku unless product_sku == SKIP
+      @product_description = product_description unless product_description == SKIP
+      @product_name = product_name unless product_name == SKIP
+      @passenger = passenger unless passenger == SKIP
+      unless shipping_destination_types == SKIP
+        @shipping_destination_types =
+          shipping_destination_types
+      end
+      @tax_amount = tax_amount unless tax_amount == SKIP
+      @shipping_address1 = shipping_address1 unless shipping_address1 == SKIP
+      @shipping_address2 = shipping_address2 unless shipping_address2 == SKIP
+      @shipping_city = shipping_city unless shipping_city == SKIP
+      @shipping_country_code = shipping_country_code unless shipping_country_code == SKIP
+      @shipping_first_name = shipping_first_name unless shipping_first_name == SKIP
+      @shipping_last_name = shipping_last_name unless shipping_last_name == SKIP
+      @shipping_middle_name = shipping_middle_name unless shipping_middle_name == SKIP
+      @shipping_phone = shipping_phone unless shipping_phone == SKIP
+      @shipping_postal_code = shipping_postal_code unless shipping_postal_code == SKIP
+      @shipping_state = shipping_state unless shipping_state == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      unit_price = hash.key?('unitPrice') ? hash['unitPrice'] : nil
+      total_amount = hash.key?('totalAmount') ? hash['totalAmount'] : SKIP
+      quantity = hash['quantity'] ||= 1
+      gift_card_currency =
+        hash.key?('giftCardCurrency') ? hash['giftCardCurrency'] : SKIP
+      product_sku = hash.key?('productSKU') ? hash['productSKU'] : SKIP
+      product_description =
+        hash.key?('productDescription') ? hash['productDescription'] : SKIP
+      product_name = hash.key?('productName') ? hash['productName'] : SKIP
+      passenger = Passenger.from_hash(hash['passenger']) if hash['passenger']
+      shipping_destination_types =
+        hash.key?('shippingDestinationTypes') ? hash['shippingDestinationTypes'] : SKIP
+      tax_amount = hash.key?('taxAmount') ? hash['taxAmount'] : SKIP
+      shipping_address1 =
+        hash.key?('shippingAddress1') ? hash['shippingAddress1'] : SKIP
+      shipping_address2 =
+        hash.key?('shippingAddress2') ? hash['shippingAddress2'] : SKIP
+      shipping_city = hash.key?('shippingCity') ? hash['shippingCity'] : SKIP
+      shipping_country_code =
+        hash.key?('shippingCountryCode') ? hash['shippingCountryCode'] : SKIP
+      shipping_first_name =
+        hash.key?('shippingFirstName') ? hash['shippingFirstName'] : SKIP
+      shipping_last_name =
+        hash.key?('shippingLastName') ? hash['shippingLastName'] : SKIP
+      shipping_middle_name =
+        hash.key?('shippingMiddleName') ? hash['shippingMiddleName'] : SKIP
+      shipping_phone = hash.key?('shippingPhone') ? hash['shippingPhone'] : SKIP
+      shipping_postal_code =
+        hash.key?('shippingPostalCode') ? hash['shippingPostalCode'] : SKIP
+      shipping_state = hash.key?('shippingState') ? hash['shippingState'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      LineItem12.new(unit_price: unit_price,
+                     total_amount: total_amount,
+                     quantity: quantity,
+                     gift_card_currency: gift_card_currency,
+                     product_sku: product_sku,
+                     product_description: product_description,
+                     product_name: product_name,
+                     passenger: passenger,
+                     shipping_destination_types: shipping_destination_types,
+                     tax_amount: tax_amount,
+                     shipping_address1: shipping_address1,
+                     shipping_address2: shipping_address2,
+                     shipping_city: shipping_city,
+                     shipping_country_code: shipping_country_code,
+                     shipping_first_name: shipping_first_name,
+                     shipping_last_name: shipping_last_name,
+                     shipping_middle_name: shipping_middle_name,
+                     shipping_phone: shipping_phone,
+                     shipping_postal_code: shipping_postal_code,
+                     shipping_state: shipping_state,
+                     additional_properties: additional_properties)
+    end
+
+    def self.from_element(root)
+      unit_price = XmlUtilities.from_element(root, 'unitPrice', String)
+      total_amount = XmlUtilities.from_element(root, 'totalAmount', String)
+      quantity = XmlUtilities.from_element(root, 'quantity', Integer)
+      gift_card_currency = XmlUtilities.from_element(root, 'giftCardCurrency',
+                                                     Integer)
+      product_sku = XmlUtilities.from_element(root, 'productSKU', String)
+      product_description = XmlUtilities.from_element(root,
+                                                      'productDescription',
+                                                      String)
+      product_name = XmlUtilities.from_element(root, 'productName', String)
+      passenger = XmlUtilities.from_element(root, 'Passenger', Passenger)
+      shipping_destination_types = XmlUtilities.from_element(
+        root, 'shippingDestinationTypes', String
+      )
+      tax_amount = XmlUtilities.from_element(root, 'taxAmount', String)
+      shipping_address1 = XmlUtilities.from_element(root, 'shippingAddress1',
+                                                    String)
+      shipping_address2 = XmlUtilities.from_element(root, 'shippingAddress2',
+                                                    String)
+      shipping_city = XmlUtilities.from_element(root, 'shippingCity', String)
+      shipping_country_code = XmlUtilities.from_element(root,
+                                                        'shippingCountryCode',
+                                                        String)
+      shipping_first_name = XmlUtilities.from_element(root, 'shippingFirstName',
+                                                      String)
+      shipping_last_name = XmlUtilities.from_element(root, 'shippingLastName',
+                                                     String)
+      shipping_middle_name = XmlUtilities.from_element(root,
+                                                       'shippingMiddleName',
+                                                       String)
+      shipping_phone = XmlUtilities.from_element(root, 'shippingPhone', Integer)
+      shipping_postal_code = XmlUtilities.from_element(root,
+                                                       'shippingPostalCode',
+                                                       Integer)
+      shipping_state = XmlUtilities.from_element(root, 'shippingState', String)
+
+      new(unit_price: unit_price,
+          total_amount: total_amount,
+          quantity: quantity,
+          gift_card_currency: gift_card_currency,
+          product_sku: product_sku,
+          product_description: product_description,
+          product_name: product_name,
+          passenger: passenger,
+          shipping_destination_types: shipping_destination_types,
+          tax_amount: tax_amount,
+          shipping_address1: shipping_address1,
+          shipping_address2: shipping_address2,
+          shipping_city: shipping_city,
+          shipping_country_code: shipping_country_code,
+          shipping_first_name: shipping_first_name,
+          shipping_last_name: shipping_last_name,
+          shipping_middle_name: shipping_middle_name,
+          shipping_phone: shipping_phone,
+          shipping_postal_code: shipping_postal_code,
+          shipping_state: shipping_state,
+          additional_properties: additional_properties)
+    end
+
+    def to_xml_element(doc, root_name)
+      root = doc.create_element(root_name)
+
+      XmlUtilities.add_as_subelement(doc, root, 'unitPrice', unit_price)
+      XmlUtilities.add_as_subelement(doc, root, 'totalAmount', total_amount)
+      XmlUtilities.add_as_subelement(doc, root, 'quantity', quantity)
+      XmlUtilities.add_as_subelement(doc, root, 'giftCardCurrency',
+                                     gift_card_currency)
+      XmlUtilities.add_as_subelement(doc, root, 'productSKU', product_sku)
+      XmlUtilities.add_as_subelement(doc, root, 'productDescription',
+                                     product_description)
+      XmlUtilities.add_as_subelement(doc, root, 'productName', product_name)
+      XmlUtilities.add_as_subelement(doc, root, 'Passenger', passenger)
+      XmlUtilities.add_as_subelement(doc, root, 'shippingDestinationTypes',
+                                     shipping_destination_types)
+      XmlUtilities.add_as_subelement(doc, root, 'taxAmount', tax_amount)
+      XmlUtilities.add_as_subelement(doc, root, 'shippingAddress1',
+                                     shipping_address1)
+      XmlUtilities.add_as_subelement(doc, root, 'shippingAddress2',
+                                     shipping_address2)
+      XmlUtilities.add_as_subelement(doc, root, 'shippingCity', shipping_city)
+      XmlUtilities.add_as_subelement(doc, root, 'shippingCountryCode',
+                                     shipping_country_code)
+      XmlUtilities.add_as_subelement(doc, root, 'shippingFirstName',
+                                     shipping_first_name)
+      XmlUtilities.add_as_subelement(doc, root, 'shippingLastName',
+                                     shipping_last_name)
+      XmlUtilities.add_as_subelement(doc, root, 'shippingMiddleName',
+                                     shipping_middle_name)
+      XmlUtilities.add_as_subelement(doc, root, 'shippingPhone', shipping_phone)
+      XmlUtilities.add_as_subelement(doc, root, 'shippingPostalCode',
+                                     shipping_postal_code)
+      XmlUtilities.add_as_subelement(doc, root, 'shippingState', shipping_state)
+      XmlUtilities.add_as_subelement(doc, root, 'additional_properties',
+                                     additional_properties)
+
+      root
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} total_amount: #{@total_amount}, unit_price: #{@unit_price}, quantity:"\
+      " #{@quantity}, gift_card_currency: #{@gift_card_currency}, product_sku: #{@product_sku},"\
+      " product_description: #{@product_description}, product_name: #{@product_name}, passenger:"\
+      " #{@passenger}, shipping_destination_types: #{@shipping_destination_types}, tax_amount:"\
+      " #{@tax_amount}, shipping_address1: #{@shipping_address1}, shipping_address2:"\
+      " #{@shipping_address2}, shipping_city: #{@shipping_city}, shipping_country_code:"\
+      " #{@shipping_country_code}, shipping_first_name: #{@shipping_first_name},"\
+      " shipping_last_name: #{@shipping_last_name}, shipping_middle_name:"\
+      " #{@shipping_middle_name}, shipping_phone: #{@shipping_phone}, shipping_postal_code:"\
+      " #{@shipping_postal_code}, shipping_state: #{@shipping_state}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} total_amount: #{@total_amount.inspect}, unit_price: #{@unit_price.inspect},"\
+      " quantity: #{@quantity.inspect}, gift_card_currency: #{@gift_card_currency.inspect},"\
+      " product_sku: #{@product_sku.inspect}, product_description:"\
+      " #{@product_description.inspect}, product_name: #{@product_name.inspect}, passenger:"\
+      " #{@passenger.inspect}, shipping_destination_types: #{@shipping_destination_types.inspect},"\
+      " tax_amount: #{@tax_amount.inspect}, shipping_address1: #{@shipping_address1.inspect},"\
+      " shipping_address2: #{@shipping_address2.inspect}, shipping_city:"\
+      " #{@shipping_city.inspect}, shipping_country_code: #{@shipping_country_code.inspect},"\
+      " shipping_first_name: #{@shipping_first_name.inspect}, shipping_last_name:"\
+      " #{@shipping_last_name.inspect}, shipping_middle_name: #{@shipping_middle_name.inspect},"\
+      " shipping_phone: #{@shipping_phone.inspect}, shipping_postal_code:"\
+      " #{@shipping_postal_code.inspect}, shipping_state: #{@shipping_state.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/cyber_source_merged_spec/models/line_item13.rb

@@ -0,0 +1,94 @@
+# cyber_source_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module CyberSourceMergedSpec
+  # LineItem13 Model.
+  class LineItem13 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Per-item price of the product. If line items are present in the request,
+    # the unit price is a mandatory field.
+    # @return [String]
+    attr_accessor :unit_price
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['unit_price'] = 'unitPrice'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        unit_price
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(unit_price: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @unit_price = unit_price unless unit_price == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      unit_price = hash.key?('unitPrice') ? hash['unitPrice'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      LineItem13.new(unit_price: unit_price,
+                     additional_properties: additional_properties)
+    end
+
+    def self.from_element(root)
+      unit_price = XmlUtilities.from_element(root, 'unitPrice', String)
+
+      new(unit_price: unit_price,
+          additional_properties: additional_properties)
+    end
+
+    def to_xml_element(doc, root_name)
+      root = doc.create_element(root_name)
+
+      XmlUtilities.add_as_subelement(doc, root, 'unitPrice', unit_price)
+      XmlUtilities.add_as_subelement(doc, root, 'additional_properties',
+                                     additional_properties)
+
+      root
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} unit_price: #{@unit_price}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} unit_price: #{@unit_price.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end