newstore-apimatic-sdk 0.0.1

data/lib/new_store_api/models/identity_provider_response.rb

@@ -0,0 +1,101 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Configured identity provider
+  class IdentityProviderResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The unique name of the configured IdP
+    # @return [String]
+    attr_accessor :malias
+
+    # Identity Provider configuration
+    # @return [IdentityProviderConfig]
+    attr_accessor :config
+
+    # Identity Provider configuration
+    # @return [TrueClass | FalseClass]
+    attr_accessor :enabled
+
+    # Supported Protocols for Identity Providers
+    # @return [IdentityProviderProtocolEnum]
+    attr_accessor :protocol
+
+    # Supported Vendors for Identity Providers
+    # @return [IdentityProviderVendorEnum]
+    attr_accessor :vendor
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['malias'] = 'alias'
+      @_hash['config'] = 'config'
+      @_hash['enabled'] = 'enabled'
+      @_hash['protocol'] = 'protocol'
+      @_hash['vendor'] = 'vendor'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        malias
+        config
+        enabled
+        protocol
+        vendor
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(malias = SKIP, config = SKIP, enabled = true,
+                   protocol = SKIP, vendor = SKIP)
+      @malias = malias unless malias == SKIP
+      @config = config unless config == SKIP
+      @enabled = enabled unless enabled == SKIP
+      @protocol = protocol unless protocol == SKIP
+      @vendor = vendor unless vendor == 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
+      config = IdentityProviderConfig.from_hash(hash['config']) if hash['config']
+      enabled = hash['enabled'] ||= true
+      protocol = hash.key?('protocol') ? hash['protocol'] : SKIP
+      vendor = hash.key?('vendor') ? hash['vendor'] : SKIP
+
+      # Create object from extracted values.
+      IdentityProviderResponse.new(malias,
+                                   config,
+                                   enabled,
+                                   protocol,
+                                   vendor)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} malias: #{@malias}, config: #{@config}, enabled: #{@enabled}, protocol:"\
+      " #{@protocol}, vendor: #{@vendor}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} malias: #{@malias.inspect}, config: #{@config.inspect}, enabled:"\
+      " #{@enabled.inspect}, protocol: #{@protocol.inspect}, vendor: #{@vendor.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/identity_provider_vendor_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
+  # Supported Vendors for Identity Providers
+  class IdentityProviderVendorEnum
+    IDENTITY_PROVIDER_VENDOR_ENUM = [
+      # TODO: Write general description for MICROSOFT
+      MICROSOFT = 'MICROSOFT'.freeze,
+
+      # TODO: Write general description for OKTA
+      OKTA = 'OKTA'.freeze,
+
+      # TODO: Write general description for GOOGLE
+      GOOGLE = 'GOOGLE'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      IDENTITY_PROVIDER_VENDOR_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = MICROSOFT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'microsoft' then MICROSOFT
+      when 'okta' then OKTA
+      when 'google' then GOOGLE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/new_store_api/models/identity_providers_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
+  # A list of configured identity providers
+  class IdentityProvidersResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[IdentityProviderResponse]]
+    attr_accessor :items
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['items'] = 'items'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        items
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(items = SKIP)
+      @items = items unless items == 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
+      items = nil
+      unless hash['items'].nil?
+        items = []
+        hash['items'].each do |structure|
+          items << (IdentityProviderResponse.from_hash(structure) if structure)
+        end
+      end
+
+      items = SKIP unless hash.key?('items')
+
+      # Create object from extracted values.
+      IdentityProvidersResponse.new(items)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} items: #{@items}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} items: #{@items.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/import_entity_enum.rb

@@ -0,0 +1,26 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # ImportEntity.
+  class ImportEntityEnum
+    IMPORT_ENTITY_ENUM = [
+      # TODO: Write general description for PRODUCTS
+      PRODUCTS = 'PRODUCTS'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      IMPORT_ENTITY_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = PRODUCTS)
+      return default_value if value.nil?
+
+      default_value
+    end
+  end
+end

data/lib/new_store_api/models/import_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
+  # ImportResponse Model.
+  class ImportResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Timestamp of the import creation.
+    # @return [DateTime]
+    attr_accessor :created_at
+
+    # The human readable import identifier.
+    # @return [String]
+    attr_accessor :display_name
+
+    # The import identifier.
+    # @return [String]
+    attr_accessor :id
+
+    # The s3 URI of the CSV used in the import.
+    # @return [String]
+    attr_accessor :s3_uri
+
+    # The current status of the import.
+    # @return [StatusEnum]
+    attr_accessor :status
+
+    # The notes relating to the status of the import, if it is FAILED or
+    # PARTIALLY_COMPLETED
+    # @return [Array[String]]
+    attr_accessor :status_notes
+
+    # The type of the import.
+    # @return [String]
+    attr_accessor :type
+
+    # 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['s3_uri'] = 's3_uri'
+      @_hash['status'] = 'status'
+      @_hash['status_notes'] = 'status_notes'
+      @_hash['type'] = 'type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        created_at
+        display_name
+        s3_uri
+        status
+        status_notes
+        type
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = nil, created_at = SKIP, display_name = SKIP,
+                   s3_uri = SKIP, status = SKIP, status_notes = SKIP,
+                   type = SKIP)
+      @created_at = created_at unless created_at == SKIP
+      @display_name = display_name unless display_name == SKIP
+      @id = id
+      @s3_uri = s3_uri unless s3_uri == SKIP
+      @status = status unless status == SKIP
+      @status_notes = status_notes unless status_notes == SKIP
+      @type = type unless type == 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
+      s3_uri = hash.key?('s3_uri') ? hash['s3_uri'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      status_notes = hash.key?('status_notes') ? hash['status_notes'] : SKIP
+      type = hash.key?('type') ? hash['type'] : SKIP
+
+      # Create object from extracted values.
+      ImportResponse.new(id,
+                         created_at,
+                         display_name,
+                         s3_uri,
+                         status,
+                         status_notes,
+                         type)
+    end
+
+    def to_custom_created_at
+      DateTimeHelper.to_rfc3339(created_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},"\
+      " s3_uri: #{@s3_uri}, status: #{@status}, status_notes: #{@status_notes}, type: #{@type}>"
+    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}, s3_uri: #{@s3_uri.inspect}, status: #{@status.inspect}, status_notes:"\
+      " #{@status_notes.inspect}, type: #{@type.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/import_schema_created.rb

@@ -0,0 +1,76 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module NewStoreApi
+  # ImportSchemaCreated Model.
+  class ImportSchemaCreated < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # ID of the import schema. It must be unique per tenant and contain only
+    # ASCII characters. F.e UUID4, human readable name without spaces
+    # @return [String]
+    attr_accessor :id
+
+    # Timestamp in RFC3339 format.
+    # @return [DateTime]
+    attr_accessor :last_updated_at
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['last_updated_at'] = 'last_updated_at'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = nil, last_updated_at = nil)
+      @id = id
+      @last_updated_at = last_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.
+      id = hash.key?('id') ? hash['id'] : nil
+      last_updated_at = if hash.key?('last_updated_at')
+                          (DateTimeHelper.from_rfc3339(hash['last_updated_at']) if hash['last_updated_at'])
+                        end
+
+      # Create object from extracted values.
+      ImportSchemaCreated.new(id,
+                              last_updated_at)
+    end
+
+    def to_custom_last_updated_at
+      DateTimeHelper.to_rfc3339(last_updated_at)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, last_updated_at: #{@last_updated_at}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, last_updated_at: #{@last_updated_at.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/import_schema_get.rb

@@ -0,0 +1,83 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module NewStoreApi
+  # ImportSchemaGet Model.
+  class ImportSchemaGet < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_reader :entity
+
+    # ID of the import schema. It must be unique per tenant and contain only
+    # ASCII characters. F.e UUID4, human readable name without spaces
+    # @return [String]
+    attr_accessor :id
+
+    # Timestamp in RFC3339 format.
+    # @return [DateTime]
+    attr_accessor :last_updated_at
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['entity'] = 'entity'
+      @_hash['id'] = 'id'
+      @_hash['last_updated_at'] = 'last_updated_at'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = nil, last_updated_at = nil)
+      @entity = 'PRODUCTS'
+      @id = id
+      @last_updated_at = last_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.
+      id = hash.key?('id') ? hash['id'] : nil
+      last_updated_at = if hash.key?('last_updated_at')
+                          (DateTimeHelper.from_rfc3339(hash['last_updated_at']) if hash['last_updated_at'])
+                        end
+
+      # Create object from extracted values.
+      ImportSchemaGet.new(id,
+                          last_updated_at)
+    end
+
+    def to_custom_last_updated_at
+      DateTimeHelper.to_rfc3339(last_updated_at)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} entity: #{@entity}, id: #{@id}, last_updated_at: #{@last_updated_at}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} entity: #{@entity.inspect}, id: #{@id.inspect}, last_updated_at:"\
+      " #{@last_updated_at.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/import_tag_response.rb

@@ -0,0 +1,143 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module NewStoreApi
+  # ImportTagResponse Model.
+  class ImportTagResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Timestamp of the tag creation.
+    # @return [DateTime]
+    attr_accessor :created_at
+
+    # The number of customers assigned to this tag.
+    # @return [Integer]
+    attr_accessor :customer_count
+
+    # 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['customer_count'] = 'customer_count'
+      @_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
+        customer_count
+        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, customer_count = SKIP,
+                   display_name = SKIP, import_id = SKIP, store_ids = SKIP,
+                   updated_at = SKIP)
+      @created_at = created_at unless created_at == SKIP
+      @customer_count = customer_count unless customer_count == 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
+      customer_count =
+        hash.key?('customer_count') ? hash['customer_count'] : SKIP
+      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.
+      ImportTagResponse.new(id,
+                            created_at,
+                            customer_count,
+                            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}, customer_count: #{@customer_count},"\
+      " 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}, customer_count:"\
+      " #{@customer_count.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