cybersource-apimatic-sdk 0.0.1

data/lib/cyber_source_merged_spec/models/line_item1.rb

@@ -0,0 +1,133 @@
+# cyber_source_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module CyberSourceMergedSpec
+  # LineItem1 Model.
+  class LineItem1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # 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
+
+    # 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
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['quantity'] = 'quantity'
+      @_hash['unit_price'] = 'unitPrice'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        quantity
+        unit_price
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(quantity: 1, unit_price: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @quantity = quantity unless quantity == SKIP
+      @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.
+      quantity = hash['quantity'] ||= 1
+      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.
+      LineItem1.new(quantity: quantity,
+                    unit_price: unit_price,
+                    additional_properties: additional_properties)
+    end
+
+    def self.from_element(root)
+      quantity = XmlUtilities.from_element(root, 'quantity', Integer)
+      unit_price = XmlUtilities.from_element(root, 'unitPrice', String)
+
+      new(quantity: quantity,
+          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, 'quantity', quantity)
+      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} quantity: #{@quantity}, 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} quantity: #{@quantity.inspect}, unit_price: #{@unit_price.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/cyber_source_merged_spec/models/line_item11.rb

@@ -0,0 +1,456 @@
+# cyber_source_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module CyberSourceMergedSpec
+  # LineItem11 Model.
+  class LineItem11 < 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. If line items are present in the request,
+    # the unit price is a mandatory field.
+    # @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
+
+    # Indicates the level of risk for the product. This field can contain one of
+    # the following values:
+    # - `low`: The product is associated with few chargebacks.
+    # - `normal`: The product is associated with a normal number of chargebacks.
+    # - `high`: The product is associated with many chargebacks.
+    # @return [String]
+    attr_accessor :product_risk
+
+    # 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
+
+    # Type of product. The value for this field is used to identify the product
+    # category (electronic, handling, physical,
+    # service, or shipping). The default value is `default`.
+    # If you are performing an authorization transaction
+    # (`processingOptions.capture` is set to `false`), and you set
+    # this field to a value other than `default` or one of the values related to
+    # shipping and/or handling, then
+    # `orderInformation.lineItems[].quantity`,
+    # `orderInformation.lineItems[].productName`, and
+    # `orderInformation.lineItems[].productSku` fields are required.
+    # Optional field.
+    # #### Tax Calculation
+    # Optional field for U.S., Canadian, international tax, and value added
+    # taxes.
+    # The Product Codes for the tax service are located in the Cybersource Tax
+    # Codes guide. Contact Customer Support to request the guide. If you don’t
+    # send a tax service Product Code in your tax request, product-based rules
+    # or exemptions will not be applied and the transaction will default to
+    # fully taxable in the locations where you’ve indicated you need to collect
+    # tax [by way of nexus, no nexus, or seller registration number fields].
+    # @return [String]
+    attr_accessor :product_code
+
+    # This field is only used in DM service.
+    # Determines whether to assign risk to the order if the billing and shipping
+    # addresses specify different cities,
+    # states, or countries. This field can contain one of the following values:
+    # - true: Orders are assigned only slight additional risk if billing and
+    # shipping addresses are different.
+    # - false: Orders are assigned higher additional risk if billing and
+    # shipping addresses are different.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :gift
+
+    # Product’s identifier code. This field is inserted into the outgoing
+    # message without being parsed or formatted.
+    # This field is included as Distributor product SKU (Offer) in the list of
+    # API fields with which you can create
+    # custom rules.
+    # @return [String]
+    attr_accessor :distributor_product_sku
+
+    # 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
+
+    # 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 [Array[String]]
+    attr_accessor :allowed_export_countries
+
+    # 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 [Array[String]]
+    attr_accessor :restricted_export_countries
+
+    # 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_risk'] = 'productRisk'
+      @_hash['product_description'] = 'productDescription'
+      @_hash['product_name'] = 'productName'
+      @_hash['product_code'] = 'productCode'
+      @_hash['gift'] = 'gift'
+      @_hash['distributor_product_sku'] = 'distributorProductSku'
+      @_hash['passenger'] = 'passenger'
+      @_hash['shipping_destination_types'] = 'shippingDestinationTypes'
+      @_hash['tax_amount'] = 'taxAmount'
+      @_hash['allowed_export_countries'] = 'allowedExportCountries'
+      @_hash['restricted_export_countries'] = 'restrictedExportCountries'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        total_amount
+        unit_price
+        quantity
+        gift_card_currency
+        product_sku
+        product_risk
+        product_description
+        product_name
+        product_code
+        gift
+        distributor_product_sku
+        passenger
+        shipping_destination_types
+        tax_amount
+        allowed_export_countries
+        restricted_export_countries
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(total_amount: SKIP, unit_price: SKIP, quantity: 1,
+                   gift_card_currency: SKIP, product_sku: SKIP,
+                   product_risk: SKIP, product_description: SKIP,
+                   product_name: SKIP, product_code: SKIP, gift: SKIP,
+                   distributor_product_sku: SKIP, passenger: SKIP,
+                   shipping_destination_types: SKIP, tax_amount: SKIP,
+                   allowed_export_countries: SKIP,
+                   restricted_export_countries: 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 unless unit_price == SKIP
+      @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_risk = product_risk unless product_risk == SKIP
+      @product_description = product_description unless product_description == SKIP
+      @product_name = product_name unless product_name == SKIP
+      @product_code = product_code unless product_code == SKIP
+      @gift = gift unless gift == SKIP
+      @distributor_product_sku = distributor_product_sku unless distributor_product_sku == 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
+      @allowed_export_countries = allowed_export_countries unless allowed_export_countries == SKIP
+      unless restricted_export_countries == SKIP
+        @restricted_export_countries =
+          restricted_export_countries
+      end
+      @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.
+      total_amount = hash.key?('totalAmount') ? hash['totalAmount'] : SKIP
+      unit_price = hash.key?('unitPrice') ? hash['unitPrice'] : SKIP
+      quantity = hash['quantity'] ||= 1
+      gift_card_currency =
+        hash.key?('giftCardCurrency') ? hash['giftCardCurrency'] : SKIP
+      product_sku = hash.key?('productSKU') ? hash['productSKU'] : SKIP
+      product_risk = hash.key?('productRisk') ? hash['productRisk'] : SKIP
+      product_description =
+        hash.key?('productDescription') ? hash['productDescription'] : SKIP
+      product_name = hash.key?('productName') ? hash['productName'] : SKIP
+      product_code = hash.key?('productCode') ? hash['productCode'] : SKIP
+      gift = hash.key?('gift') ? hash['gift'] : SKIP
+      distributor_product_sku =
+        hash.key?('distributorProductSku') ? hash['distributorProductSku'] : 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
+      allowed_export_countries =
+        hash.key?('allowedExportCountries') ? hash['allowedExportCountries'] : SKIP
+      restricted_export_countries =
+        hash.key?('restrictedExportCountries') ? hash['restrictedExportCountries'] : 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.
+      LineItem11.new(total_amount: total_amount,
+                     unit_price: unit_price,
+                     quantity: quantity,
+                     gift_card_currency: gift_card_currency,
+                     product_sku: product_sku,
+                     product_risk: product_risk,
+                     product_description: product_description,
+                     product_name: product_name,
+                     product_code: product_code,
+                     gift: gift,
+                     distributor_product_sku: distributor_product_sku,
+                     passenger: passenger,
+                     shipping_destination_types: shipping_destination_types,
+                     tax_amount: tax_amount,
+                     allowed_export_countries: allowed_export_countries,
+                     restricted_export_countries: restricted_export_countries,
+                     additional_properties: additional_properties)
+    end
+
+    def self.from_element(root)
+      total_amount = XmlUtilities.from_element(root, 'totalAmount', String)
+      unit_price = XmlUtilities.from_element(root, 'unitPrice', 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_risk = XmlUtilities.from_element(root, 'productRisk', String)
+      product_description = XmlUtilities.from_element(root,
+                                                      'productDescription',
+                                                      String)
+      product_name = XmlUtilities.from_element(root, 'productName', String)
+      product_code = XmlUtilities.from_element(root, 'productCode', String)
+      gift = XmlUtilities.from_element(root, 'gift', TrueClass)
+      distributor_product_sku = XmlUtilities.from_element(
+        root, 'distributorProductSku', 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)
+      allowed_export_countries = XmlUtilities.from_element_to_array(
+        root, 'allowedExportCountries', String
+      )
+      restricted_export_countries = XmlUtilities.from_element_to_array(
+        root, 'restrictedExportCountries', String
+      )
+
+      new(total_amount: total_amount,
+          unit_price: unit_price,
+          quantity: quantity,
+          gift_card_currency: gift_card_currency,
+          product_sku: product_sku,
+          product_risk: product_risk,
+          product_description: product_description,
+          product_name: product_name,
+          product_code: product_code,
+          gift: gift,
+          distributor_product_sku: distributor_product_sku,
+          passenger: passenger,
+          shipping_destination_types: shipping_destination_types,
+          tax_amount: tax_amount,
+          allowed_export_countries: allowed_export_countries,
+          restricted_export_countries: restricted_export_countries,
+          additional_properties: additional_properties)
+    end
+
+    def to_xml_element(doc, root_name)
+      root = doc.create_element(root_name)
+
+      XmlUtilities.add_as_subelement(doc, root, 'totalAmount', total_amount)
+      XmlUtilities.add_as_subelement(doc, root, 'unitPrice', unit_price)
+      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, 'productRisk', product_risk)
+      XmlUtilities.add_as_subelement(doc, root, 'productDescription',
+                                     product_description)
+      XmlUtilities.add_as_subelement(doc, root, 'productName', product_name)
+      XmlUtilities.add_as_subelement(doc, root, 'productCode', product_code)
+      XmlUtilities.add_as_subelement(doc, root, 'gift', gift)
+      XmlUtilities.add_as_subelement(doc, root, 'distributorProductSku',
+                                     distributor_product_sku)
+      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_array_as_subelement(doc, root, 'allowedExportCountries',
+                                           allowed_export_countries)
+      XmlUtilities.add_array_as_subelement(doc, root,
+                                           'restrictedExportCountries',
+                                           restricted_export_countries)
+      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_risk: #{@product_risk}, product_description: #{@product_description},"\
+      " product_name: #{@product_name}, product_code: #{@product_code}, gift: #{@gift},"\
+      " distributor_product_sku: #{@distributor_product_sku}, passenger: #{@passenger},"\
+      " shipping_destination_types: #{@shipping_destination_types}, tax_amount: #{@tax_amount},"\
+      " allowed_export_countries: #{@allowed_export_countries}, restricted_export_countries:"\
+      " #{@restricted_export_countries}, 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_risk: #{@product_risk.inspect},"\
+      " product_description: #{@product_description.inspect}, product_name:"\
+      " #{@product_name.inspect}, product_code: #{@product_code.inspect}, gift: #{@gift.inspect},"\
+      " distributor_product_sku: #{@distributor_product_sku.inspect}, passenger:"\
+      " #{@passenger.inspect}, shipping_destination_types: #{@shipping_destination_types.inspect},"\
+      " tax_amount: #{@tax_amount.inspect}, allowed_export_countries:"\
+      " #{@allowed_export_countries.inspect}, restricted_export_countries:"\
+      " #{@restricted_export_countries.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end