newstore-apimatic-sdk 0.0.1

data/lib/new_store_api/models/swap_to.rb

@@ -0,0 +1,223 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Properties of the new item.
+  class SwapTo < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The origin country code of product (required for international shipments).
+    # @return [String]
+    attr_accessor :country_of_origin
+
+    # The origin country code of product (required for international shipments).
+    # @return [Array[String]]
+    attr_accessor :epc_list
+
+    # The raw material of product (for product's description in custom).
+    # @return [String]
+    attr_accessor :material
+
+    # The raw material of product (for product's description in custom).
+    # @return [ProductAttributes]
+    attr_accessor :product_attributes
+
+    # Product's main category subject.
+    # @return [String]
+    attr_accessor :product_customs_category
+
+    # A six digit code specified by harmonized system for tariffs (required for
+    # international shipments).
+    # @return [String]
+    attr_accessor :product_hts_number
+
+    # Identifier of the product that is this SalesOrder's line item.
+    # @return [String]
+    attr_accessor :product_id
+
+    # Url of the main image of the product.
+    # @return [String]
+    attr_accessor :product_image_url
+
+    # Human-readable name of the product that is this SalesOrder's line item.
+    # @return [String]
+    attr_accessor :product_name
+
+    # SKU of the product that is this SalesOrder's line item.
+    # @return [String]
+    attr_accessor :product_sku
+
+    # a classification code for exporting goods out of the 
+    # United States. The Schedule B is used to track the amount of trade 
+    #  goods that are being exported from the U.S. The U.S. Census Bureau
+    #  keeps records of the amount of exports by country/quantity, and
+    #  dollar amount.
+    # @return [String]
+    attr_accessor :schedule_b
+
+    # The chosen weight unit (e.g. 'kg').
+    # @return [String]
+    attr_accessor :shipping_weight_unit
+
+    # Weight of the product, numeric value.
+    # @return [Float]
+    attr_accessor :shipping_weight_value
+
+    # New unique item ID(Sales Order Item UUID) after swapping. Should be
+    # generated in sales_order service.
+    # @return [String]
+    attr_accessor :uuid
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['country_of_origin'] = 'country_of_origin'
+      @_hash['epc_list'] = 'epc_list'
+      @_hash['material'] = 'material'
+      @_hash['product_attributes'] = 'product_attributes'
+      @_hash['product_customs_category'] = 'product_customs_category'
+      @_hash['product_hts_number'] = 'product_hts_number'
+      @_hash['product_id'] = 'product_id'
+      @_hash['product_image_url'] = 'product_image_url'
+      @_hash['product_name'] = 'product_name'
+      @_hash['product_sku'] = 'product_sku'
+      @_hash['schedule_b'] = 'schedule_b'
+      @_hash['shipping_weight_unit'] = 'shipping_weight_unit'
+      @_hash['shipping_weight_value'] = 'shipping_weight_value'
+      @_hash['uuid'] = 'uuid'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        country_of_origin
+        epc_list
+        material
+        product_attributes
+        product_customs_category
+        product_hts_number
+        product_id
+        product_image_url
+        product_name
+        product_sku
+        schedule_b
+        shipping_weight_unit
+        shipping_weight_value
+        uuid
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        product_attributes
+      ]
+    end
+
+    def initialize(country_of_origin = SKIP, epc_list = SKIP, material = SKIP,
+                   product_attributes = SKIP, product_customs_category = SKIP,
+                   product_hts_number = SKIP, product_id = SKIP,
+                   product_image_url = SKIP, product_name = SKIP,
+                   product_sku = SKIP, schedule_b = SKIP,
+                   shipping_weight_unit = SKIP, shipping_weight_value = SKIP,
+                   uuid = SKIP)
+      @country_of_origin = country_of_origin unless country_of_origin == SKIP
+      @epc_list = epc_list unless epc_list == SKIP
+      @material = material unless material == SKIP
+      @product_attributes = product_attributes unless product_attributes == SKIP
+      @product_customs_category = product_customs_category unless product_customs_category == SKIP
+      @product_hts_number = product_hts_number unless product_hts_number == SKIP
+      @product_id = product_id unless product_id == SKIP
+      @product_image_url = product_image_url unless product_image_url == SKIP
+      @product_name = product_name unless product_name == SKIP
+      @product_sku = product_sku unless product_sku == SKIP
+      @schedule_b = schedule_b unless schedule_b == SKIP
+      @shipping_weight_unit = shipping_weight_unit unless shipping_weight_unit == SKIP
+      @shipping_weight_value = shipping_weight_value unless shipping_weight_value == SKIP
+      @uuid = uuid unless uuid == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      country_of_origin =
+        hash.key?('country_of_origin') ? hash['country_of_origin'] : SKIP
+      epc_list = hash.key?('epc_list') ? hash['epc_list'] : SKIP
+      material = hash.key?('material') ? hash['material'] : SKIP
+      product_attributes = ProductAttributes.from_hash(hash['product_attributes']) if
+        hash['product_attributes']
+      product_customs_category =
+        hash.key?('product_customs_category') ? hash['product_customs_category'] : SKIP
+      product_hts_number =
+        hash.key?('product_hts_number') ? hash['product_hts_number'] : SKIP
+      product_id = hash.key?('product_id') ? hash['product_id'] : SKIP
+      product_image_url =
+        hash.key?('product_image_url') ? hash['product_image_url'] : SKIP
+      product_name = hash.key?('product_name') ? hash['product_name'] : SKIP
+      product_sku = hash.key?('product_sku') ? hash['product_sku'] : SKIP
+      schedule_b = hash.key?('schedule_b') ? hash['schedule_b'] : SKIP
+      shipping_weight_unit =
+        hash.key?('shipping_weight_unit') ? hash['shipping_weight_unit'] : SKIP
+      shipping_weight_value =
+        hash.key?('shipping_weight_value') ? hash['shipping_weight_value'] : SKIP
+      uuid = hash.key?('uuid') ? hash['uuid'] : SKIP
+
+      # Create object from extracted values.
+      SwapTo.new(country_of_origin,
+                 epc_list,
+                 material,
+                 product_attributes,
+                 product_customs_category,
+                 product_hts_number,
+                 product_id,
+                 product_image_url,
+                 product_name,
+                 product_sku,
+                 schedule_b,
+                 shipping_weight_unit,
+                 shipping_weight_value,
+                 uuid)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [SwapTo | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} country_of_origin: #{@country_of_origin}, epc_list: #{@epc_list}, material:"\
+      " #{@material}, product_attributes: #{@product_attributes}, product_customs_category:"\
+      " #{@product_customs_category}, product_hts_number: #{@product_hts_number}, product_id:"\
+      " #{@product_id}, product_image_url: #{@product_image_url}, product_name: #{@product_name},"\
+      " product_sku: #{@product_sku}, schedule_b: #{@schedule_b}, shipping_weight_unit:"\
+      " #{@shipping_weight_unit}, shipping_weight_value: #{@shipping_weight_value}, uuid:"\
+      " #{@uuid}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} country_of_origin: #{@country_of_origin.inspect}, epc_list:"\
+      " #{@epc_list.inspect}, material: #{@material.inspect}, product_attributes:"\
+      " #{@product_attributes.inspect}, product_customs_category:"\
+      " #{@product_customs_category.inspect}, product_hts_number: #{@product_hts_number.inspect},"\
+      " product_id: #{@product_id.inspect}, product_image_url: #{@product_image_url.inspect},"\
+      " product_name: #{@product_name.inspect}, product_sku: #{@product_sku.inspect}, schedule_b:"\
+      " #{@schedule_b.inspect}, shipping_weight_unit: #{@shipping_weight_unit.inspect},"\
+      " shipping_weight_value: #{@shipping_weight_value.inspect}, uuid: #{@uuid.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/swapped.rb

@@ -0,0 +1,74 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Swapped Model.
+  class Swapped < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[String]]
+    attr_accessor :items
+
+    # The identifier of the logistic order which was created to hold original
+    # items which were replaced by swapping.
+    # @return [String]
+    attr_accessor :logistic_order_uuid
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['items'] = 'items'
+      @_hash['logistic_order_uuid'] = 'logistic_order_uuid'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        items
+        logistic_order_uuid
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(items = SKIP, logistic_order_uuid = SKIP)
+      @items = items unless items == SKIP
+      @logistic_order_uuid = logistic_order_uuid unless logistic_order_uuid == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      items = hash.key?('items') ? hash['items'] : SKIP
+      logistic_order_uuid =
+        hash.key?('logistic_order_uuid') ? hash['logistic_order_uuid'] : SKIP
+
+      # Create object from extracted values.
+      Swapped.new(items,
+                  logistic_order_uuid)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} items: #{@items}, logistic_order_uuid: #{@logistic_order_uuid}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} items: #{@items.inspect}, logistic_order_uuid:"\
+      " #{@logistic_order_uuid.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/sync_job_response.rb

@@ -0,0 +1,136 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module NewStoreApi
+  # Response model for synchronous job creation with immediate results.
+  class SyncJobResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Job creation timestamp (ISO 8601 format)
+    # @return [DateTime]
+    attr_accessor :created_at
+
+    # Query results data
+    # @return [Array[Object]]
+    attr_accessor :data
+
+    # Data format
+    # @return [String]
+    attr_accessor :format
+
+    # Unique job identifier
+    # @return [String]
+    attr_accessor :job_id
+
+    # Job metadata including row_count, execution_time, and query_cost
+    # @return [Object]
+    attr_accessor :metadata
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['created_at'] = 'created_at'
+      @_hash['data'] = 'data'
+      @_hash['format'] = 'format'
+      @_hash['job_id'] = 'job_id'
+      @_hash['metadata'] = 'metadata'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(created_at = nil, data = nil, format = nil, job_id = nil,
+                   metadata = nil)
+      @created_at = created_at
+      @data = data
+      @format = format
+      @job_id = job_id
+      @metadata = metadata
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      created_at = if hash.key?('created_at')
+                     (DateTimeHelper.from_rfc3339(hash['created_at']) if hash['created_at'])
+                   end
+      data = hash.key?('data') ? hash['data'] : nil
+      format = hash.key?('format') ? hash['format'] : nil
+      job_id = hash.key?('job_id') ? hash['job_id'] : nil
+      metadata = hash.key?('metadata') ? hash['metadata'] : nil
+
+      # Create object from extracted values.
+      SyncJobResponse.new(created_at,
+                          data,
+                          format,
+                          job_id,
+                          metadata)
+    end
+
+    def to_custom_created_at
+      DateTimeHelper.to_rfc3339(created_at)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [SyncJobResponse | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.created_at,
+                                ->(val) { val.instance_of? DateTime }) and
+            APIHelper.valid_type?(value.data,
+                                  ->(val) { val.instance_of? Object }) and
+            APIHelper.valid_type?(value.format,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.job_id,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.metadata,
+                                  ->(val) { val.instance_of? Object })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['created_at'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['data'],
+                                ->(val) { val.instance_of? Object }) and
+          APIHelper.valid_type?(value['format'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['job_id'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['metadata'],
+                                ->(val) { val.instance_of? Object })
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} created_at: #{@created_at}, data: #{@data}, format: #{@format}, job_id:"\
+      " #{@job_id}, metadata: #{@metadata}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} created_at: #{@created_at.inspect}, data: #{@data.inspect}, format:"\
+      " #{@format.inspect}, job_id: #{@job_id.inspect}, metadata: #{@metadata.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/tag_response.rb

@@ -0,0 +1,130 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module NewStoreApi
+  # TagResponse Model.
+  class TagResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Timestamp of the tag creation.
+    # @return [DateTime]
+    attr_accessor :created_at
+
+    # The human readable tag identifier.
+    # @return [String]
+    attr_accessor :display_name
+
+    # The tag identifier.
+    # @return [String]
+    attr_accessor :id
+
+    # The import this tag is associated with, if any.
+    # @return [String]
+    attr_accessor :import_id
+
+    # A list of store IDs the tag belongs to. If no store ID is provided, then
+    # the tag is global and will be visible for all the stores.
+    # @return [Array[String]]
+    attr_accessor :store_ids
+
+    # Timestamp of the latest tag update.
+    # @return [DateTime]
+    attr_accessor :updated_at
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['created_at'] = 'created_at'
+      @_hash['display_name'] = 'display_name'
+      @_hash['id'] = 'id'
+      @_hash['import_id'] = 'import_id'
+      @_hash['store_ids'] = 'store_ids'
+      @_hash['updated_at'] = 'updated_at'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        created_at
+        display_name
+        import_id
+        store_ids
+        updated_at
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        import_id
+      ]
+    end
+
+    def initialize(id = nil, created_at = SKIP, display_name = SKIP,
+                   import_id = SKIP, store_ids = SKIP, updated_at = SKIP)
+      @created_at = created_at unless created_at == SKIP
+      @display_name = display_name unless display_name == SKIP
+      @id = id
+      @import_id = import_id unless import_id == SKIP
+      @store_ids = store_ids unless store_ids == SKIP
+      @updated_at = updated_at unless updated_at == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      id = hash.key?('id') ? hash['id'] : nil
+      created_at = if hash.key?('created_at')
+                     (DateTimeHelper.from_rfc3339(hash['created_at']) if hash['created_at'])
+                   else
+                     SKIP
+                   end
+      display_name = hash.key?('display_name') ? hash['display_name'] : SKIP
+      import_id = hash.key?('import_id') ? hash['import_id'] : SKIP
+      store_ids = hash.key?('store_ids') ? hash['store_ids'] : SKIP
+      updated_at = if hash.key?('updated_at')
+                     (DateTimeHelper.from_rfc3339(hash['updated_at']) if hash['updated_at'])
+                   else
+                     SKIP
+                   end
+
+      # Create object from extracted values.
+      TagResponse.new(id,
+                      created_at,
+                      display_name,
+                      import_id,
+                      store_ids,
+                      updated_at)
+    end
+
+    def to_custom_created_at
+      DateTimeHelper.to_rfc3339(created_at)
+    end
+
+    def to_custom_updated_at
+      DateTimeHelper.to_rfc3339(updated_at)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} created_at: #{@created_at}, display_name: #{@display_name}, id: #{@id},"\
+      " import_id: #{@import_id}, store_ids: #{@store_ids}, updated_at: #{@updated_at}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} created_at: #{@created_at.inspect}, display_name: #{@display_name.inspect},"\
+      " id: #{@id.inspect}, import_id: #{@import_id.inspect}, store_ids: #{@store_ids.inspect},"\
+      " updated_at: #{@updated_at.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/task_package.rb

@@ -0,0 +1,77 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # TaskPackage Model.
+  class TaskPackage < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :id
+
+    # TODO: Write general description for this method
+    # @return [Array[TaskPackageItem]]
+    attr_accessor :items
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['items'] = 'items'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = nil, items = nil)
+      @id = id
+      @items = items
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      id = hash.key?('id') ? hash['id'] : nil
+      # Parameter is an array, so we need to iterate through it
+      items = nil
+      unless hash['items'].nil?
+        items = []
+        hash['items'].each do |structure|
+          items << (TaskPackageItem.from_hash(structure) if structure)
+        end
+      end
+
+      items = nil unless hash.key?('items')
+
+      # Create object from extracted values.
+      TaskPackage.new(id,
+                      items)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, items: #{@items}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, items: #{@items.inspect}>"
+    end
+  end
+end