Class: Cloudxls

Inherits:
Object
  • Object
show all
Defined in:
lib/cloudxls.rb,
lib/cloudxls/version.rb

Defined Under Namespace

Modules: BaseRequest Classes: ApiError, ReadRequest, WriteRequest

Constant Summary collapse

VERSION = 
'2.0.0'

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.api_base ⇒ Object

Returns the value of attribute api_base.



17
18
19
 
# File 'lib/cloudxls.rb', line 17

def api_base
  @api_base
end

.api_key ⇒ Object

Returns the value of attribute api_key.



17
18
19
 
# File 'lib/cloudxls.rb', line 17

def api_key
  @api_key
end

.api_version ⇒ Object

Returns the value of attribute api_version.



17
18
19
 
# File 'lib/cloudxls.rb', line 17

def api_version
  @api_version
end

.port ⇒ Object

Returns the value of attribute port.



17
18
19
 
# File 'lib/cloudxls.rb', line 17

def port
  @port
end

.sandbox_base ⇒ Object

Returns the value of attribute sandbox_base.



17
18
19
 
# File 'lib/cloudxls.rb', line 17

def sandbox_base
  @sandbox_base
end

Class Method Details

.client_options ⇒ Object 



23
24
25
26
27
28
29
30
 
# File 'lib/cloudxls.rb', line 23

def client_options
  {
    api_key: self.api_key,
    api_version: self.api_version,
    api_base: self.api_base,
    port: 443
  }
end

.read(params = nil) ⇒ WriteRequest

Initializes a Read request

Parameters:

  • params (Hash) (defaults to: nil) —

    request parameters as

Returns:



46
47
48
 
# File 'lib/cloudxls.rb', line 46

def read(params = nil)
  ReadRequest.new(client_options).add_data(params)
end

.write(params = nil) ⇒ WriteRequest

Initializes a Write request

Parameters:

  • params (Hash) (defaults to: nil) —

    request parameters as

Returns:



37
38
39
 
# File 'lib/cloudxls.rb', line 37

def write(params = nil)
  WriteRequest.new(client_options).add_data(params)
end