Class: Io::Flow::V0::Models::FtpFolder

Inherits:
Object
  • Object
show all
Defined in:
lib/flow_commerce/flow_api_v0_client.rb

Overview

The FTP Folder represents a single folder associated with an organization for which we create an external FTP Directory

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(incoming = {}) ⇒ FtpFolder

Returns a new instance of FtpFolder.



33204
33205
33206
33207
33208
33209
33210
33211
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 33204

def initialize(incoming={})
  opts = HttpClient::Helper.symbolize_keys(incoming)
  HttpClient::Preconditions.require_keys(opts, [:id, :path, :webhook], 'FtpFolder')
  @id = HttpClient::Preconditions.assert_class('id', opts.delete(:id), String)
  @path = HttpClient::Preconditions.assert_class('path', opts.delete(:path), String)
  @webhook = HttpClient::Preconditions.assert_boolean('webhook', opts.delete(:webhook))
  @description = (x = opts.delete(:description); x.nil? ? nil : HttpClient::Preconditions.assert_class('description', x, String))
end

Instance Attribute Details

#description ⇒ Object (readonly)

Returns the value of attribute description.



33202
33203
33204
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 33202

def description
  @description
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



33202
33203
33204
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 33202

def id
  @id
end

#path ⇒ Object (readonly)

Returns the value of attribute path.



33202
33203
33204
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 33202

def path
  @path
end

#webhook ⇒ Object (readonly)

Returns the value of attribute webhook.



33202
33203
33204
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 33202

def webhook
  @webhook
end

Instance Method Details

#copy(incoming = {}) ⇒ Object 



33217
33218
33219
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 33217

def copy(incoming={})
  FtpFolder.new(to_hash.merge(HttpClient::Helper.symbolize_keys(incoming)))
end

#to_hash ⇒ Object 



33221
33222
33223
33224
33225
33226
33227
33228
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 33221

def to_hash
  {
    :id => id,
    :path => path,
    :webhook => webhook,
    :description => description
  }
end

#to_json ⇒ Object 



33213
33214
33215
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 33213

def to_json
  JSON.dump(to_hash)
end