newstore-apimatic-sdk 0.0.1

data/lib/new_store_api/models/get_client_response.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
+  # Returns API client for the tenant.
+  class GetClientResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # access token validity in seconds
+    # @return [Integer]
+    attr_accessor :access_token_ttl
+
+    # access token validity in seconds
+    # @return [String]
+    attr_accessor :description
+
+    # access token validity in seconds
+    # @return [String]
+    attr_accessor :name
+
+    # access token validity in seconds
+    # @return [Array[String]]
+    attr_accessor :scopes
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['access_token_ttl'] = 'access_token_ttl'
+      @_hash['description'] = 'description'
+      @_hash['name'] = 'name'
+      @_hash['scopes'] = 'scopes'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        access_token_ttl
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(description = nil, name = nil, scopes = nil,
+                   access_token_ttl = SKIP)
+      @access_token_ttl = access_token_ttl unless access_token_ttl == SKIP
+      @description = description
+      @name = name
+      @scopes = scopes
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      description = hash.key?('description') ? hash['description'] : nil
+      name = hash.key?('name') ? hash['name'] : nil
+      scopes = hash.key?('scopes') ? hash['scopes'] : nil
+      access_token_ttl =
+        hash.key?('access_token_ttl') ? hash['access_token_ttl'] : SKIP
+
+      # Create object from extracted values.
+      GetClientResponse.new(description,
+                            name,
+                            scopes,
+                            access_token_ttl)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} access_token_ttl: #{@access_token_ttl}, description: #{@description}, name:"\
+      " #{@name}, scopes: #{@scopes}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} access_token_ttl: #{@access_token_ttl.inspect}, description:"\
+      " #{@description.inspect}, name: #{@name.inspect}, scopes: #{@scopes.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/get_clients_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 available API clients
+  class GetClientsResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[Item1]]
+    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 << (Item1.from_hash(structure) if structure)
+        end
+      end
+
+      items = SKIP unless hash.key?('items')
+
+      # Create object from extracted values.
+      GetClientsResponse.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/get_config_response.rb

@@ -0,0 +1,78 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Identity configuration.
+  class GetConfigResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The URI of the issuer, for example:
+    # 'https://id.s.newstore.net/auth/realms/dodici'.
+    # @return [String]
+    attr_accessor :issuer
+
+    # A list of all brokered identity providers.
+    # @return [Array[Provider]]
+    attr_accessor :providers
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['issuer'] = 'issuer'
+      @_hash['providers'] = 'providers'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(issuer = nil, providers = nil)
+      @issuer = issuer
+      @providers = providers
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      issuer = hash.key?('issuer') ? hash['issuer'] : nil
+      # Parameter is an array, so we need to iterate through it
+      providers = nil
+      unless hash['providers'].nil?
+        providers = []
+        hash['providers'].each do |structure|
+          providers << (Provider.from_hash(structure) if structure)
+        end
+      end
+
+      providers = nil unless hash.key?('providers')
+
+      # Create object from extracted values.
+      GetConfigResponse.new(issuer,
+                            providers)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} issuer: #{@issuer}, providers: #{@providers}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} issuer: #{@issuer.inspect}, providers: #{@providers.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/get_notifications_response.rb

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

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

data/lib/new_store_api/models/get_return_receipt_request.rb

@@ -0,0 +1,81 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # request payload to get a return receipt document
+  class GetReturnReceiptRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Identifier for the corresponding sales_order
+    # @return [String]
+    attr_accessor :order_id
+
+    # Type of the receipt printing operation (document_printed,
+    # document_emailed).
+    # @return [String]
+    attr_accessor :print_type
+
+    # The identifier of the refund related to this return receipt.
+    # @return [String]
+    attr_accessor :refund_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['order_id'] = 'order_id'
+      @_hash['print_type'] = 'print_type'
+      @_hash['refund_id'] = 'refund_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        print_type
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(order_id = nil, refund_id = nil, print_type = SKIP)
+      @order_id = order_id
+      @print_type = print_type unless print_type == SKIP
+      @refund_id = refund_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.
+      order_id = hash.key?('order_id') ? hash['order_id'] : nil
+      refund_id = hash.key?('refund_id') ? hash['refund_id'] : nil
+      print_type = hash.key?('print_type') ? hash['print_type'] : SKIP
+
+      # Create object from extracted values.
+      GetReturnReceiptRequest.new(order_id,
+                                  refund_id,
+                                  print_type)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} order_id: #{@order_id}, print_type: #{@print_type}, refund_id:"\
+      " #{@refund_id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} order_id: #{@order_id.inspect}, print_type: #{@print_type.inspect},"\
+      " refund_id: #{@refund_id.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/get_roles_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
+  # Returns a list of roles.
+  class GetRolesResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[RoleItem]]
+    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 << (RoleItem.from_hash(structure) if structure)
+        end
+      end
+
+      elements = SKIP unless hash.key?('elements')
+
+      # Create object from extracted values.
+      GetRolesResponse.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_scopes_response.rb

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