Class: Io::Flow::V0::Clients::ScheduledExports

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

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ ScheduledExports

Returns a new instance of ScheduledExports.



6902
6903
6904
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 6902

def initialize(client)
  @client = HttpClient::Preconditions.assert_class('client', client, ::Io::Flow::V0::Client)
end

Instance Method Details

#delete_by_id(id) ⇒ Object 



6941
6942
6943
6944
6945
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 6941

def delete_by_id(id)
  HttpClient::Preconditions.assert_class('id', id, String)
  r = @client.request("/users/scheduled/exports/#{CGI.escape(id)}").delete
  nil
end

#get(incoming = {}) ⇒ Object

Search scheduled exports. Always paginated.



6907
6908
6909
6910
6911
6912
6913
6914
6915
6916
6917
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 6907

def get(incoming={})
  opts = HttpClient::Helper.symbolize_keys(incoming)
  query = {
    :id => (x = opts.delete(:id); x.nil? ? nil : HttpClient::Preconditions.assert_class('id', x, Array).map { |v| HttpClient::Preconditions.assert_class('id', v, String) }),
    :limit => HttpClient::Preconditions.assert_class('limit', (x = opts.delete(:limit); x.nil? ? 25 : x), Integer),
    :offset => HttpClient::Preconditions.assert_class('offset', (x = opts.delete(:offset); x.nil? ? 0 : x), Integer),
    :sort => HttpClient::Preconditions.assert_class('sort', (x = opts.delete(:sort); x.nil? ? "-created_at" : x), String)
  }.delete_if { |k, v| v.nil? }
  r = @client.request("/users/scheduled/exports").with_query(query).get
  r.map { |x| ::Io::Flow::V0::Models::ScheduledExport.new(x) }
end

#get_by_id(id) ⇒ Object

Get a single scheduled export.



6927
6928
6929
6930
6931
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 6927

def get_by_id(id)
  HttpClient::Preconditions.assert_class('id', id, String)
  r = @client.request("/users/scheduled/exports/#{CGI.escape(id)}").get
  ::Io::Flow::V0::Models::ScheduledExport.new(r)
end

#post(scheduled_export_form) ⇒ Object

Create a scheduled export.



6920
6921
6922
6923
6924
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 6920

def post(scheduled_export_form)
  (x = scheduled_export_form; x.is_a?(::Io::Flow::V0::Models::ScheduledExportForm) ? x : ::Io::Flow::V0::Models::ScheduledExportForm.new(x))
  r = @client.request("/users/scheduled/exports").with_json(scheduled_export_form.to_json).post
  ::Io::Flow::V0::Models::ScheduledExport.new(r)
end

#put_by_id(id, scheduled_export_form) ⇒ Object

Update a scheduled export.



6934
6935
6936
6937
6938
6939
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 6934

def put_by_id(id, scheduled_export_form)
  HttpClient::Preconditions.assert_class('id', id, String)
  (x = scheduled_export_form; x.is_a?(::Io::Flow::V0::Models::ScheduledExportForm) ? x : ::Io::Flow::V0::Models::ScheduledExportForm.new(x))
  r = @client.request("/users/scheduled/exports/#{CGI.escape(id)}").with_json(scheduled_export_form.to_json).put
  ::Io::Flow::V0::Models::ScheduledExport.new(r)
end