newstore-apimatic-sdk 0.0.1

data/lib/new_store_api/models/profile_response.rb

@@ -0,0 +1,176 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module NewStoreApi
+  # ProfileResponse Model.
+  class ProfileResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Timestamp of the profile creation.
+    # @return [DateTime]
+    attr_accessor :created_at
+
+    # The identifier of the associate creating profile
+    # @return [String]
+    attr_accessor :created_by
+
+    # The human readable profile identifier.
+    # @return [String]
+    attr_accessor :display_id
+
+    # Email of the customer.
+    # @return [String]
+    attr_accessor :email
+
+    # Additional attributes for a customer.
+    # @return [Hash[String, ExtendedAttributeModel]]
+    attr_accessor :extended_attributes
+
+    # First name of the customer.
+    # @return [String]
+    attr_accessor :first_name
+
+    # Full name of the customer, including first, middle and last name.
+    # @return [String]
+    attr_accessor :full_name
+
+    # The profile identifier.
+    # @return [String]
+    attr_accessor :id
+
+    # Last name of the customer.
+    # @return [String]
+    attr_accessor :last_name
+
+    # Phone number of the customer in E.164 format.
+    # @return [String]
+    attr_accessor :phone_number
+
+    # The identifier of the store, profile is being created in.
+    # @return [String]
+    attr_accessor :store_id
+
+    # Timestamp of the latest profile 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['created_by'] = 'created_by'
+      @_hash['display_id'] = 'display_id'
+      @_hash['email'] = 'email'
+      @_hash['extended_attributes'] = 'extended_attributes'
+      @_hash['first_name'] = 'first_name'
+      @_hash['full_name'] = 'full_name'
+      @_hash['id'] = 'id'
+      @_hash['last_name'] = 'last_name'
+      @_hash['phone_number'] = 'phone_number'
+      @_hash['store_id'] = 'store_id'
+      @_hash['updated_at'] = 'updated_at'
+      @_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, created_by = nil, display_id = nil,
+                   email = nil, extended_attributes = nil, first_name = nil,
+                   full_name = nil, id = nil, last_name = nil,
+                   phone_number = nil, store_id = nil, updated_at = nil)
+      @created_at = created_at
+      @created_by = created_by
+      @display_id = display_id
+      @email = email
+      @extended_attributes = extended_attributes
+      @first_name = first_name
+      @full_name = full_name
+      @id = id
+      @last_name = last_name
+      @phone_number = phone_number
+      @store_id = store_id
+      @updated_at = updated_at
+    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
+      created_by = hash.key?('created_by') ? hash['created_by'] : nil
+      display_id = hash.key?('display_id') ? hash['display_id'] : nil
+      email = hash.key?('email') ? hash['email'] : nil
+      extended_attributes = ExtendedAttributeModel.from_hash(hash['extended_attributes']) if
+        hash['extended_attributes']
+
+      extended_attributes = nil unless hash.key?('extended_attributes')
+      first_name = hash.key?('first_name') ? hash['first_name'] : nil
+      full_name = hash.key?('full_name') ? hash['full_name'] : nil
+      id = hash.key?('id') ? hash['id'] : nil
+      last_name = hash.key?('last_name') ? hash['last_name'] : nil
+      phone_number = hash.key?('phone_number') ? hash['phone_number'] : nil
+      store_id = hash.key?('store_id') ? hash['store_id'] : nil
+      updated_at = if hash.key?('updated_at')
+                     (DateTimeHelper.from_rfc3339(hash['updated_at']) if hash['updated_at'])
+                   end
+
+      # Create object from extracted values.
+      ProfileResponse.new(created_at,
+                          created_by,
+                          display_id,
+                          email,
+                          extended_attributes,
+                          first_name,
+                          full_name,
+                          id,
+                          last_name,
+                          phone_number,
+                          store_id,
+                          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}, created_by: #{@created_by}, display_id:"\
+      " #{@display_id}, email: #{@email}, extended_attributes: #{@extended_attributes},"\
+      " first_name: #{@first_name}, full_name: #{@full_name}, id: #{@id}, last_name:"\
+      " #{@last_name}, phone_number: #{@phone_number}, store_id: #{@store_id}, 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}, created_by: #{@created_by.inspect},"\
+      " display_id: #{@display_id.inspect}, email: #{@email.inspect}, extended_attributes:"\
+      " #{@extended_attributes.inspect}, first_name: #{@first_name.inspect}, full_name:"\
+      " #{@full_name.inspect}, id: #{@id.inspect}, last_name: #{@last_name.inspect}, phone_number:"\
+      " #{@phone_number.inspect}, store_id: #{@store_id.inspect}, updated_at:"\
+      " #{@updated_at.inspect}>"
+    end
+  end
+end

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

data/lib/new_store_api/models/provider.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
+  # Provider Model.
+  class Provider < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The alias as specified in Keycloak.
+    # @return [String]
+    attr_accessor :malias
+
+    # The provider, one of: 'auth0', 'microsoft-azure-ad'.
+    # @return [Provider1Enum]
+    attr_accessor :provider
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['malias'] = 'alias'
+      @_hash['provider'] = 'provider'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        malias
+        provider
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(malias = SKIP, provider = SKIP)
+      @malias = malias unless malias == SKIP
+      @provider = provider unless provider == 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.
+      malias = hash.key?('alias') ? hash['alias'] : SKIP
+      provider = hash.key?('provider') ? hash['provider'] : SKIP
+
+      # Create object from extracted values.
+      Provider.new(malias,
+                   provider)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} malias: #{@malias}, provider: #{@provider}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} malias: #{@malias.inspect}, provider: #{@provider.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/provider1_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
+  # The provider, one of: 'auth0', 'microsoft-azure-ad'.
+  class Provider1Enum
+    PROVIDER1_ENUM = [
+      # TODO: Write general description for AUTH0
+      AUTH0 = 'auth0'.freeze,
+
+      # TODO: Write general description for MICROSOFTAZUREAD
+      MICROSOFTAZUREAD = 'microsoft-azure-ad'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      PROVIDER1_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = AUTH0)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'auth0' then AUTH0
+      when 'microsoftazuread' then MICROSOFTAZUREAD
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/new_store_api/models/provider_rate_schema.rb

@@ -0,0 +1,135 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # ProviderRateSchema Model.
+  class ProviderRateSchema < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Carrier specific name that defines the service level. When defining
+    # provider rates with the same shipping provider, the value you specify here
+    # must be unique and should always match the name defined by the shipping
+    # provider API. For example, 'NextDayAirSaver' for UPS and
+    # 'GROUND_HOME_DELIVERY' for FedEx. If no value is provided, NewStore uses
+    # the unique identifier of the provider rate as the default value.
+    # @return [String]
+    attr_accessor :carrier_defined_service_level
+
+    # ID of the provider rate.
+    # @return [String]
+    attr_accessor :id
+
+    # The ID for the provider rate used for the return shipment.
+    # @return [String]
+    attr_accessor :return_provider_rate_id
+
+    # Service level that the provider rate corresponds to.
+    # @return [String]
+    attr_accessor :service_level_id
+
+    # The name of shipping provider associated with this provider rate.
+    # @return [String]
+    attr_accessor :shipping_carrier_name
+
+    # Required for backwards compatibility purposes.
+    # @return [ProviderRateShippingTypeEnum]
+    attr_accessor :shipping_type
+
+    # Flag to indicate if the shipping provider cost is used instead of the
+    # service level cost defined in the fulfillment configuration. If set to
+    # true, the cost quoted by the shipping provider is displayed to the
+    # customer.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :use_as_customer_facing_cost
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['carrier_defined_service_level'] =
+        'carrier_defined_service_level'
+      @_hash['id'] = 'id'
+      @_hash['return_provider_rate_id'] = 'return_provider_rate_id'
+      @_hash['service_level_id'] = 'service_level_id'
+      @_hash['shipping_carrier_name'] = 'shipping_carrier_name'
+      @_hash['shipping_type'] = 'shipping_type'
+      @_hash['use_as_customer_facing_cost'] = 'use_as_customer_facing_cost'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        carrier_defined_service_level
+        return_provider_rate_id
+      ]
+    end
+
+    def initialize(carrier_defined_service_level = nil, id = nil,
+                   return_provider_rate_id = nil, service_level_id = nil,
+                   shipping_carrier_name = nil, shipping_type = nil,
+                   use_as_customer_facing_cost = nil)
+      @carrier_defined_service_level = carrier_defined_service_level
+      @id = id
+      @return_provider_rate_id = return_provider_rate_id
+      @service_level_id = service_level_id
+      @shipping_carrier_name = shipping_carrier_name
+      @shipping_type = shipping_type
+      @use_as_customer_facing_cost = use_as_customer_facing_cost
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      carrier_defined_service_level =
+        hash.key?('carrier_defined_service_level') ? hash['carrier_defined_service_level'] : nil
+      id = hash.key?('id') ? hash['id'] : nil
+      return_provider_rate_id =
+        hash.key?('return_provider_rate_id') ? hash['return_provider_rate_id'] : nil
+      service_level_id =
+        hash.key?('service_level_id') ? hash['service_level_id'] : nil
+      shipping_carrier_name =
+        hash.key?('shipping_carrier_name') ? hash['shipping_carrier_name'] : nil
+      shipping_type = hash.key?('shipping_type') ? hash['shipping_type'] : nil
+      use_as_customer_facing_cost =
+        hash.key?('use_as_customer_facing_cost') ? hash['use_as_customer_facing_cost'] : nil
+
+      # Create object from extracted values.
+      ProviderRateSchema.new(carrier_defined_service_level,
+                             id,
+                             return_provider_rate_id,
+                             service_level_id,
+                             shipping_carrier_name,
+                             shipping_type,
+                             use_as_customer_facing_cost)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} carrier_defined_service_level: #{@carrier_defined_service_level}, id:"\
+      " #{@id}, return_provider_rate_id: #{@return_provider_rate_id}, service_level_id:"\
+      " #{@service_level_id}, shipping_carrier_name: #{@shipping_carrier_name}, shipping_type:"\
+      " #{@shipping_type}, use_as_customer_facing_cost: #{@use_as_customer_facing_cost}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} carrier_defined_service_level: #{@carrier_defined_service_level.inspect},"\
+      " id: #{@id.inspect}, return_provider_rate_id: #{@return_provider_rate_id.inspect},"\
+      " service_level_id: #{@service_level_id.inspect}, shipping_carrier_name:"\
+      " #{@shipping_carrier_name.inspect}, shipping_type: #{@shipping_type.inspect},"\
+      " use_as_customer_facing_cost: #{@use_as_customer_facing_cost.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/provider_rate_shipping_type_enum.rb

@@ -0,0 +1,40 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Required for backwards compatibility purposes.
+  class ProviderRateShippingTypeEnum
+    PROVIDER_RATE_SHIPPING_TYPE_ENUM = [
+      # TODO: Write general description for TRADITIONAL_CARRIER
+      TRADITIONAL_CARRIER = 'traditional_carrier'.freeze,
+
+      # TODO: Write general description for SAME_DAY_DELIVERY
+      SAME_DAY_DELIVERY = 'same_day_delivery'.freeze,
+
+      # TODO: Write general description for IN_STORE_PICK_UP
+      IN_STORE_PICK_UP = 'in_store_pick_up'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      PROVIDER_RATE_SHIPPING_TYPE_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = TRADITIONAL_CARRIER)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'traditional_carrier' then TRADITIONAL_CARRIER
+      when 'same_day_delivery' then SAME_DAY_DELIVERY
+      when 'in_store_pick_up' then IN_STORE_PICK_UP
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/new_store_api/models/put_roles_by_id_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 PutRolesByIdRequest < 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.
+      PutRolesByIdRequest.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/put_routing_ruleset_response.rb

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