newstore-apimatic-sdk 0.0.1

data/lib/new_store_api/models/get_shortings_model.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
+  # GetShortingsModel Model.
+  class GetShortingsModel < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :count
+
+    # TODO: Write general description for this method
+    # @return [Array[ShortingModel]]
+    attr_accessor :data
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['count'] = 'count'
+      @_hash['data'] = 'data'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(count = nil, data = nil)
+      @count = count
+      @data = data
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      count = hash.key?('count') ? hash['count'] : nil
+      # Parameter is an array, so we need to iterate through it
+      data = nil
+      unless hash['data'].nil?
+        data = []
+        hash['data'].each do |structure|
+          data << (ShortingModel.from_hash(structure) if structure)
+        end
+      end
+
+      data = nil unless hash.key?('data')
+
+      # Create object from extracted values.
+      GetShortingsModel.new(count,
+                            data)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} count: #{@count}, data: #{@data}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} count: #{@count.inspect}, data: #{@data.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/get_task_model.rb

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

data/lib/new_store_api/models/get_transfer_transaction_response.rb

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

data/lib/new_store_api/models/get_userinfo_response.rb

@@ -0,0 +1,121 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Returns user information including permissions.
+  class GetUserinfoResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # External identifier for the NewStore plattform. Formerly known as
+    # "newstore_id".
+    # @return [String]
+    attr_accessor :associate_id
+
+    # Email address of the user.
+    # @return [String]
+    attr_accessor :email
+
+    # First name of the user.
+    # @return [String]
+    attr_accessor :first_name
+
+    # Identifier of the user.
+    # @return [String]
+    attr_accessor :id
+
+    # Last name of the user.
+    # @return [String]
+    attr_accessor :last_name
+
+    # Last name of the user.
+    # @return [Array[Permission]]
+    attr_accessor :permissions
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['associate_id'] = 'associate_id'
+      @_hash['email'] = 'email'
+      @_hash['first_name'] = 'first_name'
+      @_hash['id'] = 'id'
+      @_hash['last_name'] = 'last_name'
+      @_hash['permissions'] = 'permissions'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        associate_id
+        email
+        first_name
+        id
+        last_name
+        permissions
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(associate_id = SKIP, email = SKIP, first_name = SKIP,
+                   id = SKIP, last_name = SKIP, permissions = SKIP)
+      @associate_id = associate_id unless associate_id == SKIP
+      @email = email unless email == SKIP
+      @first_name = first_name unless first_name == SKIP
+      @id = id unless id == SKIP
+      @last_name = last_name unless last_name == SKIP
+      @permissions = permissions unless permissions == 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.
+      associate_id = hash.key?('associate_id') ? hash['associate_id'] : SKIP
+      email = hash.key?('email') ? hash['email'] : SKIP
+      first_name = hash.key?('first_name') ? hash['first_name'] : SKIP
+      id = hash.key?('id') ? hash['id'] : SKIP
+      last_name = hash.key?('last_name') ? hash['last_name'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      permissions = nil
+      unless hash['permissions'].nil?
+        permissions = []
+        hash['permissions'].each do |structure|
+          permissions << (Permission.from_hash(structure) if structure)
+        end
+      end
+
+      permissions = SKIP unless hash.key?('permissions')
+
+      # Create object from extracted values.
+      GetUserinfoResponse.new(associate_id,
+                              email,
+                              first_name,
+                              id,
+                              last_name,
+                              permissions)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} associate_id: #{@associate_id}, email: #{@email}, first_name:"\
+      " #{@first_name}, id: #{@id}, last_name: #{@last_name}, permissions: #{@permissions}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} associate_id: #{@associate_id.inspect}, email: #{@email.inspect},"\
+      " first_name: #{@first_name.inspect}, id: #{@id.inspect}, last_name: #{@last_name.inspect},"\
+      " permissions: #{@permissions.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/get_users_by_role_response.rb

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

data/lib/new_store_api/models/get_users_response.rb

@@ -0,0 +1,82 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Gets all users
+  class GetUsersResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[User]]
+    attr_accessor :elements
+
+    # Contains default fields for paginatable APIs.
+    # @return [PaginatedResponse]
+    attr_accessor :pagination_info
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['elements'] = 'elements'
+      @_hash['pagination_info'] = 'pagination_info'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        elements
+        pagination_info
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(elements = SKIP, pagination_info = SKIP)
+      @elements = elements unless elements == SKIP
+      @pagination_info = pagination_info unless pagination_info == 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.
+      # Parameter is an array, so we need to iterate through it
+      elements = nil
+      unless hash['elements'].nil?
+        elements = []
+        hash['elements'].each do |structure|
+          elements << (User.from_hash(structure) if structure)
+        end
+      end
+
+      elements = SKIP unless hash.key?('elements')
+      pagination_info = PaginatedResponse.from_hash(hash['pagination_info']) if
+        hash['pagination_info']
+
+      # Create object from extracted values.
+      GetUsersResponse.new(elements,
+                           pagination_info)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} elements: #{@elements}, pagination_info: #{@pagination_info}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} elements: #{@elements.inspect}, pagination_info:"\
+      " #{@pagination_info.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/gift_wrapping.rb

@@ -0,0 +1,128 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # A gift wrapping applied to one or more of the order's line items.
+  class GiftWrapping < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The line items covered by this gift wrapping. Each value must match a
+    # `line_items[].line_item_id` in the same order. Partial gift wrapping is
+    # not yet supported: the gift wrapping must cover every line item in the
+    # order.
+    # @return [Array[String]]
+    attr_accessor :line_item_ids
+
+    # Message to attach to the gift wrapping. Its maximum length is configurable
+    # per tenant.
+    # @return [String]
+    attr_accessor :message
+
+    # The gift wrapping price, in the currency's minor unit. With tax_included
+    # pricing this already contains the tax; with tax_excluded pricing the
+    # customer pays `price` plus `price_tax`.
+    # @return [Integer]
+    attr_accessor :price
+
+    # Total tax amount on the gift wrapping price, in the currency's minor unit.
+    # @return [Integer]
+    attr_accessor :price_tax
+
+    # Tax classification identifier for the gift wrapping.
+    # @return [String]
+    attr_accessor :tax_class
+
+    # Optional breakdown of the taxes that make up `price_tax`.
+    # @return [Array[TaxLine]]
+    attr_accessor :tax_lines
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['line_item_ids'] = 'line_item_ids'
+      @_hash['message'] = 'message'
+      @_hash['price'] = 'price'
+      @_hash['price_tax'] = 'price_tax'
+      @_hash['tax_class'] = 'tax_class'
+      @_hash['tax_lines'] = 'tax_lines'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        message
+        price
+        price_tax
+        tax_class
+        tax_lines
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        message
+        tax_class
+      ]
+    end
+
+    def initialize(line_item_ids = nil, message = SKIP, price = 0,
+                   price_tax = 0, tax_class = SKIP, tax_lines = SKIP)
+      @line_item_ids = line_item_ids
+      @message = message unless message == SKIP
+      @price = price unless price == SKIP
+      @price_tax = price_tax unless price_tax == SKIP
+      @tax_class = tax_class unless tax_class == SKIP
+      @tax_lines = tax_lines unless tax_lines == 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.
+      line_item_ids = hash.key?('line_item_ids') ? hash['line_item_ids'] : nil
+      message = hash.key?('message') ? hash['message'] : SKIP
+      price = hash['price'] ||= 0
+      price_tax = hash['price_tax'] ||= 0
+      tax_class = hash.key?('tax_class') ? hash['tax_class'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      tax_lines = nil
+      unless hash['tax_lines'].nil?
+        tax_lines = []
+        hash['tax_lines'].each do |structure|
+          tax_lines << (TaxLine.from_hash(structure) if structure)
+        end
+      end
+
+      tax_lines = SKIP unless hash.key?('tax_lines')
+
+      # Create object from extracted values.
+      GiftWrapping.new(line_item_ids,
+                       message,
+                       price,
+                       price_tax,
+                       tax_class,
+                       tax_lines)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} line_item_ids: #{@line_item_ids}, message: #{@message}, price: #{@price},"\
+      " price_tax: #{@price_tax}, tax_class: #{@tax_class}, tax_lines: #{@tax_lines}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} line_item_ids: #{@line_item_ids.inspect}, message: #{@message.inspect},"\
+      " price: #{@price.inspect}, price_tax: #{@price_tax.inspect}, tax_class:"\
+      " #{@tax_class.inspect}, tax_lines: #{@tax_lines.inspect}>"
+    end
+  end
+end