class Io::Flow::V0::Clients::Exports
Public Class Methods
new(client)
click to toggle source
# File lib/flow_commerce/flow_api_v0_client.rb, line 6860 def initialize(client) @client = HttpClient::Preconditions.assert_class('client', client, ::Io::Flow::V0::Client) end
Public Instance Methods
delete_by_id(organization, id)
click to toggle source
# File lib/flow_commerce/flow_api_v0_client.rb, line 6911 def delete_by_id(organization, id) HttpClient::Preconditions.assert_class('organization', organization, String) HttpClient::Preconditions.assert_class('id', id, String) r = @client.request("/#{CGI.escape(organization)}/exports/#{CGI.escape(id)}").delete nil end
get(organization, incoming={})
click to toggle source
Search exports. Always paginated.
# File lib/flow_commerce/flow_api_v0_client.rb, line 6865 def get(organization, incoming={}) HttpClient::Preconditions.assert_class('organization', organization, String) 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) }), :created_by_user_id => (x = opts.delete(:created_by_user_id); x.nil? ? nil : HttpClient::Preconditions.assert_class('created_by_user_id', x, String)), :discriminator => (x = opts.delete(:discriminator); x.nil? ? nil : HttpClient::Preconditions.assert_class('discriminator', x, 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("/#{CGI.escape(organization)}/exports").with_query(query).get r.map { |x| ::Io::Flow::V0::Models::Export.new(x) } end
get_by_id(organization, id)
click to toggle source
Get a single export.
# File lib/flow_commerce/flow_api_v0_client.rb, line 6904 def get_by_id(organization, id) HttpClient::Preconditions.assert_class('organization', organization, String) HttpClient::Preconditions.assert_class('id', id, String) r = @client.request("/#{CGI.escape(organization)}/exports/#{CGI.escape(id)}").get ::Io::Flow::V0::Models::Export.new(r) end
get_versions(organization, incoming={})
click to toggle source
Provides visibility into recent changes of each export, including deletion.
# File lib/flow_commerce/flow_api_v0_client.rb, line 6889 def get_versions(organization, incoming={}) HttpClient::Preconditions.assert_class('organization', organization, String) 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) }), :export_id => (x = opts.delete(:export_id); x.nil? ? nil : HttpClient::Preconditions.assert_class('export_id', x, Array).map { |v| HttpClient::Preconditions.assert_class('export_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? ? "journal_timestamp" : x), String) }.delete_if { |k, v| v.nil? } r = @client.request("/#{CGI.escape(organization)}/exports/versions").with_query(query).get r.map { |x| ::Io::Flow::V0::Models::ExportVersion.new(x) } end
post(organization, export_form)
click to toggle source
Create an export.
# File lib/flow_commerce/flow_api_v0_client.rb, line 6881 def post(organization, export_form) HttpClient::Preconditions.assert_class('organization', organization, String) (x = export_form; x.is_a?(::Io::Flow::V0::Models::ExportForm) ? x : ::Io::Flow::V0::Models::ExportForm.new(x)) r = @client.request("/#{CGI.escape(organization)}/exports").with_json(export_form.to_json).post ::Io::Flow::V0::Models::Export.new(r) end