ifeelgoods 0.0.1

data/lib/ifeelgoods/api/rewards_api.rb

@@ -0,0 +1,166 @@
+=begin
+#Fulfillment API
+
+#Public API exposed to ifeelgoods customers.
+
+The version of the OpenAPI document: v2
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.24.0
+
+=end
+
+require 'cgi'
+
+module Ifeelgoods
+  class RewardsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Get a Reward
+    # Use this function to retrieve detailed description about a reward
+    # @param sku [String] The reward SKU
+    # @param [Hash] opts the optional parameters
+    # @return [GetRewardBySKU200Response]
+    def get_reward_by_sku(sku, opts = {})
+      data, _status_code, _headers = get_reward_by_sku_with_http_info(sku, opts)
+      data
+    end
+
+    # Get a Reward
+    # Use this function to retrieve detailed description about a reward
+    # @param sku [String] The reward SKU
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GetRewardBySKU200Response, Integer, Hash)>] GetRewardBySKU200Response data, response status code and response headers
+    def get_reward_by_sku_with_http_info(sku, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RewardsApi.get_reward_by_sku ...'
+      end
+      # verify the required parameter 'sku' is set
+      if @api_client.config.client_side_validation && sku.nil?
+        fail ArgumentError, "Missing the required parameter 'sku' when calling RewardsApi.get_reward_by_sku"
+      end
+      # resource path
+      local_var_path = '/fulfillment/v2/rewards/{sku}'.sub('{sku}', CGI.escape(sku.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'GetRewardBySKU200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['api_key', 'bearer_auth', 'api_secret']
+
+      new_options = opts.merge(
+        :operation => :"RewardsApi.get_reward_by_sku",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: RewardsApi#get_reward_by_sku\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List all Rewards
+    # Use this function to list all the rewards from the Ifeelgoods Catalog
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :sku Comma-separated list of reward SKUs to filter by
+    # @option opts [String] :client_id Unique Client identifier (used to retrieve cost with discount)
+    # @option opts [Integer] :page  (default to 1)
+    # @option opts [Integer] :per_page  (default to 20)
+    # @return [ListRewards200Response]
+    def list_rewards(opts = {})
+      data, _status_code, _headers = list_rewards_with_http_info(opts)
+      data
+    end
+
+    # List all Rewards
+    # Use this function to list all the rewards from the Ifeelgoods Catalog
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :sku Comma-separated list of reward SKUs to filter by
+    # @option opts [String] :client_id Unique Client identifier (used to retrieve cost with discount)
+    # @option opts [Integer] :page  (default to 1)
+    # @option opts [Integer] :per_page  (default to 20)
+    # @return [Array<(ListRewards200Response, Integer, Hash)>] ListRewards200Response data, response status code and response headers
+    def list_rewards_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RewardsApi.list_rewards ...'
+      end
+      if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"page"]" when calling RewardsApi.list_rewards, must be greater than or equal to 1.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] > 10000
+        fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling RewardsApi.list_rewards, must be smaller than or equal to 10000.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling RewardsApi.list_rewards, must be greater than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/fulfillment/v2/rewards'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'sku'] = opts[:'sku'] if !opts[:'sku'].nil?
+      query_params[:'client_id'] = opts[:'client_id'] if !opts[:'client_id'].nil?
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ListRewards200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['api_key', 'bearer_auth', 'api_secret']
+
+      new_options = opts.merge(
+        :operation => :"RewardsApi.list_rewards",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: RewardsApi#list_rewards\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/ifeelgoods/api/stats_api.rb

@@ -0,0 +1,111 @@
+=begin
+#Fulfillment API
+
+#Public API exposed to ifeelgoods customers.
+
+The version of the OpenAPI document: v2
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.24.0
+
+=end
+
+require 'cgi'
+
+module Ifeelgoods
+  class StatsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Get Redemption Stats
+    # Use this function to access data relative to the reward delivery activity for a specific client
+    # @param client_id [String] The client identifier
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :promotion_id 
+    # @option opts [String] :reward_sku 
+    # @option opts [Time] :start_date ISO-8601 String representing the start date for the date range for which activity stats are extracted
+    # @option opts [Time] :end_date ISO-8601 String representing the end date for the date range for which activity stats are extracted
+    # @option opts [String] :interval Aggregation granularity - daily, monthly and yearly
+    # @option opts [String] :states Filter to specify the state of the redemptions to include in the stats
+    # @return [GetRedemptionStats200Response]
+    def get_redemption_stats(client_id, opts = {})
+      data, _status_code, _headers = get_redemption_stats_with_http_info(client_id, opts)
+      data
+    end
+
+    # Get Redemption Stats
+    # Use this function to access data relative to the reward delivery activity for a specific client
+    # @param client_id [String] The client identifier
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :promotion_id 
+    # @option opts [String] :reward_sku 
+    # @option opts [Time] :start_date ISO-8601 String representing the start date for the date range for which activity stats are extracted
+    # @option opts [Time] :end_date ISO-8601 String representing the end date for the date range for which activity stats are extracted
+    # @option opts [String] :interval Aggregation granularity - daily, monthly and yearly
+    # @option opts [String] :states Filter to specify the state of the redemptions to include in the stats
+    # @return [Array<(GetRedemptionStats200Response, Integer, Hash)>] GetRedemptionStats200Response data, response status code and response headers
+    def get_redemption_stats_with_http_info(client_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: StatsApi.get_redemption_stats ...'
+      end
+      # verify the required parameter 'client_id' is set
+      if @api_client.config.client_side_validation && client_id.nil?
+        fail ArgumentError, "Missing the required parameter 'client_id' when calling StatsApi.get_redemption_stats"
+      end
+      allowable_values = ["daily", "monthly", "yearly"]
+      if @api_client.config.client_side_validation && opts[:'interval'] && !allowable_values.include?(opts[:'interval'])
+        fail ArgumentError, "invalid value for \"interval\", must be one of #{allowable_values}"
+      end
+      allowable_values = ["all", "redeemed"]
+      if @api_client.config.client_side_validation && opts[:'states'] && !allowable_values.include?(opts[:'states'])
+        fail ArgumentError, "invalid value for \"states\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/fulfillment/v2/clients/{client_id}/stats'.sub('{client_id}', CGI.escape(client_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'promotion_id'] = opts[:'promotion_id'] if !opts[:'promotion_id'].nil?
+      query_params[:'reward_sku'] = opts[:'reward_sku'] if !opts[:'reward_sku'].nil?
+      query_params[:'start_date'] = opts[:'start_date'] if !opts[:'start_date'].nil?
+      query_params[:'end_date'] = opts[:'end_date'] if !opts[:'end_date'].nil?
+      query_params[:'interval'] = opts[:'interval'] if !opts[:'interval'].nil?
+      query_params[:'states'] = opts[:'states'] if !opts[:'states'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'GetRedemptionStats200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['api_key', 'bearer_auth', 'api_secret']
+
+      new_options = opts.merge(
+        :operation => :"StatsApi.get_redemption_stats",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: StatsApi#get_redemption_stats\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/ifeelgoods/api/vendor_places_api.rb

@@ -0,0 +1,109 @@
+=begin
+#Fulfillment API
+
+#Public API exposed to ifeelgoods customers.
+
+The version of the OpenAPI document: v2
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.24.0
+
+=end
+
+require 'cgi'
+
+module Ifeelgoods
+  class VendorPlacesApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # List all vendor places
+    # Use this function to list vendor places for a specific client. This endpoint is available only to clients subscribed to Vendor Places API access.
+    # @param client_id [String] The client identifier
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :skus Filter by a list of brand SKUs
+    # @option opts [String] :zip_code 
+    # @option opts [Integer] :page  (default to 1)
+    # @option opts [Integer] :per_page  (default to 20)
+    # @return [ListClientVendorPlaces200Response]
+    def list_client_vendor_places(client_id, opts = {})
+      data, _status_code, _headers = list_client_vendor_places_with_http_info(client_id, opts)
+      data
+    end
+
+    # List all vendor places
+    # Use this function to list vendor places for a specific client. This endpoint is available only to clients subscribed to Vendor Places API access.
+    # @param client_id [String] The client identifier
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :skus Filter by a list of brand SKUs
+    # @option opts [String] :zip_code 
+    # @option opts [Integer] :page  (default to 1)
+    # @option opts [Integer] :per_page  (default to 20)
+    # @return [Array<(ListClientVendorPlaces200Response, Integer, Hash)>] ListClientVendorPlaces200Response data, response status code and response headers
+    def list_client_vendor_places_with_http_info(client_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: VendorPlacesApi.list_client_vendor_places ...'
+      end
+      # verify the required parameter 'client_id' is set
+      if @api_client.config.client_side_validation && client_id.nil?
+        fail ArgumentError, "Missing the required parameter 'client_id' when calling VendorPlacesApi.list_client_vendor_places"
+      end
+      if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"page"]" when calling VendorPlacesApi.list_client_vendor_places, must be greater than or equal to 1.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] > 10000
+        fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling VendorPlacesApi.list_client_vendor_places, must be smaller than or equal to 10000.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling VendorPlacesApi.list_client_vendor_places, must be greater than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/fulfillment/v2/clients/{client_id}/vendor_places'.sub('{client_id}', CGI.escape(client_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'skus'] = @api_client.build_collection_param(opts[:'skus'], :multi) if !opts[:'skus'].nil?
+      query_params[:'zip_code'] = opts[:'zip_code'] if !opts[:'zip_code'].nil?
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ListClientVendorPlaces200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['api_key', 'bearer_auth', 'api_secret']
+
+      new_options = opts.merge(
+        :operation => :"VendorPlacesApi.list_client_vendor_places",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: VendorPlacesApi#list_client_vendor_places\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end