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.



3873
3874
3875
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 3873

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

Instance Method Details

#delete_by_id(id) ⇒ Object 



3912
3913
3914
3915
3916
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 3912

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.



3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 3878

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 excheduled export.



3898
3899
3900
3901
3902
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 3898

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.



3891
3892
3893
3894
3895
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 3891

def post(scheduled_export_form)
  HttpClient::Preconditions.assert_class('scheduled_export_form', scheduled_export_form, ::Io::Flow::V0::Models::ScheduledExportForm)
  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.



3905
3906
3907
3908
3909
3910
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 3905

def put_by_id(id, scheduled_export_form)
  HttpClient::Preconditions.assert_class('id', id, String)
  HttpClient::Preconditions.assert_class('scheduled_export_form', scheduled_export_form, ::Io::Flow::V0::Models::ScheduledExportForm)
  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