klaviyo_sdk 1.0.0.20220329

data/lib/klaviyo_sdk/api/metrics_api.rb

@@ -0,0 +1,343 @@
+=begin
+#Klaviyo API
+
+#Empowering creators to own their destiny
+
+The version of the OpenAPI document: 2022.03.29
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.4.0
+
+=end
+
+require 'cgi'
+
+module Client
+  class MetricsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Get Metrics Info
+    # Returns a list of all the metrics in your account.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page For pagination, which page of results to return. Default = 0 (default to 0)
+    # @option opts [Integer] :count For pagination, the number of results to return. Default = 50 ; Max = 100 (default to 50)
+    # @return [Hash<String, Object>]
+    def get_metrics(opts = {})
+      data, _status_code, _headers = get_metrics_with_http_info(opts)
+      data
+    end
+
+    # Get Metrics Info
+    # Returns a list of all the metrics in your account.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page For pagination, which page of results to return. Default &#x3D; 0
+    # @option opts [Integer] :count For pagination, the number of results to return. Default &#x3D; 50 ; Max &#x3D; 100
+    # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
+    def get_metrics_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MetricsApi.get_metrics ...'
+      end
+      if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 0
+        fail ArgumentError, 'invalid value for "opts[:"page"]" when calling MetricsApi.get_metrics, must be greater than or equal to 0.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'count'].nil? && opts[:'count'] > 100
+        fail ArgumentError, 'invalid value for "opts[:"count"]" when calling MetricsApi.get_metrics, must be smaller than or equal to 100.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'count'].nil? && opts[:'count'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"count"]" when calling MetricsApi.get_metrics, must be greater than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/v1/metrics'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Hash<String, Object>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"MetricsApi.get_metrics",
+        :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: MetricsApi#get_metrics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Query Event Data
+    # Exports event data from Klaviyo, optionally filtering and segmenting on available event properties. Note that the only comparison operator currently supported is `=`. To ensure a correct response, enter parameters in the curl request as they are ordered below:
+    # @param metric_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :start_date  Beginning of timeframe to pull event data for. The default value is 1 month ago. Can also accept a 10-digit UNIX timestamp. When sending a &#x60;start_date&#x60;, you must also send an &#x60;end_date&#x60;  Ex: &#x60;1610524800&#x60; OR &#x60;2021-01-13&#x60; 
+    # @option opts [String] :end_date  End of timeframe to pull event data for. The default is the current day, or 1 month from start_date, whichever is sooner. Can also accept a 10-digit UNIX timestamp. When sending an &#x60;end_date&#x60;, you must also send a &#x60;start_date&#x60;. Must be *at most* 31 days after &#x60;start_date&#x60;  Ex: &#x60;1612080000&#x60; OR &#x60;2021-01-31&#x60; 
+    # @option opts [String] :unit Granularity to bucket data points into - one of &#x60;day&#x60;, &#x60;week&#x60;, or &#x60;month&#x60;. Defaults to &#x60;day&#x60;. (default to 'day')
+    # @option opts [String] :measurement  Type of metric to fetch - one of &#x60;unique&#x60;, &#x60;count&#x60;, &#x60;value&#x60;, or &#x60;sum&#x60;. Defaults to &#x60;count&#x60;. For &#x60;sum&#x60; a property name to operate on must be supplied as a JSON-encoded list like &#x60;[\&quot;sum\&quot;,\&quot;ItemCount\&quot;]&#x60;  (default to 'count')
+    # @option opts [String] :where Optional, JSON-encoded list. Conditions to use to filter the set of events. A max of 1 condition can be given. &#x60;where&#x60; and &#x60;by&#x60; parameters cannot be specified at the same time.  ex: &#x60;[[\&quot;$attributed_flow\&quot;,\&quot;&#x3D;\&quot;,\&quot;FLOW_ID\&quot;]]&#x60; 
+    # @option opts [String] :by The name of a property to segment the event data on. &#x60;where&#x60; and &#x60;by&#x60; parameters cannot be specified at the same time. Cannot be used alongside &#x60;where&#x60; parameter.
+    # @option opts [Integer] :count Maximum number of segments to return. Default &#x3D; 25, **MAX &#x3D; 1000** (default to 25)
+    # @return [MetricExport]
+    def metric_export(metric_id, opts = {})
+      data, _status_code, _headers = metric_export_with_http_info(metric_id, opts)
+      data
+    end
+
+    # Query Event Data
+    # Exports event data from Klaviyo, optionally filtering and segmenting on available event properties. Note that the only comparison operator currently supported is &#x60;&#x3D;&#x60;. To ensure a correct response, enter parameters in the curl request as they are ordered below:
+    # @param metric_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :start_date  Beginning of timeframe to pull event data for. The default value is 1 month ago. Can also accept a 10-digit UNIX timestamp. When sending a &#x60;start_date&#x60;, you must also send an &#x60;end_date&#x60;  Ex: &#x60;1610524800&#x60; OR &#x60;2021-01-13&#x60; 
+    # @option opts [String] :end_date  End of timeframe to pull event data for. The default is the current day, or 1 month from start_date, whichever is sooner. Can also accept a 10-digit UNIX timestamp. When sending an &#x60;end_date&#x60;, you must also send a &#x60;start_date&#x60;. Must be *at most* 31 days after &#x60;start_date&#x60;  Ex: &#x60;1612080000&#x60; OR &#x60;2021-01-31&#x60; 
+    # @option opts [String] :unit Granularity to bucket data points into - one of &#x60;day&#x60;, &#x60;week&#x60;, or &#x60;month&#x60;. Defaults to &#x60;day&#x60;.
+    # @option opts [String] :measurement  Type of metric to fetch - one of &#x60;unique&#x60;, &#x60;count&#x60;, &#x60;value&#x60;, or &#x60;sum&#x60;. Defaults to &#x60;count&#x60;. For &#x60;sum&#x60; a property name to operate on must be supplied as a JSON-encoded list like &#x60;[\&quot;sum\&quot;,\&quot;ItemCount\&quot;]&#x60; 
+    # @option opts [String] :where Optional, JSON-encoded list. Conditions to use to filter the set of events. A max of 1 condition can be given. &#x60;where&#x60; and &#x60;by&#x60; parameters cannot be specified at the same time.  ex: &#x60;[[\&quot;$attributed_flow\&quot;,\&quot;&#x3D;\&quot;,\&quot;FLOW_ID\&quot;]]&#x60; 
+    # @option opts [String] :by The name of a property to segment the event data on. &#x60;where&#x60; and &#x60;by&#x60; parameters cannot be specified at the same time. Cannot be used alongside &#x60;where&#x60; parameter.
+    # @option opts [Integer] :count Maximum number of segments to return. Default &#x3D; 25, **MAX &#x3D; 1000**
+    # @return [Array<(MetricExport, Integer, Hash)>] MetricExport data, response status code and response headers
+    def metric_export_with_http_info(metric_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MetricsApi.metric_export ...'
+      end
+      # verify the required parameter 'metric_id' is set
+      if @api_client.config.client_side_validation && metric_id.nil?
+        fail ArgumentError, "Missing the required parameter 'metric_id' when calling MetricsApi.metric_export"
+      end
+      if @api_client.config.client_side_validation && !opts[:'count'].nil? && opts[:'count'] > 1000
+        fail ArgumentError, 'invalid value for "opts[:"count"]" when calling MetricsApi.metric_export, must be smaller than or equal to 1000.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'count'].nil? && opts[:'count'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"count"]" when calling MetricsApi.metric_export, must be greater than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/v1/metric/{metric_id}/export'.sub('{' + 'metric_id' + '}', CGI.escape(metric_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      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[:'unit'] = opts[:'unit'] if !opts[:'unit'].nil?
+      query_params[:'measurement'] = opts[:'measurement'] if !opts[:'measurement'].nil?
+      query_params[:'where'] = opts[:'where'] if !opts[:'where'].nil?
+      query_params[:'by'] = opts[:'by'] if !opts[:'by'].nil?
+      query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'MetricExport'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"MetricsApi.metric_export",
+        :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: MetricsApi#metric_export\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get Events for a Specific Metric
+    # Returns a batched timeline for one specific metric.
+    # @param metric_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :since Either a 10-digit Unix timestamp (UTC) to use as starting datetime, OR a pagination token obtained from the &#x60;next&#x60; attribute of a prior API call. For backwards compatibility, UUIDs will continue to be supported for a limited time. Defaults to current time.
+    # @option opts [Integer] :count Number of events to return in a batch. Max &#x3D; 100 (default to 50)
+    # @option opts [String] :sort Sort order to apply to timeline, either descending or ascending. Valid values are &#x60;desc&#x60; or &#x60;asc&#x60;. Defaults to &#x60;desc&#x60;. Always descending when &#x60;since&#x60; is not sent, as &#x60;since&#x60; defaults to current time. (default to 'desc')
+    # @return [MetricTimeline]
+    def metric_timeline(metric_id, opts = {})
+      data, _status_code, _headers = metric_timeline_with_http_info(metric_id, opts)
+      data
+    end
+
+    # Get Events for a Specific Metric
+    # Returns a batched timeline for one specific metric.
+    # @param metric_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :since Either a 10-digit Unix timestamp (UTC) to use as starting datetime, OR a pagination token obtained from the &#x60;next&#x60; attribute of a prior API call. For backwards compatibility, UUIDs will continue to be supported for a limited time. Defaults to current time.
+    # @option opts [Integer] :count Number of events to return in a batch. Max &#x3D; 100
+    # @option opts [String] :sort Sort order to apply to timeline, either descending or ascending. Valid values are &#x60;desc&#x60; or &#x60;asc&#x60;. Defaults to &#x60;desc&#x60;. Always descending when &#x60;since&#x60; is not sent, as &#x60;since&#x60; defaults to current time.
+    # @return [Array<(MetricTimeline, Integer, Hash)>] MetricTimeline data, response status code and response headers
+    def metric_timeline_with_http_info(metric_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MetricsApi.metric_timeline ...'
+      end
+      # verify the required parameter 'metric_id' is set
+      if @api_client.config.client_side_validation && metric_id.nil?
+        fail ArgumentError, "Missing the required parameter 'metric_id' when calling MetricsApi.metric_timeline"
+      end
+      if @api_client.config.client_side_validation && !opts[:'count'].nil? && opts[:'count'] > 100
+        fail ArgumentError, 'invalid value for "opts[:"count"]" when calling MetricsApi.metric_timeline, must be smaller than or equal to 100.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'count'].nil? && opts[:'count'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"count"]" when calling MetricsApi.metric_timeline, must be greater than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/v1/metric/{metric_id}/timeline'.sub('{' + 'metric_id' + '}', CGI.escape(metric_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
+      query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
+      query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'MetricTimeline'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"MetricsApi.metric_timeline",
+        :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: MetricsApi#metric_timeline\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get Events for All Metrics
+    # Returns a batched timeline of all events in your account.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :since Either a 10-digit Unix timestamp (UTC) to use as starting datetime, OR a pagination token obtained from the next attribute of a prior API call. For backwards compatibility, UUIDs will continue to be supported for a limited time. Defaults to current time.
+    # @option opts [Integer] :count Number of events to return in a batch. Default &#x3D; 50, Max &#x3D; 100 (default to 50)
+    # @option opts [String] :sort Sort order to apply to timeline, either descending or ascending. Valid values are &#x60;desc&#x60; or &#x60;asc&#x60;. Defaults to &#x60;desc&#x60;. Always descending when &#x60;since&#x60; is not sent, as &#x60;since&#x60; defaults to current time. (default to 'desc')
+    # @return [MetricTimeline]
+    def metrics_timeline(opts = {})
+      data, _status_code, _headers = metrics_timeline_with_http_info(opts)
+      data
+    end
+
+    # Get Events for All Metrics
+    # Returns a batched timeline of all events in your account.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :since Either a 10-digit Unix timestamp (UTC) to use as starting datetime, OR a pagination token obtained from the next attribute of a prior API call. For backwards compatibility, UUIDs will continue to be supported for a limited time. Defaults to current time.
+    # @option opts [Integer] :count Number of events to return in a batch. Default &#x3D; 50, Max &#x3D; 100
+    # @option opts [String] :sort Sort order to apply to timeline, either descending or ascending. Valid values are &#x60;desc&#x60; or &#x60;asc&#x60;. Defaults to &#x60;desc&#x60;. Always descending when &#x60;since&#x60; is not sent, as &#x60;since&#x60; defaults to current time.
+    # @return [Array<(MetricTimeline, Integer, Hash)>] MetricTimeline data, response status code and response headers
+    def metrics_timeline_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MetricsApi.metrics_timeline ...'
+      end
+      if @api_client.config.client_side_validation && !opts[:'count'].nil? && opts[:'count'] > 100
+        fail ArgumentError, 'invalid value for "opts[:"count"]" when calling MetricsApi.metrics_timeline, must be smaller than or equal to 100.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'count'].nil? && opts[:'count'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"count"]" when calling MetricsApi.metrics_timeline, must be greater than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/v1/metrics/timeline'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
+      query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
+      query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'MetricTimeline'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"MetricsApi.metrics_timeline",
+        :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: MetricsApi#metrics_timeline\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end