Class: Io::Flow::V0::Clients::OrganizationCurrencySettings

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

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ OrganizationCurrencySettings

Returns a new instance of OrganizationCurrencySettings.



1979
1980
1981
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 1979

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

Instance Method Details

#delete_by_id(organization, id) ⇒ Object

Delete the organization currency setting with this id.



2024
2025
2026
2027
2028
2029
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 2024

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)}/currency/settings/#{CGI.escape(id)}").delete
  nil
end

#get(organization, incoming = {}) ⇒ Object

Search organization currency settings. Always paginated.



1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 1984

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) }),
    :base => (x = opts.delete(:base); x.nil? ? nil : HttpClient::Preconditions.assert_class('base', x, String)),
    :target => (x = opts.delete(:target); x.nil? ? nil : HttpClient::Preconditions.assert_class('target', 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)}/currency/settings").with_query(query).get
  r.map { |x| ::Io::Flow::V0::Models::OrganizationCurrencySetting.new(x) }
end

#get_by_id(organization, id) ⇒ Object 



2007
2008
2009
2010
2011
2012
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 2007

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)}/currency/settings/#{CGI.escape(id)}").get
  ::Io::Flow::V0::Models::OrganizationCurrencySetting.new(r)
end

#get_versions(organization, incoming = {}) ⇒ Object

Provides visibility into recent changes of each object, including deletion.



2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 2032

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) }),
    :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)}/currency/settings/versions").with_query(query).get
  r.map { |x| ::Io::Flow::V0::Models::OrganizationCurrencySettingVersion.new(x) }
end

#post(organization, organization_currency_setting_form) ⇒ Object

Create organization currency settings.



2000
2001
2002
2003
2004
2005
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 2000

def post(organization, organization_currency_setting_form)
  HttpClient::Preconditions.assert_class('organization', organization, String)
  (x = organization_currency_setting_form; x.is_a?(::Io::Flow::V0::Models::OrganizationCurrencySettingForm) ? x : ::Io::Flow::V0::Models::OrganizationCurrencySettingForm.new(x))
  r = @client.request("/#{CGI.escape(organization)}/currency/settings").with_json(organization_currency_setting_form.to_json).post
  ::Io::Flow::V0::Models::OrganizationCurrencySetting.new(r)
end

#put_by_id(organization, id, organization_currency_setting_form) ⇒ Object

Update an existing organization currency setting by id.



2015
2016
2017
2018
2019
2020
2021
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 2015

def put_by_id(organization, id, organization_currency_setting_form)
  HttpClient::Preconditions.assert_class('organization', organization, String)
  HttpClient::Preconditions.assert_class('id', id, String)
  (x = organization_currency_setting_form; x.is_a?(::Io::Flow::V0::Models::OrganizationCurrencySettingForm) ? x : ::Io::Flow::V0::Models::OrganizationCurrencySettingForm.new(x))
  r = @client.request("/#{CGI.escape(organization)}/currency/settings/#{CGI.escape(id)}").with_json(organization_currency_setting_form.to_json).put
  ::Io::Flow::V0::Models::OrganizationCurrencySetting.new(r)
end