newstore-apimatic-sdk 0.0.1

data/lib/new_store_api/models/discount.rb

@@ -0,0 +1,136 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # A discount detail.
+  class Discount < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The change in price resulting from this discount, with a number of
+    # decimals based on currency
+    # @return [String]
+    attr_accessor :change
+
+    # The coupon, if any, associated with this discount
+    # @return [String]
+    attr_accessor :coupon_code
+
+    # The discount's description
+    # @return [String]
+    attr_accessor :description
+
+    # The value of the discount, with a number of decimals based on currency
+    # @return [String]
+    attr_accessor :discount
+
+    # The source of the discount. For example, ``Promotion`` implies that the
+    # discount is based on automatic promotions, while ``Coupon`` refers to
+    # discounts from coupons.
+    # @return [String]
+    attr_accessor :discount_source
+
+    # The discount's id
+    # @return [String]
+    attr_accessor :id
+
+    # The discount's kind
+    # @return [String]
+    attr_accessor :kind
+
+    # The discount's name
+    # @return [String]
+    attr_accessor :name
+
+    # The discount's promotion type e.g. cart level or product level
+    # @return [String]
+    attr_accessor :promotion_type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['change'] = 'change'
+      @_hash['coupon_code'] = 'coupon_code'
+      @_hash['description'] = 'description'
+      @_hash['discount'] = 'discount'
+      @_hash['discount_source'] = 'discount_source'
+      @_hash['id'] = 'id'
+      @_hash['kind'] = 'kind'
+      @_hash['name'] = 'name'
+      @_hash['promotion_type'] = 'promotion_type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(change = nil, coupon_code = nil, description = nil,
+                   discount = nil, discount_source = nil, id = nil, kind = nil,
+                   name = nil, promotion_type = nil)
+      @change = change
+      @coupon_code = coupon_code
+      @description = description
+      @discount = discount
+      @discount_source = discount_source
+      @id = id
+      @kind = kind
+      @name = name
+      @promotion_type = promotion_type
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      change = hash.key?('change') ? hash['change'] : nil
+      coupon_code = hash.key?('coupon_code') ? hash['coupon_code'] : nil
+      description = hash.key?('description') ? hash['description'] : nil
+      discount = hash.key?('discount') ? hash['discount'] : nil
+      discount_source =
+        hash.key?('discount_source') ? hash['discount_source'] : nil
+      id = hash.key?('id') ? hash['id'] : nil
+      kind = hash.key?('kind') ? hash['kind'] : nil
+      name = hash.key?('name') ? hash['name'] : nil
+      promotion_type =
+        hash.key?('promotion_type') ? hash['promotion_type'] : nil
+
+      # Create object from extracted values.
+      Discount.new(change,
+                   coupon_code,
+                   description,
+                   discount,
+                   discount_source,
+                   id,
+                   kind,
+                   name,
+                   promotion_type)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} change: #{@change}, coupon_code: #{@coupon_code}, description:"\
+      " #{@description}, discount: #{@discount}, discount_source: #{@discount_source}, id: #{@id},"\
+      " kind: #{@kind}, name: #{@name}, promotion_type: #{@promotion_type}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} change: #{@change.inspect}, coupon_code: #{@coupon_code.inspect},"\
+      " description: #{@description.inspect}, discount: #{@discount.inspect}, discount_source:"\
+      " #{@discount_source.inspect}, id: #{@id.inspect}, kind: #{@kind.inspect}, name:"\
+      " #{@name.inspect}, promotion_type: #{@promotion_type.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/download_response.rb

@@ -0,0 +1,61 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # DownloadResponse Model.
+  class DownloadResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The presigned URL to redirect to, to download the requested offline
+    # products.
+    # @return [String]
+    attr_accessor :download_url
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['download_url'] = 'download_url'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(download_url = nil)
+      @download_url = download_url
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      download_url = hash.key?('download_url') ? hash['download_url'] : nil
+
+      # Create object from extracted values.
+      DownloadResponse.new(download_url)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} download_url: #{@download_url}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} download_url: #{@download_url.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/easypost_adapter_config.rb

@@ -0,0 +1,159 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # EasypostAdapterConfig Model.
+  class EasypostAdapterConfig < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The customization webhook URL to customize the data used to create the
+    # shipment.
+    # @return [String]
+    attr_accessor :base_customization_url
+
+    # The name of the shipping carrier in lowercase.
+    # @return [Hash[String, String]]
+    attr_accessor :carrier_accounts
+
+    # The API key provided by EasyPost.
+    # @return [String]
+    attr_accessor :easypost_api_key
+
+    # If set to true, the EasyPost adapter books a shipment with non-customized
+    # data if the call to the "base customization URL" fails. If set to false,
+    # the shipment is not booked if the call to the "base customization URL"
+    # fails. The value of the flag does not affect the processing of shipping
+    # options for the shipment.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :ignore_customization_failure_on_booking
+
+    # the password provided by NewStore.
+    # @return [String]
+    attr_accessor :newstore_password
+
+    # Optional: The base URL to NewStore API. This is used to push package
+    # status update from carriers.
+    # @return [String]
+    attr_accessor :newstore_url
+
+    # The username provided by NewStore.
+    # @return [String]
+    attr_accessor :newstore_username
+
+    # The name of the shipping carrier in lowercase.
+    # @return [Hash[String, Object]]
+    attr_accessor :shipment_creation_options
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['base_customization_url'] = 'base_customization_url'
+      @_hash['carrier_accounts'] = 'carrier_accounts'
+      @_hash['easypost_api_key'] = 'easypost_api_key'
+      @_hash['ignore_customization_failure_on_booking'] =
+        'ignore_customization_failure_on_booking'
+      @_hash['newstore_password'] = 'newstore_password'
+      @_hash['newstore_url'] = 'newstore_url'
+      @_hash['newstore_username'] = 'newstore_username'
+      @_hash['shipment_creation_options'] = 'shipment_creation_options'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        base_customization_url
+        carrier_accounts
+        ignore_customization_failure_on_booking
+        newstore_password
+        newstore_url
+        newstore_username
+        shipment_creation_options
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(easypost_api_key = nil, base_customization_url = SKIP,
+                   carrier_accounts = SKIP,
+                   ignore_customization_failure_on_booking = SKIP,
+                   newstore_password = SKIP, newstore_url = SKIP,
+                   newstore_username = SKIP, shipment_creation_options = SKIP)
+      @base_customization_url = base_customization_url unless base_customization_url == SKIP
+      @carrier_accounts = carrier_accounts unless carrier_accounts == SKIP
+      @easypost_api_key = easypost_api_key
+      unless ignore_customization_failure_on_booking == SKIP
+        @ignore_customization_failure_on_booking =
+          ignore_customization_failure_on_booking
+      end
+      @newstore_password = newstore_password unless newstore_password == SKIP
+      @newstore_url = newstore_url unless newstore_url == SKIP
+      @newstore_username = newstore_username unless newstore_username == SKIP
+      unless shipment_creation_options == SKIP
+        @shipment_creation_options =
+          shipment_creation_options
+      end
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      easypost_api_key =
+        hash.key?('easypost_api_key') ? hash['easypost_api_key'] : nil
+      base_customization_url =
+        hash.key?('base_customization_url') ? hash['base_customization_url'] : SKIP
+      carrier_accounts =
+        hash.key?('carrier_accounts') ? hash['carrier_accounts'] : SKIP
+      ignore_customization_failure_on_booking =
+        hash.key?('ignore_customization_failure_on_booking') ? hash['ignore_customization_failure_on_booking'] : SKIP
+      newstore_password =
+        hash.key?('newstore_password') ? hash['newstore_password'] : SKIP
+      newstore_url = hash.key?('newstore_url') ? hash['newstore_url'] : SKIP
+      newstore_username =
+        hash.key?('newstore_username') ? hash['newstore_username'] : SKIP
+      shipment_creation_options =
+        hash.key?('shipment_creation_options') ? hash['shipment_creation_options'] : SKIP
+
+      # Create object from extracted values.
+      EasypostAdapterConfig.new(easypost_api_key,
+                                base_customization_url,
+                                carrier_accounts,
+                                ignore_customization_failure_on_booking,
+                                newstore_password,
+                                newstore_url,
+                                newstore_username,
+                                shipment_creation_options)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} base_customization_url: #{@base_customization_url}, carrier_accounts:"\
+      " #{@carrier_accounts}, easypost_api_key: #{@easypost_api_key},"\
+      " ignore_customization_failure_on_booking: #{@ignore_customization_failure_on_booking},"\
+      " newstore_password: #{@newstore_password}, newstore_url: #{@newstore_url},"\
+      " newstore_username: #{@newstore_username}, shipment_creation_options:"\
+      " #{@shipment_creation_options}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} base_customization_url: #{@base_customization_url.inspect},"\
+      " carrier_accounts: #{@carrier_accounts.inspect}, easypost_api_key:"\
+      " #{@easypost_api_key.inspect}, ignore_customization_failure_on_booking:"\
+      " #{@ignore_customization_failure_on_booking.inspect}, newstore_password:"\
+      " #{@newstore_password.inspect}, newstore_url: #{@newstore_url.inspect}, newstore_username:"\
+      " #{@newstore_username.inspect}, shipment_creation_options:"\
+      " #{@shipment_creation_options.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/enriched_quotation_item_dto.rb

@@ -0,0 +1,264 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # EnrichedQuotationItemDto Model.
+  class EnrichedQuotationItemDto < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # UUID of the consumer.
+    # @return [String]
+    attr_accessor :consumer_uuid
+
+    # Currency code shown and billed to the consumer.
+    # @return [String]
+    attr_accessor :currency_consumer
+
+    # The item's list of extended attributes.
+    # @return [Array[ExtAttrResource]]
+    attr_accessor :extended_attributes
+
+    # Cost of handling. Expressed in the currency's minor unit.
+    # @return [Integer]
+    attr_accessor :handling_charges
+
+    # Unique identifier of the item.
+    # @return [String]
+    attr_accessor :id
+
+    # Price per quantity 1 of the item, can be incl. or excl. tax depending on
+    # tax_method. Expressed in the currency's minor unit.
+    # @return [Integer]
+    attr_accessor :item_price
+
+    # Gross price for the total quantity of the line item, after all discounts.
+    # Expressed in the currency's minor unit.
+    # @return [Integer]
+    attr_accessor :price_line_item
+
+    # Net price for total quantity of line item, after applying all discounts.
+    # Expressed in the currency's minor unit.
+    # @return [Integer]
+    attr_accessor :price_net
+
+    # Total amount of tax added to the net price, after appplying all discounts.
+    # Expressed in the currency's minor unit.
+    # @return [Integer]
+    attr_accessor :price_tax
+
+    # Unique identifier of the product.
+    # @return [String]
+    attr_accessor :product_id
+
+    # Human-readable name of the product.
+    # @return [String]
+    attr_accessor :product_name
+
+    # SKU of the product.
+    # @return [String]
+    attr_accessor :product_sku
+
+    # Item quantity. Positive number for sold items and negative number for
+    # returned items
+    # @return [Integer]
+    attr_accessor :quantity
+
+    # Consumer's shipping address.
+    # @return [EnrichedTransactionAddressDto]
+    attr_accessor :shipping_address
+
+    # The origin of goods address, e.g. physical address of a store.
+    # @return [EnrichedTransactionAddressDto]
+    attr_accessor :shipping_origin
+
+    # Tax classification identifier for the line item.
+    # @return [String]
+    attr_accessor :tax_class
+
+    # Tax classification identifier for the line item.
+    # @return [SalesOrderTaxMethodEnum]
+    attr_accessor :tax_method
+
+    # All applied tax percent values and tax amounts for total quantity of line
+    # item (usually more than one rate per line item).
+    # @return [Array[EnrichedQuotationTaxRateDto]]
+    attr_accessor :tax_rates
+
+    # All applied tax percent values and tax amounts for total quantity of line
+    # item (usually more than one rate per line item).
+    # @return [ItemTypeEnum]
+    attr_accessor :type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['consumer_uuid'] = 'consumer_uuid'
+      @_hash['currency_consumer'] = 'currency_consumer'
+      @_hash['extended_attributes'] = 'extended_attributes'
+      @_hash['handling_charges'] = 'handling_charges'
+      @_hash['id'] = 'id'
+      @_hash['item_price'] = 'item_price'
+      @_hash['price_line_item'] = 'price_line_item'
+      @_hash['price_net'] = 'price_net'
+      @_hash['price_tax'] = 'price_tax'
+      @_hash['product_id'] = 'product_id'
+      @_hash['product_name'] = 'product_name'
+      @_hash['product_sku'] = 'product_sku'
+      @_hash['quantity'] = 'quantity'
+      @_hash['shipping_address'] = 'shipping_address'
+      @_hash['shipping_origin'] = 'shipping_origin'
+      @_hash['tax_class'] = 'tax_class'
+      @_hash['tax_method'] = 'tax_method'
+      @_hash['tax_rates'] = 'tax_rates'
+      @_hash['type'] = 'type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        consumer_uuid
+        currency_consumer
+        extended_attributes
+        handling_charges
+        id
+        product_id
+        product_name
+        product_sku
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(item_price = nil, price_line_item = nil, price_net = nil,
+                   price_tax = nil, quantity = nil, shipping_address = nil,
+                   shipping_origin = nil, tax_class = nil, tax_method = nil,
+                   tax_rates = nil, type = nil, consumer_uuid = SKIP,
+                   currency_consumer = SKIP, extended_attributes = SKIP,
+                   handling_charges = SKIP, id = SKIP, product_id = SKIP,
+                   product_name = SKIP, product_sku = SKIP)
+      @consumer_uuid = consumer_uuid unless consumer_uuid == SKIP
+      @currency_consumer = currency_consumer unless currency_consumer == SKIP
+      @extended_attributes = extended_attributes unless extended_attributes == SKIP
+      @handling_charges = handling_charges unless handling_charges == SKIP
+      @id = id unless id == SKIP
+      @item_price = item_price
+      @price_line_item = price_line_item
+      @price_net = price_net
+      @price_tax = price_tax
+      @product_id = product_id unless product_id == SKIP
+      @product_name = product_name unless product_name == SKIP
+      @product_sku = product_sku unless product_sku == SKIP
+      @quantity = quantity
+      @shipping_address = shipping_address
+      @shipping_origin = shipping_origin
+      @tax_class = tax_class
+      @tax_method = tax_method
+      @tax_rates = tax_rates
+      @type = type
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      item_price = hash.key?('item_price') ? hash['item_price'] : nil
+      price_line_item =
+        hash.key?('price_line_item') ? hash['price_line_item'] : nil
+      price_net = hash.key?('price_net') ? hash['price_net'] : nil
+      price_tax = hash.key?('price_tax') ? hash['price_tax'] : nil
+      quantity = hash.key?('quantity') ? hash['quantity'] : nil
+      shipping_address = EnrichedTransactionAddressDto.from_hash(hash['shipping_address']) if
+        hash['shipping_address']
+      shipping_origin = EnrichedTransactionAddressDto.from_hash(hash['shipping_origin']) if
+        hash['shipping_origin']
+      tax_class = hash.key?('tax_class') ? hash['tax_class'] : nil
+      tax_method = hash.key?('tax_method') ? hash['tax_method'] : nil
+      # Parameter is an array, so we need to iterate through it
+      tax_rates = nil
+      unless hash['tax_rates'].nil?
+        tax_rates = []
+        hash['tax_rates'].each do |structure|
+          tax_rates << (EnrichedQuotationTaxRateDto.from_hash(structure) if structure)
+        end
+      end
+
+      tax_rates = nil unless hash.key?('tax_rates')
+      type = hash.key?('type') ? hash['type'] : nil
+      consumer_uuid = hash.key?('consumer_uuid') ? hash['consumer_uuid'] : SKIP
+      currency_consumer =
+        hash.key?('currency_consumer') ? hash['currency_consumer'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      extended_attributes = nil
+      unless hash['extended_attributes'].nil?
+        extended_attributes = []
+        hash['extended_attributes'].each do |structure|
+          extended_attributes << (ExtAttrResource.from_hash(structure) if structure)
+        end
+      end
+
+      extended_attributes = SKIP unless hash.key?('extended_attributes')
+      handling_charges =
+        hash.key?('handling_charges') ? hash['handling_charges'] : SKIP
+      id = hash.key?('id') ? hash['id'] : SKIP
+      product_id = hash.key?('product_id') ? hash['product_id'] : SKIP
+      product_name = hash.key?('product_name') ? hash['product_name'] : SKIP
+      product_sku = hash.key?('product_sku') ? hash['product_sku'] : SKIP
+
+      # Create object from extracted values.
+      EnrichedQuotationItemDto.new(item_price,
+                                   price_line_item,
+                                   price_net,
+                                   price_tax,
+                                   quantity,
+                                   shipping_address,
+                                   shipping_origin,
+                                   tax_class,
+                                   tax_method,
+                                   tax_rates,
+                                   type,
+                                   consumer_uuid,
+                                   currency_consumer,
+                                   extended_attributes,
+                                   handling_charges,
+                                   id,
+                                   product_id,
+                                   product_name,
+                                   product_sku)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} consumer_uuid: #{@consumer_uuid}, currency_consumer: #{@currency_consumer},"\
+      " extended_attributes: #{@extended_attributes}, handling_charges: #{@handling_charges}, id:"\
+      " #{@id}, item_price: #{@item_price}, price_line_item: #{@price_line_item}, price_net:"\
+      " #{@price_net}, price_tax: #{@price_tax}, product_id: #{@product_id}, product_name:"\
+      " #{@product_name}, product_sku: #{@product_sku}, quantity: #{@quantity}, shipping_address:"\
+      " #{@shipping_address}, shipping_origin: #{@shipping_origin}, tax_class: #{@tax_class},"\
+      " tax_method: #{@tax_method}, tax_rates: #{@tax_rates}, type: #{@type}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} consumer_uuid: #{@consumer_uuid.inspect}, currency_consumer:"\
+      " #{@currency_consumer.inspect}, extended_attributes: #{@extended_attributes.inspect},"\
+      " handling_charges: #{@handling_charges.inspect}, id: #{@id.inspect}, item_price:"\
+      " #{@item_price.inspect}, price_line_item: #{@price_line_item.inspect}, price_net:"\
+      " #{@price_net.inspect}, price_tax: #{@price_tax.inspect}, product_id:"\
+      " #{@product_id.inspect}, product_name: #{@product_name.inspect}, product_sku:"\
+      " #{@product_sku.inspect}, quantity: #{@quantity.inspect}, shipping_address:"\
+      " #{@shipping_address.inspect}, shipping_origin: #{@shipping_origin.inspect}, tax_class:"\
+      " #{@tax_class.inspect}, tax_method: #{@tax_method.inspect}, tax_rates:"\
+      " #{@tax_rates.inspect}, type: #{@type.inspect}>"
+    end
+  end
+end