orb-apiamtic-sdk 0.0.1

data/lib/api_reference/models/new_avalara_tax_configuration.rb

@@ -0,0 +1,114 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # NewAvalaraTaxConfiguration Model.
+  class NewAvalaraTaxConfiguration < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :tax_exempt
+
+    # Whether to automatically calculate tax for this customer. When null,
+    # inherits from account-level setting. When true or false, overrides the
+    # account setting.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :automatic_tax_enabled
+
+    # Whether to automatically calculate tax for this customer. When null,
+    # inherits from account-level setting. When true or false, overrides the
+    # account setting.
+    # @return [String]
+    attr_reader :tax_provider
+
+    # Whether to automatically calculate tax for this customer. When null,
+    # inherits from account-level setting. When true or false, overrides the
+    # account setting.
+    # @return [String]
+    attr_accessor :tax_exemption_code
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['tax_exempt'] = 'tax_exempt'
+      @_hash['automatic_tax_enabled'] = 'automatic_tax_enabled'
+      @_hash['tax_provider'] = 'tax_provider'
+      @_hash['tax_exemption_code'] = 'tax_exemption_code'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        automatic_tax_enabled
+        tax_exemption_code
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        automatic_tax_enabled
+        tax_exemption_code
+      ]
+    end
+
+    def initialize(tax_exempt:, automatic_tax_enabled: SKIP,
+                   tax_exemption_code: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @tax_exempt = tax_exempt
+      @automatic_tax_enabled = automatic_tax_enabled unless automatic_tax_enabled == SKIP
+      @tax_provider = 'avalara'
+      @tax_exemption_code = tax_exemption_code unless tax_exemption_code == 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.
+      tax_exempt = hash.key?('tax_exempt') ? hash['tax_exempt'] : nil
+      automatic_tax_enabled =
+        hash.key?('automatic_tax_enabled') ? hash['automatic_tax_enabled'] : SKIP
+      tax_exemption_code =
+        hash.key?('tax_exemption_code') ? hash['tax_exemption_code'] : 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.
+      NewAvalaraTaxConfiguration.new(tax_exempt: tax_exempt,
+                                     automatic_tax_enabled: automatic_tax_enabled,
+                                     tax_exemption_code: tax_exemption_code,
+                                     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} tax_exempt: #{@tax_exempt}, automatic_tax_enabled:"\
+      " #{@automatic_tax_enabled}, tax_provider: #{@tax_provider}, tax_exemption_code:"\
+      " #{@tax_exemption_code}, 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} tax_exempt: #{@tax_exempt.inspect}, automatic_tax_enabled:"\
+      " #{@automatic_tax_enabled.inspect}, tax_provider: #{@tax_provider.inspect},"\
+      " tax_exemption_code: #{@tax_exemption_code.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/new_backfill.rb

@@ -0,0 +1,165 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module ApiReference
+  # NewBackfill Model.
+  class NewBackfill < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # If true, replaces all existing events in the timeframe with the newly
+    # ingested events. If false, adds the newly ingested events to the existing
+    # events.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :replace_existing_events
+
+    # The (inclusive) start of the usage timeframe affected by this backfill. By
+    # default, Orb allows backfills up to 31 days in duration at a time. Reach
+    # out to discuss extending this limit and your use case.
+    # @return [DateTime]
+    attr_accessor :timeframe_start
+
+    # The (exclusive) end of the usage timeframe affected by this backfill. By
+    # default, Orb allows backfills up to 31 days in duration at a time. Reach
+    # out to discuss extending this limit and your use case.
+    # @return [DateTime]
+    attr_accessor :timeframe_end
+
+    # The time at which no more events will be accepted for this backfill. The
+    # backfill will automatically begin reflecting throughout Orb at the close
+    # time. If not specified, it will default to 1 day after the creation of the
+    # backfill.
+    # @return [DateTime]
+    attr_accessor :close_time
+
+    # The Orb-generated ID of the customer to which this backfill is scoped.
+    # Omitting this field will scope the backfill to all customers.
+    # @return [String]
+    attr_accessor :customer_id
+
+    # The external customer ID of the customer to which this backfill is scoped.
+    # Omitting this field will scope the backfill to all customers.
+    # @return [String]
+    attr_accessor :external_customer_id
+
+    # A boolean [computed
+    # property](/extensibility/advanced-metrics#computed-properties) used to
+    # filter the set of events to deprecate
+    # @return [String]
+    attr_accessor :deprecation_filter
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['replace_existing_events'] = 'replace_existing_events'
+      @_hash['timeframe_start'] = 'timeframe_start'
+      @_hash['timeframe_end'] = 'timeframe_end'
+      @_hash['close_time'] = 'close_time'
+      @_hash['customer_id'] = 'customer_id'
+      @_hash['external_customer_id'] = 'external_customer_id'
+      @_hash['deprecation_filter'] = 'deprecation_filter'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        replace_existing_events
+        close_time
+        customer_id
+        external_customer_id
+        deprecation_filter
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        close_time
+        customer_id
+        external_customer_id
+        deprecation_filter
+      ]
+    end
+
+    def initialize(timeframe_start:, timeframe_end:,
+                   replace_existing_events: true, close_time: SKIP,
+                   customer_id: SKIP, external_customer_id: SKIP,
+                   deprecation_filter: SKIP)
+      @replace_existing_events = replace_existing_events unless replace_existing_events == SKIP
+      @timeframe_start = timeframe_start
+      @timeframe_end = timeframe_end
+      @close_time = close_time unless close_time == SKIP
+      @customer_id = customer_id unless customer_id == SKIP
+      @external_customer_id = external_customer_id unless external_customer_id == SKIP
+      @deprecation_filter = deprecation_filter unless deprecation_filter == 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.
+      timeframe_start = if hash.key?('timeframe_start')
+                          (DateTimeHelper.from_rfc3339(hash['timeframe_start']) if hash['timeframe_start'])
+                        end
+      timeframe_end = if hash.key?('timeframe_end')
+                        (DateTimeHelper.from_rfc3339(hash['timeframe_end']) if hash['timeframe_end'])
+                      end
+      replace_existing_events = hash['replace_existing_events'] ||= true
+      close_time = if hash.key?('close_time')
+                     (DateTimeHelper.from_rfc3339(hash['close_time']) if hash['close_time'])
+                   else
+                     SKIP
+                   end
+      customer_id = hash.key?('customer_id') ? hash['customer_id'] : SKIP
+      external_customer_id =
+        hash.key?('external_customer_id') ? hash['external_customer_id'] : SKIP
+      deprecation_filter =
+        hash.key?('deprecation_filter') ? hash['deprecation_filter'] : SKIP
+
+      # Create object from extracted values.
+      NewBackfill.new(timeframe_start: timeframe_start,
+                      timeframe_end: timeframe_end,
+                      replace_existing_events: replace_existing_events,
+                      close_time: close_time,
+                      customer_id: customer_id,
+                      external_customer_id: external_customer_id,
+                      deprecation_filter: deprecation_filter)
+    end
+
+    def to_custom_timeframe_start
+      DateTimeHelper.to_rfc3339(timeframe_start)
+    end
+
+    def to_custom_timeframe_end
+      DateTimeHelper.to_rfc3339(timeframe_end)
+    end
+
+    def to_custom_close_time
+      DateTimeHelper.to_rfc3339(close_time)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} replace_existing_events: #{@replace_existing_events}, timeframe_start:"\
+      " #{@timeframe_start}, timeframe_end: #{@timeframe_end}, close_time: #{@close_time},"\
+      " customer_id: #{@customer_id}, external_customer_id: #{@external_customer_id},"\
+      " deprecation_filter: #{@deprecation_filter}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} replace_existing_events: #{@replace_existing_events.inspect},"\
+      " timeframe_start: #{@timeframe_start.inspect}, timeframe_end: #{@timeframe_end.inspect},"\
+      " close_time: #{@close_time.inspect}, customer_id: #{@customer_id.inspect},"\
+      " external_customer_id: #{@external_customer_id.inspect}, deprecation_filter:"\
+      " #{@deprecation_filter.inspect}>"
+    end
+  end
+end

data/lib/api_reference/models/new_billable_metric.rb

@@ -0,0 +1,101 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # NewBillableMetric Model.
+  class NewBillableMetric < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # User-specified key/value pairs for the resource. Individual keys can be
+    # removed by setting the value to `null`, and the entire metadata mapping
+    # can be cleared by setting `metadata` to `null`.
+    # @return [Hash[String, String]]
+    attr_accessor :metadata
+
+    # A sql string defining the metric.
+    # @return [String]
+    attr_accessor :sql
+
+    # The name of the metric.
+    # @return [String]
+    attr_accessor :name
+
+    # The id of the item
+    # @return [String]
+    attr_accessor :item_id
+
+    # A description of the metric.
+    # @return [String]
+    attr_accessor :description
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['metadata'] = 'metadata'
+      @_hash['sql'] = 'sql'
+      @_hash['name'] = 'name'
+      @_hash['item_id'] = 'item_id'
+      @_hash['description'] = 'description'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        metadata
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        metadata
+        description
+      ]
+    end
+
+    def initialize(sql:, name:, item_id:, description:, metadata: SKIP)
+      @metadata = metadata unless metadata == SKIP
+      @sql = sql
+      @name = name
+      @item_id = item_id
+      @description = description
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      sql = hash.key?('sql') ? hash['sql'] : nil
+      name = hash.key?('name') ? hash['name'] : nil
+      item_id = hash.key?('item_id') ? hash['item_id'] : nil
+      description = hash.key?('description') ? hash['description'] : nil
+      metadata = hash.key?('metadata') ? hash['metadata'] : SKIP
+
+      # Create object from extracted values.
+      NewBillableMetric.new(sql: sql,
+                            name: name,
+                            item_id: item_id,
+                            description: description,
+                            metadata: metadata)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} metadata: #{@metadata}, sql: #{@sql}, name: #{@name}, item_id: #{@item_id},"\
+      " description: #{@description}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} metadata: #{@metadata.inspect}, sql: #{@sql.inspect}, name:"\
+      " #{@name.inspect}, item_id: #{@item_id.inspect}, description: #{@description.inspect}>"
+    end
+  end
+end

data/lib/api_reference/models/new_billing_cycle_configuration.rb

@@ -0,0 +1,104 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # NewBillingCycleConfiguration Model.
+  class NewBillingCycleConfiguration < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The duration of the billing period.
+    # @return [Integer]
+    attr_accessor :duration
+
+    # The unit of billing period duration.
+    # @return [DurationUnit]
+    attr_accessor :duration_unit
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['duration'] = 'duration'
+      @_hash['duration_unit'] = 'duration_unit'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(duration:, duration_unit:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @duration = duration
+      @duration_unit = duration_unit
+      @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.
+      duration = hash.key?('duration') ? hash['duration'] : nil
+      duration_unit = hash.key?('duration_unit') ? hash['duration_unit'] : nil
+
+      # 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.
+      NewBillingCycleConfiguration.new(duration: duration,
+                                       duration_unit: duration_unit,
+                                       additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [NewBillingCycleConfiguration | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.duration,
+                                ->(val) { val.instance_of? Integer }) and
+            APIHelper.valid_type?(value.duration_unit,
+                                  ->(val) { DurationUnit.validate(val) })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['duration'],
+                              ->(val) { val.instance_of? Integer }) and
+          APIHelper.valid_type?(value['duration_unit'],
+                                ->(val) { DurationUnit.validate(val) })
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} duration: #{@duration}, duration_unit: #{@duration_unit},"\
+      " 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} duration: #{@duration.inspect}, duration_unit: #{@duration_unit.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/new_coupon.rb

@@ -0,0 +1,123 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # NewCoupon Model.
+  class NewCoupon < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # This string can be used to redeem this coupon for a given subscription.
+    # @return [String]
+    attr_accessor :redemption_code
+
+    # This string can be used to redeem this coupon for a given subscription.
+    # @return [Object]
+    attr_accessor :discount
+
+    # This allows for a coupon's discount to apply for a limited time
+    # (determined in months); a `null` value here means "unlimited time".
+    # @return [Integer]
+    attr_accessor :duration_in_months
+
+    # The maximum number of redemptions allowed for this coupon before it is
+    # exhausted;`null` here means "unlimited".
+    # @return [Integer]
+    attr_accessor :max_redemptions
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['redemption_code'] = 'redemption_code'
+      @_hash['discount'] = 'discount'
+      @_hash['duration_in_months'] = 'duration_in_months'
+      @_hash['max_redemptions'] = 'max_redemptions'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        duration_in_months
+        max_redemptions
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        duration_in_months
+        max_redemptions
+      ]
+    end
+
+    def initialize(redemption_code:, discount:, duration_in_months: SKIP,
+                   max_redemptions: SKIP)
+      @redemption_code = redemption_code
+      @discount = discount
+      @duration_in_months = duration_in_months unless duration_in_months == SKIP
+      @max_redemptions = max_redemptions unless max_redemptions == 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.
+      redemption_code =
+        hash.key?('redemption_code') ? hash['redemption_code'] : nil
+      discount = hash.key?('discount') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:NewCouponDiscount), hash['discount']
+      ) : nil
+      duration_in_months =
+        hash.key?('duration_in_months') ? hash['duration_in_months'] : SKIP
+      max_redemptions =
+        hash.key?('max_redemptions') ? hash['max_redemptions'] : SKIP
+
+      # Create object from extracted values.
+      NewCoupon.new(redemption_code: redemption_code,
+                    discount: discount,
+                    duration_in_months: duration_in_months,
+                    max_redemptions: max_redemptions)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [NewCoupon | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.redemption_code,
+                                ->(val) { val.instance_of? String }) and
+            UnionTypeLookUp.get(:NewCouponDiscount)
+                           .validate(value.discount)
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['redemption_code'],
+                              ->(val) { val.instance_of? String }) and
+          UnionTypeLookUp.get(:NewCouponDiscount)
+                         .validate(value['discount'])
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} redemption_code: #{@redemption_code}, discount: #{@discount},"\
+      " duration_in_months: #{@duration_in_months}, max_redemptions: #{@max_redemptions}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} redemption_code: #{@redemption_code.inspect}, discount:"\
+      " #{@discount.inspect}, duration_in_months: #{@duration_in_months.inspect}, max_redemptions:"\
+      " #{@max_redemptions.inspect}>"
+    end
+  end
+end