Class: Io::Flow::V0::Clients::Experiences
- Inherits:
-
Object
- Object
- Io::Flow::V0::Clients::Experiences
- Defined in:
- lib/flow_commerce/flow_api_v0_client.rb
Instance Method Summary collapse
-
#delete_by_key(organization, key) ⇒ Object
Delete the experience with this key.
- #delete_margins_by_experience_key_and_key(organization, experience_key, key) ⇒ Object
- #delete_price_and_books_by_experience_key_and_key(organization, experience_key, key) ⇒ Object
-
#get(organization, incoming = {}) ⇒ Object
Search experiences.
-
#get_by_key(organization, key) ⇒ Object
Returns information about a specific experience.
-
#get_conversions_by_base_and_amount(organization, base, amount, incoming = {}) ⇒ Object
Formats the requested amount using the formatting settings for the experience.
- #get_currency_and_formats_by_experience_key(organization, experience_key) ⇒ Object
-
#get_items(organization, incoming = {}) ⇒ Object
Returns localized information about 1 or more items.
-
#get_items_and_price_by_key_and_number(organization, key, number) ⇒ Object
Returns detailed information on the pricing of this item within this experience.
-
#get_items_by_number(organization, number, incoming = {}) ⇒ Object
Returns information about this item localized based on the query parameters.
- #get_margins_and_versions_by_experience_key(organization, experience_key, incoming = {}) ⇒ Object
- #get_margins_by_experience_key(organization, experience_key, incoming = {}) ⇒ Object
- #get_margins_by_experience_key_and_key(organization, experience_key, key) ⇒ Object
- #get_payment_and_method_and_rules_by_experience_key(organization, experience_key, incoming = {}) ⇒ Object
- #get_payment_method_types_by_experience_key(organization, experience_key, incoming = {}) ⇒ Object
- #get_price_and_books_by_experience_key(organization, experience_key, incoming = {}) ⇒ Object
- #get_price_and_books_by_experience_key_and_key(organization, experience_key, key) ⇒ Object
-
#get_pricing_by_key(organization, key) ⇒ Object
Get the pricing settings for this experience.
-
#get_promotions_and_available_by_key(organization, key) ⇒ Object
Get available promotions for the experience.
-
#get_versions(organization, incoming = {}) ⇒ Object
Provides visibility into recent changes of each object, including deletion.
-
#initialize(client) ⇒ Experiences
constructor
A new instance of Experiences.
-
#post(organization, experience_form) ⇒ Object
Add experience.
- #post_margins_by_experience_key(organization, experience_key, item_margin_post_form) ⇒ Object
- #post_price_and_books_by_experience_key(organization, experience_key, experience_price_book_mapping_form) ⇒ Object
-
#put_by_key(organization, key, experience_form) ⇒ Object
Update experience with the specified key, creating if it does not exist.
- #put_currency_and_formats_by_experience_key(organization, experience_key, experience_currency_format_form) ⇒ Object
- #put_margins_by_experience_key_and_key(organization, experience_key, key, item_margin_put_form) ⇒ Object
-
#put_payment_and_method_and_rules_by_experience_key(organization, experience_key, experience_payment_method_rule_forms) ⇒ Object
Change the ordering or payment tags for an experience.
-
#put_pricing_by_key(organization, key, pricing) ⇒ Object
Update the pricing settings for this experience.
-
#put_status_by_key(organization, key, experience_status_form) ⇒ Object
Updates the status of a given experience.
Constructor Details
#initialize(client) ⇒ Experiences
Returns a new instance of Experiences.
752 753 754 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 752 def initialize(client) @client = HttpClient::Preconditions.assert_class('client', client, ::Io::Flow::V0::Client) end |
Instance Method Details
#delete_by_key(organization, key) ⇒ Object
Delete the experience with this key
956 957 958 959 960 961 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 956 def delete_by_key(organization, key) HttpClient::Preconditions.assert_class('organization', organization, String) HttpClient::Preconditions.assert_class('key', key, String) r = @client.request("/#{CGI.escape(organization)}/experiences/#{CGI.escape(key)}").delete nil end |
#delete_margins_by_experience_key_and_key(organization, experience_key, key) ⇒ Object
838 839 840 841 842 843 844 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 838 def delete_margins_by_experience_key_and_key(organization, experience_key, key) HttpClient::Preconditions.assert_class('organization', organization, String) HttpClient::Preconditions.assert_class('experience_key', experience_key, String) HttpClient::Preconditions.assert_class('key', key, String) r = @client.request("/#{CGI.escape(organization)}/experiences/#{CGI.escape(experience_key)}/margins/#{CGI.escape(key)}").delete nil end |
#delete_price_and_books_by_experience_key_and_key(organization, experience_key, key) ⇒ Object
930 931 932 933 934 935 936 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 930 def delete_price_and_books_by_experience_key_and_key(organization, experience_key, key) HttpClient::Preconditions.assert_class('organization', organization, String) HttpClient::Preconditions.assert_class('experience_key', experience_key, String) HttpClient::Preconditions.assert_class('key', key, String) r = @client.request("/#{CGI.escape(organization)}/experiences/#{CGI.escape(experience_key)}/price/books/#{CGI.escape(key)}").delete nil end |
#get(organization, incoming = {}) ⇒ Object
Search experiences. Always paginated.
757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 757 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) }), :key => (x = opts.delete(:key); x.nil? ? nil : HttpClient::Preconditions.assert_class('key', x, Array).map { |v| HttpClient::Preconditions.assert_class('key', v, String) }), :name => (x = opts.delete(:name); x.nil? ? nil : HttpClient::Preconditions.assert_class('name', x, String)), :region => (x = opts.delete(:region); x.nil? ? nil : HttpClient::Preconditions.assert_class('region', x, String)), :currency => (x = opts.delete(:currency); x.nil? ? nil : HttpClient::Preconditions.assert_class('currency', x, String)), :subcatalog => (x = opts.delete(:subcatalog); x.nil? ? nil : HttpClient::Preconditions.assert_class('subcatalog', x, String)), :ip => (x = opts.delete(:ip); x.nil? ? nil : HttpClient::Preconditions.assert_class('ip', 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? ? "name" : x), String) }.delete_if { |k, v| v.nil? } r = @client.request("/#{CGI.escape(organization)}/experiences").with_query(query).get r.map { |x| ::Io::Flow::V0::Models::Experience.new(x) } end |
#get_by_key(organization, key) ⇒ Object
Returns information about a specific experience.
939 940 941 942 943 944 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 939 def get_by_key(organization, key) HttpClient::Preconditions.assert_class('organization', organization, String) HttpClient::Preconditions.assert_class('key', key, String) r = @client.request("/#{CGI.escape(organization)}/experiences/#{CGI.escape(key)}").get ::Io::Flow::V0::Models::Experience.new(r) end |
#get_conversions_by_base_and_amount(organization, base, amount, incoming = {}) ⇒ Object
Formats the requested amount using the formatting settings for the experience.
1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 1009 def get_conversions_by_base_and_amount(organization, base, amount, incoming={}) HttpClient::Preconditions.assert_class('organization', organization, String) HttpClient::Preconditions.assert_class('base', base, String) HttpClient::Preconditions.assert_class('amount', amount, String) opts = HttpClient::Helper.symbolize_keys(incoming) query = { :experience => (x = opts.delete(:experience); x.nil? ? nil : HttpClient::Preconditions.assert_class('experience', x, String)), :country => (x = opts.delete(:country); x.nil? ? nil : HttpClient::Preconditions.assert_class('country', x, String)), :ip => (x = opts.delete(:ip); x.nil? ? nil : HttpClient::Preconditions.assert_class('ip', x, String)), :currency => (x = opts.delete(:currency); x.nil? ? nil : HttpClient::Preconditions.assert_class('currency', x, String)) }.delete_if { |k, v| v.nil? } r = @client.request("/#{CGI.escape(organization)}/experiences/conversions/#{CGI.escape(base)}/#{CGI.escape(amount)}").with_query(query).get ::Io::Flow::V0::Models::PriceWithBase.new(r) end |
#get_currency_and_formats_by_experience_key(organization, experience_key) ⇒ Object
784 785 786 787 788 789 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 784 def get_currency_and_formats_by_experience_key(organization, experience_key) HttpClient::Preconditions.assert_class('organization', organization, String) HttpClient::Preconditions.assert_class('experience_key', experience_key, String) r = @client.request("/#{CGI.escape(organization)}/experiences/#{CGI.escape(experience_key)}/currency/formats").get ::Io::Flow::V0::Models::ExperienceCurrencyFormat.new(r) end |
#get_items(organization, incoming = {}) ⇒ Object
Returns localized information about 1 or more items. The items will be localized based on the experience selected by the query parameters in the order of experience, then country, then ip address.
1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 1027 def get_items(organization, incoming={}) HttpClient::Preconditions.assert_class('organization', organization, String) opts = HttpClient::Helper.symbolize_keys(incoming) query = { :number => (x = opts.delete(:number); x.nil? ? nil : HttpClient::Preconditions.assert_class('number', x, Array).map { |v| HttpClient::Preconditions.assert_class('number', v, String) }), :status => (x = opts.delete(:status); x.nil? ? nil : HttpClient::Preconditions.assert_class('status', x, Array).map { |v| (x = v; x.is_a?(::Io::Flow::V0::Models::SubcatalogItemStatus) ? x : ::Io::Flow::V0::Models::SubcatalogItemStatus.apply(x)).value }), :experience => (x = opts.delete(:experience); x.nil? ? nil : HttpClient::Preconditions.assert_class('experience', x, String)), :country => (x = opts.delete(:country); x.nil? ? nil : HttpClient::Preconditions.assert_class('country', x, String)), :ip => (x = opts.delete(:ip); x.nil? ? nil : HttpClient::Preconditions.assert_class('ip', x, String)), :currency => (x = opts.delete(:currency); x.nil? ? nil : HttpClient::Preconditions.assert_class('currency', x, String)), :language => (x = opts.delete(:language); x.nil? ? nil : HttpClient::Preconditions.assert_class('language', 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)}/experiences/items").with_query(query).get r.map { |x| ::Io::Flow::V0::Models::Item.new(x) } end |
#get_items_and_price_by_key_and_number(organization, key, number) ⇒ Object
Returns detailed information on the pricing of this item within this experience
965 966 967 968 969 970 971 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 965 def get_items_and_price_by_key_and_number(organization, key, number) HttpClient::Preconditions.assert_class('organization', organization, String) HttpClient::Preconditions.assert_class('key', key, String) HttpClient::Preconditions.assert_class('number', number, String) r = @client.request("/#{CGI.escape(organization)}/experiences/#{CGI.escape(key)}/items/#{CGI.escape(number)}/price").get ::Io::Flow::V0::Models::PriceCheck.new(r) end |
#get_items_by_number(organization, number, incoming = {}) ⇒ Object
Returns information about this item localized based on the query parameters
1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 1047 def get_items_by_number(organization, number, incoming={}) HttpClient::Preconditions.assert_class('organization', organization, String) HttpClient::Preconditions.assert_class('number', number, String) opts = HttpClient::Helper.symbolize_keys(incoming) query = { :experience => (x = opts.delete(:experience); x.nil? ? nil : HttpClient::Preconditions.assert_class('experience', x, String)), :country => (x = opts.delete(:country); x.nil? ? nil : HttpClient::Preconditions.assert_class('country', x, String)), :ip => (x = opts.delete(:ip); x.nil? ? nil : HttpClient::Preconditions.assert_class('ip', x, String)), :currency => (x = opts.delete(:currency); x.nil? ? nil : HttpClient::Preconditions.assert_class('currency', x, String)), :language => (x = opts.delete(:language); x.nil? ? nil : HttpClient::Preconditions.assert_class('language', x, String)) }.delete_if { |k, v| v.nil? } r = @client.request("/#{CGI.escape(organization)}/experiences/items/#{CGI.escape(number)}").with_query(query).get ::Io::Flow::V0::Models::Item.new(r) end |
#get_margins_and_versions_by_experience_key(organization, experience_key, incoming = {}) ⇒ Object
846 847 848 849 850 851 852 853 854 855 856 857 858 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 846 def get_margins_and_versions_by_experience_key(organization, experience_key, incoming={}) HttpClient::Preconditions.assert_class('organization', organization, String) HttpClient::Preconditions.assert_class('experience_key', experience_key, 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)}/experiences/#{CGI.escape(experience_key)}/margins/versions").with_query(query).get r.map { |x| ::Io::Flow::V0::Models::ItemMarginVersion.new(x) } end |
#get_margins_by_experience_key(organization, experience_key, incoming = {}) ⇒ Object
799 800 801 802 803 804 805 806 807 808 809 810 811 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 799 def get_margins_by_experience_key(organization, experience_key, incoming={}) HttpClient::Preconditions.assert_class('organization', organization, String) HttpClient::Preconditions.assert_class('experience_key', experience_key, 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? ? "name" : x), String) }.delete_if { |k, v| v.nil? } r = @client.request("/#{CGI.escape(organization)}/experiences/#{CGI.escape(experience_key)}/margins").with_query(query).get r.map { |x| ::Io::Flow::V0::Models::ItemMargin.new(x) } end |
#get_margins_by_experience_key_and_key(organization, experience_key, key) ⇒ Object
821 822 823 824 825 826 827 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 821 def get_margins_by_experience_key_and_key(organization, experience_key, key) HttpClient::Preconditions.assert_class('organization', organization, String) HttpClient::Preconditions.assert_class('experience_key', experience_key, String) HttpClient::Preconditions.assert_class('key', key, String) r = @client.request("/#{CGI.escape(organization)}/experiences/#{CGI.escape(experience_key)}/margins/#{CGI.escape(key)}").get ::Io::Flow::V0::Models::ItemMargin.new(r) end |
#get_payment_and_method_and_rules_by_experience_key(organization, experience_key, incoming = {}) ⇒ Object
872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 872 def get_payment_and_method_and_rules_by_experience_key(organization, experience_key, incoming={}) HttpClient::Preconditions.assert_class('organization', organization, String) HttpClient::Preconditions.assert_class('experience_key', experience_key, String) opts = HttpClient::Helper.symbolize_keys(incoming) query = { :payment_method_type => (x = opts.delete(:payment_method_type); x.nil? ? nil : HttpClient::Preconditions.assert_class('payment_method_type', x, Array).map { |v| (x = v; x.is_a?(::Io::Flow::V0::Models::PaymentMethodType) ? x : ::Io::Flow::V0::Models::PaymentMethodType.apply(x)).value }), :tags => (x = opts.delete(:tags); x.nil? ? nil : HttpClient::Preconditions.assert_class('tags', x, Array).map { |v| HttpClient::Preconditions.assert_class('tags', v, String) }), :amount => (x = opts.delete(:amount); x.nil? ? nil : HttpClient::Preconditions.assert_class('amount', x, String)), :currency => (x = opts.delete(:currency); x.nil? ? nil : HttpClient::Preconditions.assert_class('currency', 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? ? "display_position" : x), String) }.delete_if { |k, v| v.nil? } r = @client.request("/#{CGI.escape(organization)}/experiences/#{CGI.escape(experience_key)}/payment/method/rules").with_query(query).get r.map { |x| ::Io::Flow::V0::Models::PaymentMethodRule.new(x) } end |
#get_payment_method_types_by_experience_key(organization, experience_key, incoming = {}) ⇒ Object
860 861 862 863 864 865 866 867 868 869 870 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 860 def get_payment_method_types_by_experience_key(organization, experience_key, incoming={}) HttpClient::Preconditions.assert_class('organization', organization, String) HttpClient::Preconditions.assert_class('experience_key', experience_key, String) opts = HttpClient::Helper.symbolize_keys(incoming) query = { :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) }.delete_if { |k, v| v.nil? } r = @client.request("/#{CGI.escape(organization)}/experiences/#{CGI.escape(experience_key)}/payment-method-types").with_query(query).get r.map { |x| ::Io::Flow::V0::Models::PaymentMethodType.new(x) } end |
#get_price_and_books_by_experience_key(organization, experience_key, incoming = {}) ⇒ Object
899 900 901 902 903 904 905 906 907 908 909 910 911 912 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 899 def get_price_and_books_by_experience_key(organization, experience_key, incoming={}) HttpClient::Preconditions.assert_class('organization', organization, String) HttpClient::Preconditions.assert_class('experience_key', experience_key, 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) }), :price_book_key => (x = opts.delete(:price_book_key); x.nil? ? nil : HttpClient::Preconditions.assert_class('price_book_key', x, Array).map { |v| HttpClient::Preconditions.assert_class('price_book_key', 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? ? "position" : x), String) }.delete_if { |k, v| v.nil? } r = @client.request("/#{CGI.escape(organization)}/experiences/#{CGI.escape(experience_key)}/price/books").with_query(query).get r.map { |x| ::Io::Flow::V0::Models::ExperiencePriceBookMapping.new(x) } end |
#get_price_and_books_by_experience_key_and_key(organization, experience_key, key) ⇒ Object
922 923 924 925 926 927 928 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 922 def get_price_and_books_by_experience_key_and_key(organization, experience_key, key) HttpClient::Preconditions.assert_class('organization', organization, String) HttpClient::Preconditions.assert_class('experience_key', experience_key, String) HttpClient::Preconditions.assert_class('key', key, String) r = @client.request("/#{CGI.escape(organization)}/experiences/#{CGI.escape(experience_key)}/price/books/#{CGI.escape(key)}").get ::Io::Flow::V0::Models::ExperiencePriceBookMapping.new(r) end |
#get_pricing_by_key(organization, key) ⇒ Object
Get the pricing settings for this experience
974 975 976 977 978 979 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 974 def get_pricing_by_key(organization, key) HttpClient::Preconditions.assert_class('organization', organization, String) HttpClient::Preconditions.assert_class('key', key, String) r = @client.request("/#{CGI.escape(organization)}/experiences/#{CGI.escape(key)}/pricing").get ::Io::Flow::V0::Models::Pricing.new(r) end |
#get_promotions_and_available_by_key(organization, key) ⇒ Object
Get available promotions for the experience
991 992 993 994 995 996 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 991 def get_promotions_and_available_by_key(organization, key) HttpClient::Preconditions.assert_class('organization', organization, String) HttpClient::Preconditions.assert_class('key', key, String) r = @client.request("/#{CGI.escape(organization)}/experiences/#{CGI.escape(key)}/promotions/available").get r.map { |x| ::Io::Flow::V0::Models::Promotion.from_json(x) } end |
#get_versions(organization, incoming = {}) ⇒ Object
Provides visibility into recent changes of each object, including deletion
1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 1063 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) }), :key => (x = opts.delete(:key); x.nil? ? nil : HttpClient::Preconditions.assert_class('key', x, Array).map { |v| HttpClient::Preconditions.assert_class('key', 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)}/experiences/versions").with_query(query).get r.map { |x| ::Io::Flow::V0::Models::ExperienceVersion.new(x) } end |
#post(organization, experience_form) ⇒ Object
Add experience
777 778 779 780 781 782 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 777 def post(organization, experience_form) HttpClient::Preconditions.assert_class('organization', organization, String) (x = experience_form; x.is_a?(::Io::Flow::V0::Models::ExperienceForm) ? x : ::Io::Flow::V0::Models::ExperienceForm.new(x)) r = @client.request("/#{CGI.escape(organization)}/experiences").with_json(experience_form.to_json).post ::Io::Flow::V0::Models::Experience.new(r) end |
#post_margins_by_experience_key(organization, experience_key, item_margin_post_form) ⇒ Object
813 814 815 816 817 818 819 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 813 def post_margins_by_experience_key(organization, experience_key, item_margin_post_form) HttpClient::Preconditions.assert_class('organization', organization, String) HttpClient::Preconditions.assert_class('experience_key', experience_key, String) (x = item_margin_post_form; x.is_a?(::Io::Flow::V0::Models::ItemMarginPostForm) ? x : ::Io::Flow::V0::Models::ItemMarginPostForm.new(x)) r = @client.request("/#{CGI.escape(organization)}/experiences/#{CGI.escape(experience_key)}/margins").with_json(item_margin_post_form.to_json).post ::Io::Flow::V0::Models::ItemMargin.new(r) end |
#post_price_and_books_by_experience_key(organization, experience_key, experience_price_book_mapping_form) ⇒ Object
914 915 916 917 918 919 920 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 914 def post_price_and_books_by_experience_key(organization, experience_key, experience_price_book_mapping_form) HttpClient::Preconditions.assert_class('organization', organization, String) HttpClient::Preconditions.assert_class('experience_key', experience_key, String) (x = experience_price_book_mapping_form; x.is_a?(::Io::Flow::V0::Models::ExperiencePriceBookMappingForm) ? x : ::Io::Flow::V0::Models::ExperiencePriceBookMappingForm.new(x)) r = @client.request("/#{CGI.escape(organization)}/experiences/#{CGI.escape(experience_key)}/price/books").with_json(experience_price_book_mapping_form.to_json).post ::Io::Flow::V0::Models::ExperiencePriceBookMapping.new(r) end |
#put_by_key(organization, key, experience_form) ⇒ Object
Update experience with the specified key, creating if it does not exist.
947 948 949 950 951 952 953 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 947 def put_by_key(organization, key, experience_form) HttpClient::Preconditions.assert_class('organization', organization, String) HttpClient::Preconditions.assert_class('key', key, String) (x = experience_form; x.is_a?(::Io::Flow::V0::Models::ExperienceForm) ? x : ::Io::Flow::V0::Models::ExperienceForm.new(x)) r = @client.request("/#{CGI.escape(organization)}/experiences/#{CGI.escape(key)}").with_json(experience_form.to_json).put ::Io::Flow::V0::Models::Experience.new(r) end |
#put_currency_and_formats_by_experience_key(organization, experience_key, experience_currency_format_form) ⇒ Object
791 792 793 794 795 796 797 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 791 def put_currency_and_formats_by_experience_key(organization, experience_key, experience_currency_format_form) HttpClient::Preconditions.assert_class('organization', organization, String) HttpClient::Preconditions.assert_class('experience_key', experience_key, String) (x = experience_currency_format_form; x.is_a?(::Io::Flow::V0::Models::ExperienceCurrencyFormatForm) ? x : ::Io::Flow::V0::Models::ExperienceCurrencyFormatForm.new(x)) r = @client.request("/#{CGI.escape(organization)}/experiences/#{CGI.escape(experience_key)}/currency/formats").with_json(experience_currency_format_form.to_json).put ::Io::Flow::V0::Models::ExperienceCurrencyFormat.new(r) end |
#put_margins_by_experience_key_and_key(organization, experience_key, key, item_margin_put_form) ⇒ Object
829 830 831 832 833 834 835 836 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 829 def put_margins_by_experience_key_and_key(organization, experience_key, key, item_margin_put_form) HttpClient::Preconditions.assert_class('organization', organization, String) HttpClient::Preconditions.assert_class('experience_key', experience_key, String) HttpClient::Preconditions.assert_class('key', key, String) (x = item_margin_put_form; x.is_a?(::Io::Flow::V0::Models::ItemMarginPutForm) ? x : ::Io::Flow::V0::Models::ItemMarginPutForm.new(x)) r = @client.request("/#{CGI.escape(organization)}/experiences/#{CGI.escape(experience_key)}/margins/#{CGI.escape(key)}").with_json(item_margin_put_form.to_json).put ::Io::Flow::V0::Models::ItemMargin.new(r) end |
#put_payment_and_method_and_rules_by_experience_key(organization, experience_key, experience_payment_method_rule_forms) ⇒ Object
Change the ordering or payment tags for an experience. Every post must include one entry for each payment method offered by Flow.
891 892 893 894 895 896 897 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 891 def put_payment_and_method_and_rules_by_experience_key(organization, experience_key, experience_payment_method_rule_forms) HttpClient::Preconditions.assert_class('organization', organization, String) HttpClient::Preconditions.assert_class('experience_key', experience_key, String) HttpClient::Preconditions.assert_class('experience_payment_method_rule_forms', experience_payment_method_rule_forms, Array).map { |v| (x = v; x.is_a?(::Io::Flow::V0::Models::ExperiencePaymentMethodRuleForm) ? x : ::Io::Flow::V0::Models::ExperiencePaymentMethodRuleForm.new(x)) } r = @client.request("/#{CGI.escape(organization)}/experiences/#{CGI.escape(experience_key)}/payment/method/rules").with_json(experience_payment_method_rule_forms.map { |o| o.to_hash }.to_json).put r.map { |x| ::Io::Flow::V0::Models::PaymentMethodRule.new(x) } end |
#put_pricing_by_key(organization, key, pricing) ⇒ Object
Update the pricing settings for this experience
982 983 984 985 986 987 988 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 982 def put_pricing_by_key(organization, key, pricing) HttpClient::Preconditions.assert_class('organization', organization, String) HttpClient::Preconditions.assert_class('key', key, String) (x = pricing; x.is_a?(::Io::Flow::V0::Models::Pricing) ? x : ::Io::Flow::V0::Models::Pricing.new(x)) r = @client.request("/#{CGI.escape(organization)}/experiences/#{CGI.escape(key)}/pricing").with_json(pricing.to_json).put ::Io::Flow::V0::Models::Pricing.new(r) end |
#put_status_by_key(organization, key, experience_status_form) ⇒ Object
Updates the status of a given experience.
999 1000 1001 1002 1003 1004 1005 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 999 def put_status_by_key(organization, key, experience_status_form) HttpClient::Preconditions.assert_class('organization', organization, String) HttpClient::Preconditions.assert_class('key', key, String) (x = experience_status_form; x.is_a?(::Io::Flow::V0::Models::ExperienceStatusForm) ? x : ::Io::Flow::V0::Models::ExperienceStatusForm.new(x)) r = @client.request("/#{CGI.escape(organization)}/experiences/#{CGI.escape(key)}/status").with_json(experience_status_form.to_json).put ::Io::Flow::V0::Models::Experience.new(r) end |