orb-apiamtic-sdk 0.0.1

data/lib/api_reference/models/subscription_schedule_item.rb

@@ -0,0 +1,122 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module ApiReference
+  # SubscriptionScheduleItem Model.
+  class SubscriptionScheduleItem < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :start_date
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :end_date
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :created_at
+
+    # TODO: Write general description for this method
+    # @return [PlanMinified]
+    attr_accessor :plan
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['start_date'] = 'start_date'
+      @_hash['end_date'] = 'end_date'
+      @_hash['created_at'] = 'created_at'
+      @_hash['plan'] = 'plan'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        end_date
+        plan
+      ]
+    end
+
+    def initialize(start_date:, end_date:, created_at:, plan:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @start_date = start_date
+      @end_date = end_date
+      @created_at = created_at
+      @plan = plan
+      @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.
+      start_date = if hash.key?('start_date')
+                     (DateTimeHelper.from_rfc3339(hash['start_date']) if hash['start_date'])
+                   end
+      end_date = if hash.key?('end_date')
+                   (DateTimeHelper.from_rfc3339(hash['end_date']) if hash['end_date'])
+                 end
+      created_at = if hash.key?('created_at')
+                     (DateTimeHelper.from_rfc3339(hash['created_at']) if hash['created_at'])
+                   end
+      plan = PlanMinified.from_hash(hash['plan']) if hash['plan']
+
+      # 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.
+      SubscriptionScheduleItem.new(start_date: start_date,
+                                   end_date: end_date,
+                                   created_at: created_at,
+                                   plan: plan,
+                                   additional_properties: additional_properties)
+    end
+
+    def to_custom_start_date
+      DateTimeHelper.to_rfc3339(start_date)
+    end
+
+    def to_custom_end_date
+      DateTimeHelper.to_rfc3339(end_date)
+    end
+
+    def to_custom_created_at
+      DateTimeHelper.to_rfc3339(created_at)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} start_date: #{@start_date}, end_date: #{@end_date}, created_at:"\
+      " #{@created_at}, plan: #{@plan}, 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} start_date: #{@start_date.inspect}, end_date: #{@end_date.inspect},"\
+      " created_at: #{@created_at.inspect}, plan: #{@plan.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/subscription_schedule_items.rb

@@ -0,0 +1,92 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # SubscriptionScheduleItems Model.
+  class SubscriptionScheduleItems < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[SubscriptionScheduleItem]]
+    attr_accessor :data
+
+    # TODO: Write general description for this method
+    # @return [PaginationMetadata]
+    attr_accessor :pagination_metadata
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['data'] = 'data'
+      @_hash['pagination_metadata'] = 'pagination_metadata'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(data:, pagination_metadata:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @data = data
+      @pagination_metadata = pagination_metadata
+      @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
+      data = nil
+      unless hash['data'].nil?
+        data = []
+        hash['data'].each do |structure|
+          data << (SubscriptionScheduleItem.from_hash(structure) if structure)
+        end
+      end
+
+      data = nil unless hash.key?('data')
+      pagination_metadata = PaginationMetadata.from_hash(hash['pagination_metadata']) if
+        hash['pagination_metadata']
+
+      # 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.
+      SubscriptionScheduleItems.new(data: data,
+                                    pagination_metadata: pagination_metadata,
+                                    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} data: #{@data}, pagination_metadata: #{@pagination_metadata},"\
+      " 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} data: #{@data.inspect}, pagination_metadata:"\
+      " #{@pagination_metadata.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/subscription_trial_info.rb

@@ -0,0 +1,96 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module ApiReference
+  # SubscriptionTrialInfo Model.
+  class SubscriptionTrialInfo < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :end_date
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['end_date'] = 'end_date'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        end_date
+      ]
+    end
+
+    def initialize(end_date:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @end_date = end_date
+      @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.
+      end_date = if hash.key?('end_date')
+                   (DateTimeHelper.from_rfc3339(hash['end_date']) if hash['end_date'])
+                 end
+
+      # 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.
+      SubscriptionTrialInfo.new(end_date: end_date,
+                                additional_properties: additional_properties)
+    end
+
+    def to_custom_end_date
+      DateTimeHelper.to_rfc3339(end_date)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [SubscriptionTrialInfo | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.end_date,
+                                     ->(val) { val.instance_of? DateTime })
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['end_date'],
+                            ->(val) { val.instance_of? String })
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} end_date: #{@end_date}, 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} end_date: #{@end_date.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/subscription_usage_request_params.rb

@@ -0,0 +1,207 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module ApiReference
+  # SubscriptionUsageRequestParams Model.
+  class SubscriptionUsageRequestParams < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # This determines the windowing of usage reporting.
+    # @return [Granularity]
+    attr_accessor :granularity
+
+    # Usage returned is inclusive of `timeframe_start`.
+    # @return [DateTime]
+    attr_accessor :timeframe_start
+
+    # Usage returned is exclusive of `timeframe_end`.
+    # @return [DateTime]
+    attr_accessor :timeframe_end
+
+    # When specified in conjunction with `group_by`, this parameter filters
+    # usage to a single billable metric. Note that both `group_by` and
+    # `billable_metric_id` must be specified together.
+    # @return [String]
+    attr_accessor :billable_metric_id
+
+    # Groups per-price usage by the key provided.
+    # @return [String]
+    attr_accessor :group_by
+
+    # Controls whether Orb returns cumulative usage since the start of the
+    # billing period, or incremental day-by-day usage. If your customer has
+    # minimums or discounts, it's strongly recommended that you use the default
+    # cumulative behavior.
+    # @return [ViewMode]
+    attr_accessor :view_mode
+
+    # Controls whether Orb returns cumulative usage since the start of the
+    # billing period, or incremental day-by-day usage. If your customer has
+    # minimums or discounts, it's strongly recommended that you use the default
+    # cumulative behavior.
+    # @return [String]
+    attr_accessor :first_dimension_key
+
+    # Controls whether Orb returns cumulative usage since the start of the
+    # billing period, or incremental day-by-day usage. If your customer has
+    # minimums or discounts, it's strongly recommended that you use the default
+    # cumulative behavior.
+    # @return [String]
+    attr_accessor :first_dimension_value
+
+    # Controls whether Orb returns cumulative usage since the start of the
+    # billing period, or incremental day-by-day usage. If your customer has
+    # minimums or discounts, it's strongly recommended that you use the default
+    # cumulative behavior.
+    # @return [String]
+    attr_accessor :second_dimension_key
+
+    # Controls whether Orb returns cumulative usage since the start of the
+    # billing period, or incremental day-by-day usage. If your customer has
+    # minimums or discounts, it's strongly recommended that you use the default
+    # cumulative behavior.
+    # @return [String]
+    attr_accessor :second_dimension_value
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['granularity'] = 'granularity'
+      @_hash['timeframe_start'] = 'timeframe_start'
+      @_hash['timeframe_end'] = 'timeframe_end'
+      @_hash['billable_metric_id'] = 'billable_metric_id'
+      @_hash['group_by'] = 'group_by'
+      @_hash['view_mode'] = 'view_mode'
+      @_hash['first_dimension_key'] = 'first_dimension_key'
+      @_hash['first_dimension_value'] = 'first_dimension_value'
+      @_hash['second_dimension_key'] = 'second_dimension_key'
+      @_hash['second_dimension_value'] = 'second_dimension_value'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        granularity
+        timeframe_start
+        timeframe_end
+        billable_metric_id
+        group_by
+        view_mode
+        first_dimension_key
+        first_dimension_value
+        second_dimension_key
+        second_dimension_value
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        granularity
+        timeframe_start
+        timeframe_end
+        billable_metric_id
+        group_by
+        view_mode
+        first_dimension_key
+        first_dimension_value
+        second_dimension_key
+        second_dimension_value
+      ]
+    end
+
+    def initialize(granularity: Granularity::DAY, timeframe_start: SKIP,
+                   timeframe_end: SKIP, billable_metric_id: SKIP,
+                   group_by: SKIP, view_mode: SKIP, first_dimension_key: SKIP,
+                   first_dimension_value: SKIP, second_dimension_key: SKIP,
+                   second_dimension_value: SKIP)
+      @granularity = granularity unless granularity == SKIP
+      @timeframe_start = timeframe_start unless timeframe_start == SKIP
+      @timeframe_end = timeframe_end unless timeframe_end == SKIP
+      @billable_metric_id = billable_metric_id unless billable_metric_id == SKIP
+      @group_by = group_by unless group_by == SKIP
+      @view_mode = view_mode unless view_mode == SKIP
+      @first_dimension_key = first_dimension_key unless first_dimension_key == SKIP
+      @first_dimension_value = first_dimension_value unless first_dimension_value == SKIP
+      @second_dimension_key = second_dimension_key unless second_dimension_key == SKIP
+      @second_dimension_value = second_dimension_value unless second_dimension_value == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      granularity = hash['granularity'] ||= Granularity::DAY
+      timeframe_start = if hash.key?('timeframe_start')
+                          (DateTimeHelper.from_rfc3339(hash['timeframe_start']) if hash['timeframe_start'])
+                        else
+                          SKIP
+                        end
+      timeframe_end = if hash.key?('timeframe_end')
+                        (DateTimeHelper.from_rfc3339(hash['timeframe_end']) if hash['timeframe_end'])
+                      else
+                        SKIP
+                      end
+      billable_metric_id =
+        hash.key?('billable_metric_id') ? hash['billable_metric_id'] : SKIP
+      group_by = hash.key?('group_by') ? hash['group_by'] : SKIP
+      view_mode = hash.key?('view_mode') ? hash['view_mode'] : SKIP
+      first_dimension_key =
+        hash.key?('first_dimension_key') ? hash['first_dimension_key'] : SKIP
+      first_dimension_value =
+        hash.key?('first_dimension_value') ? hash['first_dimension_value'] : SKIP
+      second_dimension_key =
+        hash.key?('second_dimension_key') ? hash['second_dimension_key'] : SKIP
+      second_dimension_value =
+        hash.key?('second_dimension_value') ? hash['second_dimension_value'] : SKIP
+
+      # Create object from extracted values.
+      SubscriptionUsageRequestParams.new(granularity: granularity,
+                                         timeframe_start: timeframe_start,
+                                         timeframe_end: timeframe_end,
+                                         billable_metric_id: billable_metric_id,
+                                         group_by: group_by,
+                                         view_mode: view_mode,
+                                         first_dimension_key: first_dimension_key,
+                                         first_dimension_value: first_dimension_value,
+                                         second_dimension_key: second_dimension_key,
+                                         second_dimension_value: second_dimension_value)
+    end
+
+    def to_custom_timeframe_start
+      DateTimeHelper.to_rfc3339(timeframe_start)
+    end
+
+    def to_custom_timeframe_end
+      DateTimeHelper.to_rfc3339(timeframe_end)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} granularity: #{@granularity}, timeframe_start: #{@timeframe_start},"\
+      " timeframe_end: #{@timeframe_end}, billable_metric_id: #{@billable_metric_id}, group_by:"\
+      " #{@group_by}, view_mode: #{@view_mode}, first_dimension_key: #{@first_dimension_key},"\
+      " first_dimension_value: #{@first_dimension_value}, second_dimension_key:"\
+      " #{@second_dimension_key}, second_dimension_value: #{@second_dimension_value}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} granularity: #{@granularity.inspect}, timeframe_start:"\
+      " #{@timeframe_start.inspect}, timeframe_end: #{@timeframe_end.inspect}, billable_metric_id:"\
+      " #{@billable_metric_id.inspect}, group_by: #{@group_by.inspect}, view_mode:"\
+      " #{@view_mode.inspect}, first_dimension_key: #{@first_dimension_key.inspect},"\
+      " first_dimension_value: #{@first_dimension_value.inspect}, second_dimension_key:"\
+      " #{@second_dimension_key.inspect}, second_dimension_value:"\
+      " #{@second_dimension_value.inspect}>"
+    end
+  end
+end

data/lib/api_reference/models/subscriptions.rb

@@ -0,0 +1,92 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # Subscriptions Model.
+  class Subscriptions < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[Subscription]]
+    attr_accessor :data
+
+    # TODO: Write general description for this method
+    # @return [PaginationMetadata]
+    attr_accessor :pagination_metadata
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['data'] = 'data'
+      @_hash['pagination_metadata'] = 'pagination_metadata'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(data:, pagination_metadata:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @data = data
+      @pagination_metadata = pagination_metadata
+      @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
+      data = nil
+      unless hash['data'].nil?
+        data = []
+        hash['data'].each do |structure|
+          data << (Subscription.from_hash(structure) if structure)
+        end
+      end
+
+      data = nil unless hash.key?('data')
+      pagination_metadata = PaginationMetadata.from_hash(hash['pagination_metadata']) if
+        hash['pagination_metadata']
+
+      # 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.
+      Subscriptions.new(data: data,
+                        pagination_metadata: pagination_metadata,
+                        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} data: #{@data}, pagination_metadata: #{@pagination_metadata},"\
+      " 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} data: #{@data.inspect}, pagination_metadata:"\
+      " #{@pagination_metadata.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end