maxio-advanced-billing-sdk 0.0.3 → 0.0.4

data/lib/advanced_billing/models/coupon_restriction.rb

@@ -0,0 +1,92 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # CouponRestriction Model.
+  class CouponRestriction < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :id
+
+    # TODO: Write general description for this method
+    # @return [RestrictionType]
+    attr_accessor :item_type
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :item_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :name
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :handle
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['item_type'] = 'item_type'
+      @_hash['item_id'] = 'item_id'
+      @_hash['name'] = 'name'
+      @_hash['handle'] = 'handle'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        item_type
+        item_id
+        name
+        handle
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        handle
+      ]
+    end
+
+    def initialize(id = SKIP,
+                   item_type = SKIP,
+                   item_id = SKIP,
+                   name = SKIP,
+                   handle = SKIP)
+      @id = id unless id == SKIP
+      @item_type = item_type unless item_type == SKIP
+      @item_id = item_id unless item_id == SKIP
+      @name = name unless name == SKIP
+      @handle = handle unless handle == 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.
+      id = hash.key?('id') ? hash['id'] : SKIP
+      item_type = hash.key?('item_type') ? hash['item_type'] : SKIP
+      item_id = hash.key?('item_id') ? hash['item_id'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+      handle = hash.key?('handle') ? hash['handle'] : SKIP
+
+      # Create object from extracted values.
+      CouponRestriction.new(id,
+                            item_type,
+                            item_id,
+                            name,
+                            handle)
+    end
+  end
+end

data/lib/advanced_billing/models/coupon_subcodes.rb

@@ -0,0 +1,50 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # CouponSubcodes Model.
+  class CouponSubcodes < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[String]]
+    attr_accessor :codes
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['codes'] = 'codes'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        codes
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(codes = SKIP)
+      @codes = codes unless codes == 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.
+      codes = hash.key?('codes') ? hash['codes'] : SKIP
+
+      # Create object from extracted values.
+      CouponSubcodes.new(codes)
+    end
+  end
+end

data/lib/advanced_billing/models/coupon_subcodes_response.rb

@@ -0,0 +1,71 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # CouponSubcodesResponse Model.
+  class CouponSubcodesResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[String]]
+    attr_accessor :created_codes
+
+    # TODO: Write general description for this method
+    # @return [Array[String]]
+    attr_accessor :duplicate_codes
+
+    # TODO: Write general description for this method
+    # @return [Array[String]]
+    attr_accessor :invalid_codes
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['created_codes'] = 'created_codes'
+      @_hash['duplicate_codes'] = 'duplicate_codes'
+      @_hash['invalid_codes'] = 'invalid_codes'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        created_codes
+        duplicate_codes
+        invalid_codes
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(created_codes = SKIP,
+                   duplicate_codes = SKIP,
+                   invalid_codes = SKIP)
+      @created_codes = created_codes unless created_codes == SKIP
+      @duplicate_codes = duplicate_codes unless duplicate_codes == SKIP
+      @invalid_codes = invalid_codes unless invalid_codes == 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.
+      created_codes = hash.key?('created_codes') ? hash['created_codes'] : SKIP
+      duplicate_codes =
+        hash.key?('duplicate_codes') ? hash['duplicate_codes'] : SKIP
+      invalid_codes = hash.key?('invalid_codes') ? hash['invalid_codes'] : SKIP
+
+      # Create object from extracted values.
+      CouponSubcodesResponse.new(created_codes,
+                                 duplicate_codes,
+                                 invalid_codes)
+    end
+  end
+end

data/lib/advanced_billing/models/coupon_usage.rb

@@ -0,0 +1,118 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # CouponUsage Model.
+  class CouponUsage < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The Chargify id of the product
+    # @return [Integer]
+    attr_accessor :id
+
+    # Name of the product
+    # @return [String]
+    attr_accessor :name
+
+    # Number of times the coupon has been applied
+    # @return [Integer]
+    attr_accessor :signups
+
+    # Dollar amount of customer savings as a result of the coupon.
+    # @return [Integer]
+    attr_accessor :savings
+
+    # Dollar amount of customer savings as a result of the coupon.
+    # @return [Integer]
+    attr_accessor :savings_in_cents
+
+    # Total revenue of the all subscriptions that have received a discount from
+    # this coupon.
+    # @return [Integer]
+    attr_accessor :revenue
+
+    # Total revenue of the all subscriptions that have received a discount from
+    # this coupon.
+    # @return [Integer]
+    attr_accessor :revenue_in_cents
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['name'] = 'name'
+      @_hash['signups'] = 'signups'
+      @_hash['savings'] = 'savings'
+      @_hash['savings_in_cents'] = 'savings_in_cents'
+      @_hash['revenue'] = 'revenue'
+      @_hash['revenue_in_cents'] = 'revenue_in_cents'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        name
+        signups
+        savings
+        savings_in_cents
+        revenue
+        revenue_in_cents
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        savings
+        savings_in_cents
+        revenue
+      ]
+    end
+
+    def initialize(id = SKIP,
+                   name = SKIP,
+                   signups = SKIP,
+                   savings = SKIP,
+                   savings_in_cents = SKIP,
+                   revenue = SKIP,
+                   revenue_in_cents = SKIP)
+      @id = id unless id == SKIP
+      @name = name unless name == SKIP
+      @signups = signups unless signups == SKIP
+      @savings = savings unless savings == SKIP
+      @savings_in_cents = savings_in_cents unless savings_in_cents == SKIP
+      @revenue = revenue unless revenue == SKIP
+      @revenue_in_cents = revenue_in_cents unless revenue_in_cents == 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.
+      id = hash.key?('id') ? hash['id'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+      signups = hash.key?('signups') ? hash['signups'] : SKIP
+      savings = hash.key?('savings') ? hash['savings'] : SKIP
+      savings_in_cents =
+        hash.key?('savings_in_cents') ? hash['savings_in_cents'] : SKIP
+      revenue = hash.key?('revenue') ? hash['revenue'] : SKIP
+      revenue_in_cents =
+        hash.key?('revenue_in_cents') ? hash['revenue_in_cents'] : SKIP
+
+      # Create object from extracted values.
+      CouponUsage.new(id,
+                      name,
+                      signups,
+                      savings,
+                      savings_in_cents,
+                      revenue,
+                      revenue_in_cents)
+    end
+  end
+end

data/lib/advanced_billing/models/create_allocation.rb

@@ -0,0 +1,198 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # CreateAllocation Model.
+  class CreateAllocation < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The allocated quantity to which to set the line-items allocated quantity.
+    # By default, this is an integer. If decimal allocations are enabled for the
+    # component, it will be a decimal number. For On/Off components, use 1for on
+    # and 0 for off.
+    # @return [Float]
+    attr_accessor :quantity
+
+    # (required for the multiple allocations endpoint) The id associated with
+    # the component for which the allocation is being made
+    # @return [Integer]
+    attr_accessor :component_id
+
+    # A memo to record along with the allocation
+    # @return [String]
+    attr_accessor :memo
+
+    # The scheme used if the proration is a downgrade. Defaults to the site
+    # setting if one is not provided.
+    # @return [String]
+    attr_accessor :proration_downgrade_scheme
+
+    # The scheme used if the proration is an upgrade. Defaults to the site
+    # setting if one is not provided.
+    # @return [String]
+    attr_accessor :proration_upgrade_scheme
+
+    # If the change in cost is an upgrade, this determines if the charge should
+    # accrue to the next renewal or if capture should be attempted immediately.
+    # Defaults to the site setting if one is not provided.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :accrue_charge
+
+    # The type of credit to be created when upgrading/downgrading. Defaults to
+    # the component and then site setting if one is not provided.
+    # Available values: `full`, `prorated`, `none`.
+    # @return [CreditType]
+    attr_accessor :downgrade_credit
+
+    # The type of credit to be created when upgrading/downgrading. Defaults to
+    # the component and then site setting if one is not provided.
+    # Available values: `full`, `prorated`, `none`.
+    # @return [CreditType]
+    attr_accessor :upgrade_charge
+
+    # If set to true, if the immediate component payment fails, initiate dunning
+    # for the subscription. 
+    # Otherwise, leave the charges on the subscription to pay for at renewal.
+    # Defaults to false.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :initiate_dunning
+
+    # Price point that the allocation should be charged at. Accepts either the
+    # price point's id (integer) or handle (string). When not specified, the
+    # default price point will be used.
+    # @return [Object]
+    attr_accessor :price_point_id
+
+    # This attribute is particularly useful when you need to align billing
+    # events for different components on distinct schedules within a
+    # subscription. Please note this only works for site with Multifrequency
+    # enabled
+    # @return [BillingSchedule]
+    attr_accessor :billing_schedule
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['quantity'] = 'quantity'
+      @_hash['component_id'] = 'component_id'
+      @_hash['memo'] = 'memo'
+      @_hash['proration_downgrade_scheme'] = 'proration_downgrade_scheme'
+      @_hash['proration_upgrade_scheme'] = 'proration_upgrade_scheme'
+      @_hash['accrue_charge'] = 'accrue_charge'
+      @_hash['downgrade_credit'] = 'downgrade_credit'
+      @_hash['upgrade_charge'] = 'upgrade_charge'
+      @_hash['initiate_dunning'] = 'initiate_dunning'
+      @_hash['price_point_id'] = 'price_point_id'
+      @_hash['billing_schedule'] = 'billing_schedule'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        component_id
+        memo
+        proration_downgrade_scheme
+        proration_upgrade_scheme
+        accrue_charge
+        downgrade_credit
+        upgrade_charge
+        initiate_dunning
+        price_point_id
+        billing_schedule
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        downgrade_credit
+        upgrade_charge
+        price_point_id
+      ]
+    end
+
+    def initialize(quantity = nil,
+                   component_id = SKIP,
+                   memo = SKIP,
+                   proration_downgrade_scheme = SKIP,
+                   proration_upgrade_scheme = SKIP,
+                   accrue_charge = SKIP,
+                   downgrade_credit = SKIP,
+                   upgrade_charge = SKIP,
+                   initiate_dunning = SKIP,
+                   price_point_id = SKIP,
+                   billing_schedule = SKIP)
+      @quantity = quantity
+      @component_id = component_id unless component_id == SKIP
+      @memo = memo unless memo == SKIP
+      unless proration_downgrade_scheme == SKIP
+        @proration_downgrade_scheme =
+          proration_downgrade_scheme
+      end
+      @proration_upgrade_scheme = proration_upgrade_scheme unless proration_upgrade_scheme == SKIP
+      @accrue_charge = accrue_charge unless accrue_charge == SKIP
+      @downgrade_credit = downgrade_credit unless downgrade_credit == SKIP
+      @upgrade_charge = upgrade_charge unless upgrade_charge == SKIP
+      @initiate_dunning = initiate_dunning unless initiate_dunning == SKIP
+      @price_point_id = price_point_id unless price_point_id == SKIP
+      @billing_schedule = billing_schedule unless billing_schedule == 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.
+      quantity = hash.key?('quantity') ? hash['quantity'] : nil
+      component_id = hash.key?('component_id') ? hash['component_id'] : SKIP
+      memo = hash.key?('memo') ? hash['memo'] : SKIP
+      proration_downgrade_scheme =
+        hash.key?('proration_downgrade_scheme') ? hash['proration_downgrade_scheme'] : SKIP
+      proration_upgrade_scheme =
+        hash.key?('proration_upgrade_scheme') ? hash['proration_upgrade_scheme'] : SKIP
+      accrue_charge = hash.key?('accrue_charge') ? hash['accrue_charge'] : SKIP
+      downgrade_credit =
+        hash.key?('downgrade_credit') ? hash['downgrade_credit'] : SKIP
+      upgrade_charge =
+        hash.key?('upgrade_charge') ? hash['upgrade_charge'] : SKIP
+      initiate_dunning =
+        hash.key?('initiate_dunning') ? hash['initiate_dunning'] : SKIP
+      price_point_id = hash.key?('price_point_id') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:CreateAllocationPricePointId), hash['price_point_id']
+      ) : SKIP
+      billing_schedule = BillingSchedule.from_hash(hash['billing_schedule']) if
+        hash['billing_schedule']
+
+      # Create object from extracted values.
+      CreateAllocation.new(quantity,
+                           component_id,
+                           memo,
+                           proration_downgrade_scheme,
+                           proration_upgrade_scheme,
+                           accrue_charge,
+                           downgrade_credit,
+                           upgrade_charge,
+                           initiate_dunning,
+                           price_point_id,
+                           billing_schedule)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [CreateAllocation | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.quantity,
+                                     ->(val) { val.instance_of? Float })
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['quantity'],
+                            ->(val) { val.instance_of? Float })
+    end
+  end
+end

data/lib/advanced_billing/models/create_allocation_request.rb

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