maxio-advanced-billing-sdk 0.0.3 → 0.0.4

data/lib/advanced_billing/models/create_product_price_point.rb

@@ -0,0 +1,198 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # CreateProductPricePoint Model.
+  class CreateProductPricePoint < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The product price point name
+    # @return [String]
+    attr_accessor :name
+
+    # The product price point API handle
+    # @return [String]
+    attr_accessor :handle
+
+    # The product price point price, in integer cents
+    # @return [Integer]
+    attr_accessor :price_in_cents
+
+    # The numerical interval. i.e. an interval of ‘30’ coupled with an
+    # interval_unit of day would mean this product price point would renew every
+    # 30 days
+    # @return [Integer]
+    attr_accessor :interval
+
+    # A string representing the interval unit for this product price point,
+    # either month or day
+    # @return [IntervalUnit]
+    attr_accessor :interval_unit
+
+    # The product price point trial price, in integer cents
+    # @return [Integer]
+    attr_accessor :trial_price_in_cents
+
+    # The numerical trial interval. i.e. an interval of ‘30’ coupled with an
+    # trial_interval_unit of day would mean this product price point would renew
+    # every 30 days
+    # @return [Integer]
+    attr_accessor :trial_interval
+
+    # A string representing the trial interval unit for this product price
+    # point, either month or day
+    # @return [IntervalUnit]
+    attr_accessor :trial_interval_unit
+
+    # A string representing the trial interval unit for this product price
+    # point, either month or day
+    # @return [String]
+    attr_accessor :trial_type
+
+    # The product price point initial charge, in integer cents
+    # @return [Integer]
+    attr_accessor :initial_charge_in_cents
+
+    # The product price point initial charge, in integer cents
+    # @return [TrueClass | FalseClass]
+    attr_accessor :initial_charge_after_trial
+
+    # The numerical expiration interval. i.e. an expiration_interval of ‘30’
+    # coupled with an expiration_interval_unit of day would mean this product
+    # price point would expire every 30 days
+    # @return [Integer]
+    attr_accessor :expiration_interval
+
+    # A string representing the expiration interval unit for this product price
+    # point, either month or day
+    # @return [IntervalUnit]
+    attr_accessor :expiration_interval_unit
+
+    # Whether or not to use the site's exchange rate or define your own pricing
+    # when your site has multiple currencies defined.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :use_site_exchange_rate
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['handle'] = 'handle'
+      @_hash['price_in_cents'] = 'price_in_cents'
+      @_hash['interval'] = 'interval'
+      @_hash['interval_unit'] = 'interval_unit'
+      @_hash['trial_price_in_cents'] = 'trial_price_in_cents'
+      @_hash['trial_interval'] = 'trial_interval'
+      @_hash['trial_interval_unit'] = 'trial_interval_unit'
+      @_hash['trial_type'] = 'trial_type'
+      @_hash['initial_charge_in_cents'] = 'initial_charge_in_cents'
+      @_hash['initial_charge_after_trial'] = 'initial_charge_after_trial'
+      @_hash['expiration_interval'] = 'expiration_interval'
+      @_hash['expiration_interval_unit'] = 'expiration_interval_unit'
+      @_hash['use_site_exchange_rate'] = 'use_site_exchange_rate'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        handle
+        trial_price_in_cents
+        trial_interval
+        trial_interval_unit
+        trial_type
+        initial_charge_in_cents
+        initial_charge_after_trial
+        expiration_interval
+        expiration_interval_unit
+        use_site_exchange_rate
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name = nil,
+                   price_in_cents = nil,
+                   interval = nil,
+                   interval_unit = nil,
+                   handle = SKIP,
+                   trial_price_in_cents = SKIP,
+                   trial_interval = SKIP,
+                   trial_interval_unit = SKIP,
+                   trial_type = SKIP,
+                   initial_charge_in_cents = SKIP,
+                   initial_charge_after_trial = SKIP,
+                   expiration_interval = SKIP,
+                   expiration_interval_unit = SKIP,
+                   use_site_exchange_rate = true)
+      @name = name
+      @handle = handle unless handle == SKIP
+      @price_in_cents = price_in_cents
+      @interval = interval
+      @interval_unit = interval_unit
+      @trial_price_in_cents = trial_price_in_cents unless trial_price_in_cents == SKIP
+      @trial_interval = trial_interval unless trial_interval == SKIP
+      @trial_interval_unit = trial_interval_unit unless trial_interval_unit == SKIP
+      @trial_type = trial_type unless trial_type == SKIP
+      @initial_charge_in_cents = initial_charge_in_cents unless initial_charge_in_cents == SKIP
+      unless initial_charge_after_trial == SKIP
+        @initial_charge_after_trial =
+          initial_charge_after_trial
+      end
+      @expiration_interval = expiration_interval unless expiration_interval == SKIP
+      @expiration_interval_unit = expiration_interval_unit unless expiration_interval_unit == SKIP
+      @use_site_exchange_rate = use_site_exchange_rate unless use_site_exchange_rate == 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.
+      name = hash.key?('name') ? hash['name'] : nil
+      price_in_cents =
+        hash.key?('price_in_cents') ? hash['price_in_cents'] : nil
+      interval = hash.key?('interval') ? hash['interval'] : nil
+      interval_unit = hash.key?('interval_unit') ? hash['interval_unit'] : nil
+      handle = hash.key?('handle') ? hash['handle'] : SKIP
+      trial_price_in_cents =
+        hash.key?('trial_price_in_cents') ? hash['trial_price_in_cents'] : SKIP
+      trial_interval =
+        hash.key?('trial_interval') ? hash['trial_interval'] : SKIP
+      trial_interval_unit =
+        hash.key?('trial_interval_unit') ? hash['trial_interval_unit'] : SKIP
+      trial_type = hash.key?('trial_type') ? hash['trial_type'] : SKIP
+      initial_charge_in_cents =
+        hash.key?('initial_charge_in_cents') ? hash['initial_charge_in_cents'] : SKIP
+      initial_charge_after_trial =
+        hash.key?('initial_charge_after_trial') ? hash['initial_charge_after_trial'] : SKIP
+      expiration_interval =
+        hash.key?('expiration_interval') ? hash['expiration_interval'] : SKIP
+      expiration_interval_unit =
+        hash.key?('expiration_interval_unit') ? hash['expiration_interval_unit'] : SKIP
+      use_site_exchange_rate = hash['use_site_exchange_rate'] ||= true
+
+      # Create object from extracted values.
+      CreateProductPricePoint.new(name,
+                                  price_in_cents,
+                                  interval,
+                                  interval_unit,
+                                  handle,
+                                  trial_price_in_cents,
+                                  trial_interval,
+                                  trial_interval_unit,
+                                  trial_type,
+                                  initial_charge_in_cents,
+                                  initial_charge_after_trial,
+                                  expiration_interval,
+                                  expiration_interval_unit,
+                                  use_site_exchange_rate)
+    end
+  end
+end

data/lib/advanced_billing/models/create_product_price_point_request.rb

@@ -0,0 +1,48 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # CreateProductPricePointRequest Model.
+  class CreateProductPricePointRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [CreateProductPricePoint]
+    attr_accessor :price_point
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['price_point'] = 'price_point'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(price_point = nil)
+      @price_point = price_point
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      price_point = CreateProductPricePoint.from_hash(hash['price_point']) if hash['price_point']
+
+      # Create object from extracted values.
+      CreateProductPricePointRequest.new(price_point)
+    end
+  end
+end

data/lib/advanced_billing/models/create_quantity_based_component.rb

@@ -0,0 +1,50 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # CreateQuantityBasedComponent Model.
+  class CreateQuantityBasedComponent < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [QuantityBasedComponent]
+    attr_accessor :quantity_based_component
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['quantity_based_component'] = 'quantity_based_component'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(quantity_based_component = nil)
+      @quantity_based_component = quantity_based_component
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      if hash['quantity_based_component']
+        quantity_based_component = QuantityBasedComponent.from_hash(hash['quantity_based_component'])
+      end
+
+      # Create object from extracted values.
+      CreateQuantityBasedComponent.new(quantity_based_component)
+    end
+  end
+end

data/lib/advanced_billing/models/create_reason_code.rb

@@ -0,0 +1,68 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # CreateReasonCode Model.
+  class CreateReasonCode < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The unique identifier for the ReasonCode
+    # @return [String]
+    attr_accessor :code
+
+    # The friendly summary of what the code signifies
+    # @return [String]
+    attr_accessor :description
+
+    # The order that code appears in lists
+    # @return [Integer]
+    attr_accessor :position
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['code'] = 'code'
+      @_hash['description'] = 'description'
+      @_hash['position'] = 'position'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        position
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(code = nil,
+                   description = nil,
+                   position = SKIP)
+      @code = code
+      @description = description
+      @position = position unless position == 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.
+      code = hash.key?('code') ? hash['code'] : nil
+      description = hash.key?('description') ? hash['description'] : nil
+      position = hash.key?('position') ? hash['position'] : SKIP
+
+      # Create object from extracted values.
+      CreateReasonCode.new(code,
+                           description,
+                           position)
+    end
+  end
+end

data/lib/advanced_billing/models/create_reason_code_request.rb

@@ -0,0 +1,48 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # CreateReasonCodeRequest Model.
+  class CreateReasonCodeRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [CreateReasonCode]
+    attr_accessor :reason_code
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['reason_code'] = 'reason_code'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(reason_code = nil)
+      @reason_code = reason_code
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      reason_code = CreateReasonCode.from_hash(hash['reason_code']) if hash['reason_code']
+
+      # Create object from extracted values.
+      CreateReasonCodeRequest.new(reason_code)
+    end
+  end
+end

data/lib/advanced_billing/models/create_segment.rb

@@ -0,0 +1,143 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # CreateSegment Model.
+  class CreateSegment < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A value that will occur in your events that you want to bill upon. The
+    # type of the value depends on the property type in the related event based
+    # billing metric.
+    # @return [Object]
+    attr_accessor :segment_property_1_value
+
+    # A value that will occur in your events that you want to bill upon. The
+    # type of the value depends on the property type in the related event based
+    # billing metric.
+    # @return [Object]
+    attr_accessor :segment_property_2_value
+
+    # A value that will occur in your events that you want to bill upon. The
+    # type of the value depends on the property type in the related event based
+    # billing metric.
+    # @return [Object]
+    attr_accessor :segment_property_3_value
+
+    # A value that will occur in your events that you want to bill upon. The
+    # type of the value depends on the property type in the related event based
+    # billing metric.
+    # @return [Object]
+    attr_accessor :segment_property_4_value
+
+    # The identifier for the pricing scheme. See [Product
+    # Components](https://help.chargify.com/products/product-components.html)
+    # for an overview of pricing schemes.
+    # @return [PricingScheme]
+    attr_accessor :pricing_scheme
+
+    # The identifier for the pricing scheme. See [Product
+    # Components](https://help.chargify.com/products/product-components.html)
+    # for an overview of pricing schemes.
+    # @return [Array[CreateOrUpdateSegmentPrice]]
+    attr_accessor :prices
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['segment_property_1_value'] = 'segment_property_1_value'
+      @_hash['segment_property_2_value'] = 'segment_property_2_value'
+      @_hash['segment_property_3_value'] = 'segment_property_3_value'
+      @_hash['segment_property_4_value'] = 'segment_property_4_value'
+      @_hash['pricing_scheme'] = 'pricing_scheme'
+      @_hash['prices'] = 'prices'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        segment_property_1_value
+        segment_property_2_value
+        segment_property_3_value
+        segment_property_4_value
+        prices
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(pricing_scheme = nil,
+                   segment_property_1_value = SKIP,
+                   segment_property_2_value = SKIP,
+                   segment_property_3_value = SKIP,
+                   segment_property_4_value = SKIP,
+                   prices = SKIP)
+      @segment_property_1_value = segment_property_1_value unless segment_property_1_value == SKIP
+      @segment_property_2_value = segment_property_2_value unless segment_property_2_value == SKIP
+      @segment_property_3_value = segment_property_3_value unless segment_property_3_value == SKIP
+      @segment_property_4_value = segment_property_4_value unless segment_property_4_value == SKIP
+      @pricing_scheme = pricing_scheme
+      @prices = prices unless prices == 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.
+      pricing_scheme =
+        hash.key?('pricing_scheme') ? hash['pricing_scheme'] : nil
+      segment_property_1_value = hash.key?('segment_property_1_value') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:CreateSegmentSegmentProperty1Value), hash['segment_property_1_value']
+      ) : SKIP
+      segment_property_2_value = hash.key?('segment_property_2_value') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:CreateSegmentSegmentProperty2Value), hash['segment_property_2_value']
+      ) : SKIP
+      segment_property_3_value = hash.key?('segment_property_3_value') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:CreateSegmentSegmentProperty3Value), hash['segment_property_3_value']
+      ) : SKIP
+      segment_property_4_value = hash.key?('segment_property_4_value') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:CreateSegmentSegmentProperty4Value), hash['segment_property_4_value']
+      ) : SKIP
+      # Parameter is an array, so we need to iterate through it
+      prices = nil
+      unless hash['prices'].nil?
+        prices = []
+        hash['prices'].each do |structure|
+          prices << (CreateOrUpdateSegmentPrice.from_hash(structure) if structure)
+        end
+      end
+
+      prices = SKIP unless hash.key?('prices')
+
+      # Create object from extracted values.
+      CreateSegment.new(pricing_scheme,
+                        segment_property_1_value,
+                        segment_property_2_value,
+                        segment_property_3_value,
+                        segment_property_4_value,
+                        prices)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [CreateSegment | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.pricing_scheme,
+                                     ->(val) { PricingScheme.validate(val) })
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['pricing_scheme'],
+                            ->(val) { PricingScheme.validate(val) })
+    end
+  end
+end

data/lib/advanced_billing/models/create_segment_request.rb

@@ -0,0 +1,48 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # CreateSegmentRequest Model.
+  class CreateSegmentRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [CreateSegment]
+    attr_accessor :segment
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['segment'] = 'segment'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(segment = nil)
+      @segment = segment
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      segment = CreateSegment.from_hash(hash['segment']) if hash['segment']
+
+      # Create object from extracted values.
+      CreateSegmentRequest.new(segment)
+    end
+  end
+end