Class: Io::Flow::V0::Models::ScheduledExport

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

Overview

Allows a user to create a scheduled export that will be delivered on a schedule (currently only support once / day at a set time)

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(incoming = {}) ⇒ ScheduledExport

Returns a new instance of ScheduledExport.



35795
35796
35797
35798
35799
35800
35801
35802
35803
35804
35805
35806
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 35795

def initialize(incoming={})
  opts = HttpClient::Helper.symbolize_keys(incoming)
  HttpClient::Preconditions.require_keys(opts, [:id, :user, :organization_q, :hour, :minute, :timezone, :types], 'ScheduledExport')
  @id = HttpClient::Preconditions.assert_class('id', opts.delete(:id), String)
  @user = (x = opts.delete(:user); x.is_a?(::Io::Flow::V0::Models::UserReference) ? x : ::Io::Flow::V0::Models::UserReference.new(x))
  @organization_q = HttpClient::Preconditions.assert_class('organization_q', opts.delete(:organization_q), String)
  @hour = HttpClient::Preconditions.assert_class('hour', opts.delete(:hour), Integer)
  @minute = HttpClient::Preconditions.assert_class('minute', opts.delete(:minute), Integer)
  @timezone = HttpClient::Preconditions.assert_class('timezone', opts.delete(:timezone), String)
  @types = HttpClient::Preconditions.assert_class('types', opts.delete(:types), Array).map { |v| (x = v; x.is_a?(::Io::Flow::V0::Models::ExportType) ? x : ::Io::Flow::V0::Models::ExportType.from_json(x)) }
  @last_sent_at = (x = opts.delete(:last_sent_at); x.nil? ? nil : HttpClient::Preconditions.assert_class('last_sent_at', HttpClient::Helper.to_date_time_iso8601(x), DateTime))
end

Instance Attribute Details

#hour ⇒ Object (readonly)

Returns the value of attribute hour.



35793
35794
35795
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 35793

def hour
  @hour
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



35793
35794
35795
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 35793

def id
  @id
end

#last_sent_at ⇒ Object (readonly)

Returns the value of attribute last_sent_at.



35793
35794
35795
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 35793

def last_sent_at
  @last_sent_at
end

#minute ⇒ Object (readonly)

Returns the value of attribute minute.



35793
35794
35795
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 35793

def minute
  @minute
end

#organization_q ⇒ Object (readonly)

Returns the value of attribute organization_q.



35793
35794
35795
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 35793

def organization_q
  @organization_q
end

#timezone ⇒ Object (readonly)

Returns the value of attribute timezone.



35793
35794
35795
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 35793

def timezone
  @timezone
end

#types ⇒ Object (readonly)

Returns the value of attribute types.



35793
35794
35795
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 35793

def types
  @types
end

#user ⇒ Object (readonly)

Returns the value of attribute user.



35793
35794
35795
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 35793

def user
  @user
end

Instance Method Details

#copy(incoming = {}) ⇒ Object 



35812
35813
35814
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 35812

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

#to_hash ⇒ Object 



35816
35817
35818
35819
35820
35821
35822
35823
35824
35825
35826
35827
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 35816

def to_hash
  {
    :id => id,
    :user => user.to_hash,
    :organization_q => organization_q,
    :hour => hour,
    :minute => minute,
    :timezone => timezone,
    :types => types.map { |o| o.to_hash },
    :last_sent_at => last_sent_at
  }
end

#to_json ⇒ Object 



35808
35809
35810
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 35808

def to_json
  JSON.dump(to_hash)
end