apimatic-apollo-sdk 0.0.1

data/lib/apollo_rest_api/models/reports_sync_report_request.rb

@@ -0,0 +1,253 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApolloRestApi
+  # ReportsSyncReportRequest Model.
+  class ReportsSyncReportRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The metrics to query. Each object specifies which metric to measure and
+    # which date and user columns the engine should use for that metric. The
+    # <code>smart_datetime_reference</code> and
+    # <code>smart_user_id_reference</code> values are metric-specific — using
+    # the wrong values will return no data. Refer to the <a
+    # href="https://docs.apollo.io/reference/sync-report-metrics"
+    # target="_blank">Metrics and Dimensions Reference</a> for valid metric
+    # names and the correct reference fields for each. <br><br>Pass an empty
+    # array <code>[]</code> to return a response with no metric columns.
+    # @return [Array[Metric]]
+    attr_accessor :metrics
+
+    # The dimension to group results by (row dimension). Pass one object to
+    # break results down by that dimension. Pass an empty array <code>[]</code>
+    # for flat totals with no grouping. <br><br>Only one entry is supported.
+    # Refer to the <a
+    # href="https://docs.apollo.io/reference/sync-report-metrics"
+    # target="_blank">Metrics and Dimensions Reference</a> for valid dimension
+    # names.
+    # @return [Array[GroupBy]]
+    attr_accessor :group_by
+
+    # The dimension to pivot on (column dimension). Used together with
+    # <code>group_by</code> to produce a two-dimensional cross-tab table:
+    # <code>group_by</code> defines the row dimension and
+    # <code>pivot_group_by</code> defines the column dimension. Pass an empty
+    # array <code>[]</code> for non-pivot queries. <br><br>Only one entry is
+    # supported.
+    # @return [Array[PivotGroupBy]]
+    attr_accessor :pivot_group_by
+
+    # Sort order for the result rows. Only the first entry is applied. Pass an
+    # empty array <code>[]</code> to use the default order. <br><br>Sorting is
+    # supported by metric value — provide the <code>metric</code> field with the
+    # same structure as an entry in the <code>metrics</code> array. The
+    # <code>asc</code> field controls direction (<code>true</code> = ascending,
+    # <code>false</code> = descending). <br><br>Sorting by dimension value (e.g.
+    # alphabetically by user name) is not supported via the API.
+    # @return [Array[Sort]]
+    attr_accessor :sorts
+
+    # Key/value filter map to narrow the result set. Pass an empty object
+    # <code>{}</code> for no filters. Common filter keys are documented in the
+    # <code>properties</code> below; additional dimension-based filters may also
+    # be passed using the same key names as <code>group_by[].name</code> values.
+    # Refer to the <a
+    # href="https://docs.apollo.io/reference/sync-report-metrics"
+    # target="_blank">Metrics and Dimensions Reference</a> for a complete list.
+    # @return [Filters]
+    attr_accessor :filters
+
+    # When <code>true</code>, the response includes an aggregated totals row in
+    # addition to the per-dimension-value rows.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :group_by_totals_selected
+
+    # When <code>true</code>, the pivot response includes an aggregated totals
+    # column in addition to the per-pivot-value columns.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :pivot_group_by_totals_selected
+
+    # The time window for the query. Provide one object with a
+    # <code>modality</code> preset. For a custom date range, set
+    # <code>modality</code> to <code>custom_range</code> and add a
+    # <code>smart_datetime_range</code> key in <code>filters</code> with
+    # <code>{"min": "YYYY-MM-DD", "max": "YYYY-MM-DD"}</code>.
+    # @return [Array[DateRange]]
+    attr_accessor :date_ranges
+
+    # Exclude specific dimension values from the result rows. Values must match
+    # the raw <code>key</code> field returned in bucket responses for the active
+    # <code>group_by</code> dimension (e.g. a contact stage ID string, a user ID
+    # string, or a date string for datetime dimensions). Maximum 500 entries.
+    # @return [Array[String]]
+    attr_accessor :skip_group_by_values
+
+    # Minimum denominator threshold for ratio metrics. Rows where the
+    # denominator falls below this value are excluded from ratio calculations.
+    # @return [Integer]
+    attr_accessor :min_ratio_denominator
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['metrics'] = 'metrics'
+      @_hash['group_by'] = 'group_by'
+      @_hash['pivot_group_by'] = 'pivot_group_by'
+      @_hash['sorts'] = 'sorts'
+      @_hash['filters'] = 'filters'
+      @_hash['group_by_totals_selected'] = 'group_by_totals_selected'
+      @_hash['pivot_group_by_totals_selected'] =
+        'pivot_group_by_totals_selected'
+      @_hash['date_ranges'] = 'date_ranges'
+      @_hash['skip_group_by_values'] = 'skip_group_by_values'
+      @_hash['min_ratio_denominator'] = 'min_ratio_denominator'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        pivot_group_by
+        skip_group_by_values
+        min_ratio_denominator
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(metrics:, group_by:, sorts:, filters:,
+                   group_by_totals_selected:, pivot_group_by_totals_selected:,
+                   date_ranges:, pivot_group_by: SKIP,
+                   skip_group_by_values: SKIP, min_ratio_denominator: 0,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @metrics = metrics
+      @group_by = group_by
+      @pivot_group_by = pivot_group_by unless pivot_group_by == SKIP
+      @sorts = sorts
+      @filters = filters
+      @group_by_totals_selected = group_by_totals_selected
+      @pivot_group_by_totals_selected = pivot_group_by_totals_selected
+      @date_ranges = date_ranges
+      @skip_group_by_values = skip_group_by_values unless skip_group_by_values == SKIP
+      @min_ratio_denominator = min_ratio_denominator unless min_ratio_denominator == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      # Parameter is an array, so we need to iterate through it
+      metrics = nil
+      unless hash['metrics'].nil?
+        metrics = []
+        hash['metrics'].each do |structure|
+          metrics << (Metric.from_hash(structure) if structure)
+        end
+      end
+
+      metrics = nil unless hash.key?('metrics')
+      # Parameter is an array, so we need to iterate through it
+      group_by = nil
+      unless hash['group_by'].nil?
+        group_by = []
+        hash['group_by'].each do |structure|
+          group_by << (GroupBy.from_hash(structure) if structure)
+        end
+      end
+
+      group_by = nil unless hash.key?('group_by')
+      # Parameter is an array, so we need to iterate through it
+      sorts = nil
+      unless hash['sorts'].nil?
+        sorts = []
+        hash['sorts'].each do |structure|
+          sorts << (Sort.from_hash(structure) if structure)
+        end
+      end
+
+      sorts = nil unless hash.key?('sorts')
+      filters = Filters.from_hash(hash['filters']) if hash['filters']
+      group_by_totals_selected =
+        hash.key?('group_by_totals_selected') ? hash['group_by_totals_selected'] : nil
+      pivot_group_by_totals_selected =
+        hash.key?('pivot_group_by_totals_selected') ? hash['pivot_group_by_totals_selected'] : nil
+      # Parameter is an array, so we need to iterate through it
+      date_ranges = nil
+      unless hash['date_ranges'].nil?
+        date_ranges = []
+        hash['date_ranges'].each do |structure|
+          date_ranges << (DateRange.from_hash(structure) if structure)
+        end
+      end
+
+      date_ranges = nil unless hash.key?('date_ranges')
+      # Parameter is an array, so we need to iterate through it
+      pivot_group_by = nil
+      unless hash['pivot_group_by'].nil?
+        pivot_group_by = []
+        hash['pivot_group_by'].each do |structure|
+          pivot_group_by << (PivotGroupBy.from_hash(structure) if structure)
+        end
+      end
+
+      pivot_group_by = SKIP unless hash.key?('pivot_group_by')
+      skip_group_by_values =
+        hash.key?('skip_group_by_values') ? hash['skip_group_by_values'] : SKIP
+      min_ratio_denominator = hash['min_ratio_denominator'] ||= 0
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      ReportsSyncReportRequest.new(metrics: metrics,
+                                   group_by: group_by,
+                                   sorts: sorts,
+                                   filters: filters,
+                                   group_by_totals_selected: group_by_totals_selected,
+                                   pivot_group_by_totals_selected: pivot_group_by_totals_selected,
+                                   date_ranges: date_ranges,
+                                   pivot_group_by: pivot_group_by,
+                                   skip_group_by_values: skip_group_by_values,
+                                   min_ratio_denominator: min_ratio_denominator,
+                                   additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} metrics: #{@metrics}, group_by: #{@group_by}, pivot_group_by:"\
+      " #{@pivot_group_by}, sorts: #{@sorts}, filters: #{@filters}, group_by_totals_selected:"\
+      " #{@group_by_totals_selected}, pivot_group_by_totals_selected:"\
+      " #{@pivot_group_by_totals_selected}, date_ranges: #{@date_ranges}, skip_group_by_values:"\
+      " #{@skip_group_by_values}, min_ratio_denominator: #{@min_ratio_denominator},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} metrics: #{@metrics.inspect}, group_by: #{@group_by.inspect},"\
+      " pivot_group_by: #{@pivot_group_by.inspect}, sorts: #{@sorts.inspect}, filters:"\
+      " #{@filters.inspect}, group_by_totals_selected: #{@group_by_totals_selected.inspect},"\
+      " pivot_group_by_totals_selected: #{@pivot_group_by_totals_selected.inspect}, date_ranges:"\
+      " #{@date_ranges.inspect}, skip_group_by_values: #{@skip_group_by_values.inspect},"\
+      " min_ratio_denominator: #{@min_ratio_denominator.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/apollo_rest_api/models/reports_sync_report_response.rb

@@ -0,0 +1,102 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApolloRestApi
+  # ReportsSyncReportResponse Model.
+  class ReportsSyncReportResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The query result. Contains four sub-keys depending on query mode and
+    # flags. See response examples for each shape.
+    # @return [Response]
+    attr_accessor :response
+
+    # A map of filter keys that were incompatible with one or more requested
+    # metrics and were silently ignored. Keys are filter names; values are
+    # arrays of affected metric names. Inspect this field when results appear
+    # incomplete.
+    # @return [Hash[String, Object]]
+    attr_accessor :incompatible_filters
+
+    # Goal attainment data. This field is unrelated to data querying — you can
+    # ignore it.
+    # @return [Array[Object]]
+    attr_accessor :goals
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['response'] = 'response'
+      @_hash['incompatible_filters'] = 'incompatible_filters'
+      @_hash['goals'] = 'goals'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        response
+        incompatible_filters
+        goals
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(response: SKIP, incompatible_filters: SKIP, goals: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @response = response unless response == SKIP
+      @incompatible_filters = incompatible_filters unless incompatible_filters == SKIP
+      @goals = goals unless goals == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      response = Response.from_hash(hash['response']) if hash['response']
+      incompatible_filters =
+        hash.key?('incompatible_filters') ? hash['incompatible_filters'] : SKIP
+      goals = hash.key?('goals') ? hash['goals'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      ReportsSyncReportResponse.new(response: response,
+                                    incompatible_filters: incompatible_filters,
+                                    goals: goals,
+                                    additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} response: #{@response}, incompatible_filters: #{@incompatible_filters},"\
+      " goals: #{@goals}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} response: #{@response.inspect}, incompatible_filters:"\
+      " #{@incompatible_filters.inspect}, goals: #{@goals.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/apollo_rest_api/models/request_type.rb

@@ -0,0 +1,40 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApolloRestApi
+  # The enrichment request type.
+  class RequestType
+    REQUEST_TYPE = [
+      # TODO: Write general description for EMAIL
+      EMAIL = 'email'.freeze,
+
+      # TODO: Write general description for PHONE
+      PHONE = 'phone'.freeze,
+
+      # TODO: Write general description for WATERFALL
+      WATERFALL = 'waterfall'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      REQUEST_TYPE.include?(value)
+    end
+
+    def self.from_value(value, default_value = EMAIL)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'email' then EMAIL
+      when 'phone' then PHONE
+      when 'waterfall' then WATERFALL
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/apollo_rest_api/models/response.rb

@@ -0,0 +1,118 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApolloRestApi
+  # The query result. Contains four sub-keys depending on query mode and flags.
+  # See response examples for each shape.
+  class Response < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Main aggregated data. Shape varies by query mode: a flat key/value object
+    # when <code>group_by</code> is empty (metric name → value); a bucketed
+    # object <code>{ "dimension": { "buckets": [...] } }</code> for grouped
+    # queries; a nested bucketed object for pivot queries where the outer key is
+    # the <code>pivot_group_by</code> dimension and each outer bucket contains a
+    # nested <code>group_by</code> dimension with its own <code>buckets</code>.
+    # @return [Object]
+    attr_accessor :table_response
+
+    # Aggregated totals per <code>group_by</code> dimension value, without pivot
+    # breakdown. Same bucketed structure as <code>table_response</code>.
+    # Populated when <code>group_by_totals_selected</code> is <code>true</code>;
+    # otherwise <code>{}</code>.
+    # @return [Object]
+    attr_accessor :group_by_total_response
+
+    # Aggregated totals per <code>pivot_group_by</code> dimension value, without
+    # group_by breakdown. Populated when
+    # <code>pivot_group_by_totals_selected</code> is <code>true</code>;
+    # otherwise <code>{}</code>.
+    # @return [Object]
+    attr_accessor :pivot_group_by_total_response
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['table_response'] = 'table_response'
+      @_hash['group_by_total_response'] = 'group_by_total_response'
+      @_hash['pivot_group_by_total_response'] =
+        'pivot_group_by_total_response'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        table_response
+        group_by_total_response
+        pivot_group_by_total_response
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(table_response: SKIP, group_by_total_response: SKIP,
+                   pivot_group_by_total_response: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @table_response = table_response unless table_response == SKIP
+      @group_by_total_response = group_by_total_response unless group_by_total_response == SKIP
+      unless pivot_group_by_total_response == SKIP
+        @pivot_group_by_total_response =
+          pivot_group_by_total_response
+      end
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      table_response =
+        hash.key?('table_response') ? hash['table_response'] : SKIP
+      group_by_total_response =
+        hash.key?('group_by_total_response') ? hash['group_by_total_response'] : SKIP
+      pivot_group_by_total_response =
+        hash.key?('pivot_group_by_total_response') ? hash['pivot_group_by_total_response'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      Response.new(table_response: table_response,
+                   group_by_total_response: group_by_total_response,
+                   pivot_group_by_total_response: pivot_group_by_total_response,
+                   additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} table_response: #{@table_response}, group_by_total_response:"\
+      " #{@group_by_total_response}, pivot_group_by_total_response:"\
+      " #{@pivot_group_by_total_response}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} table_response: #{@table_response.inspect}, group_by_total_response:"\
+      " #{@group_by_total_response.inspect}, pivot_group_by_total_response:"\
+      " #{@pivot_group_by_total_response.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/apollo_rest_api/models/role.rb

@@ -0,0 +1,112 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApolloRestApi
+  # Role Model.
+  class Role < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :opportunity_contact_role_type_id
+
+    # TODO: Write general description for this method
+    # @return [Object]
+    attr_accessor :crm_role_id
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_primary
+
+    # TODO: Write general description for this method
+    # @return [Object]
+    attr_accessor :crm_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['opportunity_contact_role_type_id'] =
+        'opportunity_contact_role_type_id'
+      @_hash['crm_role_id'] = 'crm_role_id'
+      @_hash['is_primary'] = 'is_primary'
+      @_hash['crm_id'] = 'crm_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        opportunity_contact_role_type_id
+        crm_role_id
+        is_primary
+        crm_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(opportunity_contact_role_type_id: SKIP, crm_role_id: SKIP,
+                   is_primary: true, crm_id: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      unless opportunity_contact_role_type_id == SKIP
+        @opportunity_contact_role_type_id =
+          opportunity_contact_role_type_id
+      end
+      @crm_role_id = crm_role_id unless crm_role_id == SKIP
+      @is_primary = is_primary unless is_primary == SKIP
+      @crm_id = crm_id unless crm_id == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      opportunity_contact_role_type_id =
+        hash.key?('opportunity_contact_role_type_id') ? hash['opportunity_contact_role_type_id'] : SKIP
+      crm_role_id = hash.key?('crm_role_id') ? hash['crm_role_id'] : SKIP
+      is_primary = hash['is_primary'] ||= true
+      crm_id = hash.key?('crm_id') ? hash['crm_id'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      Role.new(opportunity_contact_role_type_id: opportunity_contact_role_type_id,
+               crm_role_id: crm_role_id,
+               is_primary: is_primary,
+               crm_id: crm_id,
+               additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} opportunity_contact_role_type_id: #{@opportunity_contact_role_type_id},"\
+      " crm_role_id: #{@crm_role_id}, is_primary: #{@is_primary}, crm_id: #{@crm_id},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} opportunity_contact_role_type_id:"\
+      " #{@opportunity_contact_role_type_id.inspect}, crm_role_id: #{@crm_role_id.inspect},"\
+      " is_primary: #{@is_primary.inspect}, crm_id: #{@crm_id.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end