subtain-apimatic-sdk 4.1.1 → 9.1.1

data/lib/advanced_billing/models/coupon_subcodes_response.rb

@@ -0,0 +1,70 @@
+# 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,114 @@
+# 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,162 @@
+# 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 if the change in cost is a downgrade.
+    # Defaults to the component and then site setting if one is not provided.
+    # @return [CreditType1]
+    attr_accessor :downgrade_credit
+
+    # The type of charge to be created if the change in cost is an upgrade.
+    # Defaults to the component and then site setting if one is not provided.
+    # @return [CreditType1]
+    attr_accessor :upgrade_charge
+
+    # 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
+
+    # 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['price_point_id'] = 'price_point_id'
+      @_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
+        price_point_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        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,
+                   price_point_id = 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
+      @price_point_id = price_point_id unless price_point_id == 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
+      price_point_id = hash.key?('price_point_id') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:CreateAllocationPricePointId), hash['price_point_id']
+      ) : SKIP
+
+      # Create object from extracted values.
+      CreateAllocation.new(quantity,
+                           component_id,
+                           memo,
+                           proration_downgrade_scheme,
+                           proration_upgrade_scheme,
+                           accrue_charge,
+                           downgrade_credit,
+                           upgrade_charge,
+                           price_point_id)
+    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

data/lib/advanced_billing/models/create_component_price_point.rb

@@ -0,0 +1,125 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # CreateComponentPricePoint Model.
+  class CreateComponentPricePoint < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :name
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :handle
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :pricing_scheme
+
+    # TODO: Write general description for this method
+    # @return [Array[Price]]
+    attr_accessor :prices
+
+    # Whether to use the site level exchange rate or define your own prices for
+    # each currency if you have multiple currencies defined on the site.
+    # @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['pricing_scheme'] = 'pricing_scheme'
+      @_hash['prices'] = 'prices'
+      @_hash['use_site_exchange_rate'] = 'use_site_exchange_rate'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        handle
+        use_site_exchange_rate
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name = nil, pricing_scheme = nil, prices = nil,
+                   handle = SKIP, use_site_exchange_rate = true)
+      @name = name
+      @handle = handle unless handle == SKIP
+      @pricing_scheme = pricing_scheme
+      @prices = prices
+      @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
+      pricing_scheme =
+        hash.key?('pricing_scheme') ? hash['pricing_scheme'] : nil
+      # Parameter is an array, so we need to iterate through it
+      prices = nil
+      unless hash['prices'].nil?
+        prices = []
+        hash['prices'].each do |structure|
+          prices << (Price.from_hash(structure) if structure)
+        end
+      end
+
+      prices = nil unless hash.key?('prices')
+      handle = hash.key?('handle') ? hash['handle'] : SKIP
+      use_site_exchange_rate = hash['use_site_exchange_rate'] ||= true
+
+      # Create object from extracted values.
+      CreateComponentPricePoint.new(name,
+                                    pricing_scheme,
+                                    prices,
+                                    handle,
+                                    use_site_exchange_rate)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [CreateComponentPricePoint | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.name,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.pricing_scheme,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.prices,
+                                  ->(val) { Price.validate(val) },
+                                  is_model_hash: true,
+                                  is_inner_model_hash: true)
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['name'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['pricing_scheme'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['prices'],
+                                ->(val) { Price.validate(val) },
+                                is_model_hash: true,
+                                is_inner_model_hash: true)
+      )
+    end
+  end
+end

data/lib/advanced_billing/models/create_component_price_point_request.rb

@@ -0,0 +1,64 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # CreateComponentPricePointRequest Model.
+  class CreateComponentPricePointRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [PricePoint]
+    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 = hash.key?('price_point') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:CreateComponentPricePointRequestPricePoint), hash['price_point']
+      ) : nil
+
+      # Create object from extracted values.
+      CreateComponentPricePointRequest.new(price_point)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [CreateComponentPricePointRequest | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return UnionTypeLookUp.get(:CreateComponentPricePointRequestPricePoint)
+                              .validate(value.price_point)
+      end
+
+      return false unless value.instance_of? Hash
+
+      UnionTypeLookUp.get(:CreateComponentPricePointRequestPricePoint)
+                     .validate(value['price_point'])
+    end
+  end
+end

data/lib/advanced_billing/models/create_component_price_points_request.rb

@@ -0,0 +1,64 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # CreateComponentPricePointsRequest Model.
+  class CreateComponentPricePointsRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[PricePoint]]
+    attr_accessor :price_points
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['price_points'] = 'price_points'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(price_points = nil)
+      @price_points = price_points
+    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_points = hash.key?('price_points') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:CreateComponentPricePointsRequestPricePoints), hash['price_points']
+      ) : nil
+
+      # Create object from extracted values.
+      CreateComponentPricePointsRequest.new(price_points)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [CreateComponentPricePointsRequest | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return UnionTypeLookUp.get(:CreateComponentPricePointsRequestPricePoints)
+                              .validate(value.price_points)
+      end
+
+      return false unless value.instance_of? Hash
+
+      UnionTypeLookUp.get(:CreateComponentPricePointsRequestPricePoints)
+                     .validate(value['price_points'])
+    end
+  end
+end