newstore-apimatic-sdk 0.0.1

data/lib/new_store_api/models/post_roles_request.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
+  # Needed for granting permissions per group not individually.
+  class PostRolesRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Name of the role. To be valid, it can't include slashes ('/').
+    # @return [String]
+    attr_accessor :name
+
+    # List of permissions.
+    # @return [Array[Permission]]
+    attr_accessor :permissions
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['permissions'] = 'permissions'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name = nil, permissions = nil)
+      @name = name
+      @permissions = permissions
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      name = hash.key?('name') ? hash['name'] : nil
+      # 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 = nil unless hash.key?('permissions')
+
+      # Create object from extracted values.
+      PostRolesRequest.new(name,
+                           permissions)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name}, permissions: #{@permissions}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name.inspect}, permissions: #{@permissions.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/post_support_users_request.rb

@@ -0,0 +1,90 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # PostSupportUsersRequest Model.
+  class PostSupportUsersRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Email address of the user.
+    # @return [String]
+    attr_accessor :email
+
+    # First name of the user.
+    # @return [String]
+    attr_accessor :first_name
+
+    # IDP user ID.
+    # @return [String]
+    attr_accessor :idp_user_id
+
+    # Last name of the user.
+    # @return [String]
+    attr_accessor :last_name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['email'] = 'email'
+      @_hash['first_name'] = 'first_name'
+      @_hash['idp_user_id'] = 'idp_user_id'
+      @_hash['last_name'] = 'last_name'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        first_name
+        last_name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(email = nil, idp_user_id = nil, first_name = SKIP,
+                   last_name = SKIP)
+      @email = email
+      @first_name = first_name unless first_name == SKIP
+      @idp_user_id = idp_user_id
+      @last_name = last_name unless last_name == 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.
+      email = hash.key?('email') ? hash['email'] : nil
+      idp_user_id = hash.key?('idp_user_id') ? hash['idp_user_id'] : nil
+      first_name = hash.key?('first_name') ? hash['first_name'] : SKIP
+      last_name = hash.key?('last_name') ? hash['last_name'] : SKIP
+
+      # Create object from extracted values.
+      PostSupportUsersRequest.new(email,
+                                  idp_user_id,
+                                  first_name,
+                                  last_name)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} email: #{@email}, first_name: #{@first_name}, idp_user_id: #{@idp_user_id},"\
+      " last_name: #{@last_name}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} email: #{@email.inspect}, first_name: #{@first_name.inspect}, idp_user_id:"\
+      " #{@idp_user_id.inspect}, last_name: #{@last_name.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/post_users_request.rb

@@ -0,0 +1,123 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # PostUsersRequest Model.
+  class PostUsersRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Email address of the user.
+    # @return [String]
+    attr_accessor :email
+
+    # User is managed by an external directory.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :external_directory
+
+    # First name of the user.
+    # @return [String]
+    attr_accessor :first_name
+
+    # Whether the user can login or not.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_active
+
+    # Last name of the user.
+    # @return [String]
+    attr_accessor :last_name
+
+    # Telephone number of the user.
+    # @return [String]
+    attr_accessor :phone
+
+    # List of role names the user is assigned to.
+    # @return [Array[String]]
+    attr_accessor :roles
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['email'] = 'email'
+      @_hash['external_directory'] = 'external_directory'
+      @_hash['first_name'] = 'first_name'
+      @_hash['is_active'] = 'is_active'
+      @_hash['last_name'] = 'last_name'
+      @_hash['phone'] = 'phone'
+      @_hash['roles'] = 'roles'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        external_directory
+        first_name
+        is_active
+        last_name
+        phone
+        roles
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(email = nil, external_directory = SKIP, first_name = SKIP,
+                   is_active = SKIP, last_name = SKIP, phone = SKIP,
+                   roles = SKIP)
+      @email = email
+      @external_directory = external_directory unless external_directory == SKIP
+      @first_name = first_name unless first_name == SKIP
+      @is_active = is_active unless is_active == SKIP
+      @last_name = last_name unless last_name == SKIP
+      @phone = phone unless phone == SKIP
+      @roles = roles unless roles == 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.
+      email = hash.key?('email') ? hash['email'] : nil
+      external_directory =
+        hash.key?('external_directory') ? hash['external_directory'] : SKIP
+      first_name = hash.key?('first_name') ? hash['first_name'] : SKIP
+      is_active = hash.key?('is_active') ? hash['is_active'] : SKIP
+      last_name = hash.key?('last_name') ? hash['last_name'] : SKIP
+      phone = hash.key?('phone') ? hash['phone'] : SKIP
+      roles = hash.key?('roles') ? hash['roles'] : SKIP
+
+      # Create object from extracted values.
+      PostUsersRequest.new(email,
+                           external_directory,
+                           first_name,
+                           is_active,
+                           last_name,
+                           phone,
+                           roles)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} email: #{@email}, external_directory: #{@external_directory}, first_name:"\
+      " #{@first_name}, is_active: #{@is_active}, last_name: #{@last_name}, phone: #{@phone},"\
+      " roles: #{@roles}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} email: #{@email.inspect}, external_directory:"\
+      " #{@external_directory.inspect}, first_name: #{@first_name.inspect}, is_active:"\
+      " #{@is_active.inspect}, last_name: #{@last_name.inspect}, phone: #{@phone.inspect}, roles:"\
+      " #{@roles.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/presigned_url_request.rb

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

data/lib/new_store_api/models/presigned_url_response.rb

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

data/lib/new_store_api/models/price1.rb

@@ -0,0 +1,87 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Price1 Model.
+  class Price1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Gross price for the gift wrapping.
+    # @return [Float]
+    attr_accessor :gross
+
+    # Net price for gift wrapping.
+    # @return [Float]
+    attr_accessor :net
+
+    # Tax amount for the gift wrapping
+    # @return [Float]
+    attr_accessor :tax
+
+    # Tax code (also known as tax class) for gift wrapping.
+    # @return [String]
+    attr_accessor :tax_code
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['gross'] = 'gross'
+      @_hash['net'] = 'net'
+      @_hash['tax'] = 'tax'
+      @_hash['tax_code'] = 'tax_code'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        tax_code
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(gross = nil, net = nil, tax = nil, tax_code = SKIP)
+      @gross = gross
+      @net = net
+      @tax = tax
+      @tax_code = tax_code unless tax_code == 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.
+      gross = hash.key?('gross') ? hash['gross'] : nil
+      net = hash.key?('net') ? hash['net'] : nil
+      tax = hash.key?('tax') ? hash['tax'] : nil
+      tax_code = hash.key?('tax_code') ? hash['tax_code'] : SKIP
+
+      # Create object from extracted values.
+      Price1.new(gross,
+                 net,
+                 tax,
+                 tax_code)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} gross: #{@gross}, net: #{@net}, tax: #{@tax}, tax_code: #{@tax_code}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} gross: #{@gross.inspect}, net: #{@net.inspect}, tax: #{@tax.inspect},"\
+      " tax_code: #{@tax_code.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/price_override.rb

@@ -0,0 +1,88 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # A manual price override applied to an item. The overridden amount is carried
+  # by the sibling `price` field; this object only records why it was applied.
+  class PriceOverride < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Optional free-text note explaining the override.
+    # @return [String]
+    attr_accessor :note
+
+    # Whether the override cites a predefined reason code or a free-text custom
+    # reason.
+    # @return [ReasonTypeEnum]
+    attr_accessor :reason_type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['note'] = 'note'
+      @_hash['reason_type'] = 'reason_type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        note
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        note
+      ]
+    end
+
+    def initialize(reason_type = nil, note = SKIP)
+      @note = note unless note == SKIP
+      @reason_type = reason_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.
+      reason_type = hash.key?('reason_type') ? hash['reason_type'] : nil
+      note = hash.key?('note') ? hash['note'] : SKIP
+
+      # Create object from extracted values.
+      PriceOverride.new(reason_type,
+                        note)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [PriceOverride | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.reason_type,
+                                     ->(val) { ReasonTypeEnum.validate(val) })
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['reason_type'],
+                            ->(val) { ReasonTypeEnum.validate(val) })
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} note: #{@note}, reason_type: #{@reason_type}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} note: #{@note.inspect}, reason_type: #{@reason_type.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/pricing.rb

@@ -0,0 +1,83 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Currency and tax treatment for all prices in the payload.
+  class Pricing < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The currency for all the prices contained within this payload.
+    # @return [Currency1Enum]
+    attr_accessor :currency
+
+    # Specifies whether all item and fulfillment prices include tax
+    # (`tax_included`) or exclude it (`tax_excluded`).
+    # @return [PricingMethodEnum]
+    attr_accessor :method
+
+    # Optional order-level tax exemption to apply to all prices in the payload.
+    # @return [TaxExemption]
+    attr_accessor :tax_exemption
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['currency'] = 'currency'
+      @_hash['method'] = 'method'
+      @_hash['tax_exemption'] = 'tax_exemption'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        tax_exemption
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        tax_exemption
+      ]
+    end
+
+    def initialize(currency = nil, method = nil, tax_exemption = SKIP)
+      @currency = currency
+      @method = method
+      @tax_exemption = tax_exemption unless tax_exemption == 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.
+      currency = hash.key?('currency') ? hash['currency'] : nil
+      method = hash.key?('method') ? hash['method'] : nil
+      tax_exemption = TaxExemption.from_hash(hash['tax_exemption']) if hash['tax_exemption']
+
+      # Create object from extracted values.
+      Pricing.new(currency,
+                  method,
+                  tax_exemption)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} currency: #{@currency}, method: #{@method}, tax_exemption:"\
+      " #{@tax_exemption}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} currency: #{@currency.inspect}, method: #{@method.inspect}, tax_exemption:"\
+      " #{@tax_exemption.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/pricing_method_enum.rb

@@ -0,0 +1,36 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Whether supplied prices include or exclude tax.
+  class PricingMethodEnum
+    PRICING_METHOD_ENUM = [
+      # TODO: Write general description for TAX_INCLUDED
+      TAX_INCLUDED = 'TAX_INCLUDED'.freeze,
+
+      # TODO: Write general description for TAX_EXCLUDED
+      TAX_EXCLUDED = 'TAX_EXCLUDED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      PRICING_METHOD_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = TAX_INCLUDED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'tax_included' then TAX_INCLUDED
+      when 'tax_excluded' then TAX_EXCLUDED
+      else
+        default_value
+      end
+    end
+  end
+end