maxio-advanced-billing-sdk 0.0.3 → 0.0.4

data/lib/advanced_billing/models/net_terms.rb

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

data/lib/advanced_billing/models/offer.rb

@@ -0,0 +1,266 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Offer Model.
+  class Offer < 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 [Integer]
+    attr_accessor :site_id
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :product_family_id
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :product_id
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :product_price_point_id
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :product_revisable_number
+
+    # 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 :description
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :created_at
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :updated_at
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :archived_at
+
+    # TODO: Write general description for this method
+    # @return [Array[OfferItem]]
+    attr_accessor :offer_items
+
+    # TODO: Write general description for this method
+    # @return [Array[OfferDiscount]]
+    attr_accessor :offer_discounts
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :product_family_name
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :product_name
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :product_price_point_name
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :product_price_in_cents
+
+    # TODO: Write general description for this method
+    # @return [Array[OfferSignupPage]]
+    attr_accessor :offer_signup_pages
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['site_id'] = 'site_id'
+      @_hash['product_family_id'] = 'product_family_id'
+      @_hash['product_id'] = 'product_id'
+      @_hash['product_price_point_id'] = 'product_price_point_id'
+      @_hash['product_revisable_number'] = 'product_revisable_number'
+      @_hash['name'] = 'name'
+      @_hash['handle'] = 'handle'
+      @_hash['description'] = 'description'
+      @_hash['created_at'] = 'created_at'
+      @_hash['updated_at'] = 'updated_at'
+      @_hash['archived_at'] = 'archived_at'
+      @_hash['offer_items'] = 'offer_items'
+      @_hash['offer_discounts'] = 'offer_discounts'
+      @_hash['product_family_name'] = 'product_family_name'
+      @_hash['product_name'] = 'product_name'
+      @_hash['product_price_point_name'] = 'product_price_point_name'
+      @_hash['product_price_in_cents'] = 'product_price_in_cents'
+      @_hash['offer_signup_pages'] = 'offer_signup_pages'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        site_id
+        product_family_id
+        product_id
+        product_price_point_id
+        product_revisable_number
+        name
+        handle
+        description
+        created_at
+        updated_at
+        archived_at
+        offer_items
+        offer_discounts
+        product_family_name
+        product_name
+        product_price_point_name
+        product_price_in_cents
+        offer_signup_pages
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        description
+        archived_at
+      ]
+    end
+
+    def initialize(id = SKIP,
+                   site_id = SKIP,
+                   product_family_id = SKIP,
+                   product_id = SKIP,
+                   product_price_point_id = SKIP,
+                   product_revisable_number = SKIP,
+                   name = SKIP,
+                   handle = SKIP,
+                   description = SKIP,
+                   created_at = SKIP,
+                   updated_at = SKIP,
+                   archived_at = SKIP,
+                   offer_items = SKIP,
+                   offer_discounts = SKIP,
+                   product_family_name = SKIP,
+                   product_name = SKIP,
+                   product_price_point_name = SKIP,
+                   product_price_in_cents = SKIP,
+                   offer_signup_pages = SKIP)
+      @id = id unless id == SKIP
+      @site_id = site_id unless site_id == SKIP
+      @product_family_id = product_family_id unless product_family_id == SKIP
+      @product_id = product_id unless product_id == SKIP
+      @product_price_point_id = product_price_point_id unless product_price_point_id == SKIP
+      @product_revisable_number = product_revisable_number unless product_revisable_number == SKIP
+      @name = name unless name == SKIP
+      @handle = handle unless handle == SKIP
+      @description = description unless description == SKIP
+      @created_at = created_at unless created_at == SKIP
+      @updated_at = updated_at unless updated_at == SKIP
+      @archived_at = archived_at unless archived_at == SKIP
+      @offer_items = offer_items unless offer_items == SKIP
+      @offer_discounts = offer_discounts unless offer_discounts == SKIP
+      @product_family_name = product_family_name unless product_family_name == SKIP
+      @product_name = product_name unless product_name == SKIP
+      @product_price_point_name = product_price_point_name unless product_price_point_name == SKIP
+      @product_price_in_cents = product_price_in_cents unless product_price_in_cents == SKIP
+      @offer_signup_pages = offer_signup_pages unless offer_signup_pages == 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
+      site_id = hash.key?('site_id') ? hash['site_id'] : SKIP
+      product_family_id =
+        hash.key?('product_family_id') ? hash['product_family_id'] : SKIP
+      product_id = hash.key?('product_id') ? hash['product_id'] : SKIP
+      product_price_point_id =
+        hash.key?('product_price_point_id') ? hash['product_price_point_id'] : SKIP
+      product_revisable_number =
+        hash.key?('product_revisable_number') ? hash['product_revisable_number'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+      handle = hash.key?('handle') ? hash['handle'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+      created_at = hash.key?('created_at') ? hash['created_at'] : SKIP
+      updated_at = hash.key?('updated_at') ? hash['updated_at'] : SKIP
+      archived_at = hash.key?('archived_at') ? hash['archived_at'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      offer_items = nil
+      unless hash['offer_items'].nil?
+        offer_items = []
+        hash['offer_items'].each do |structure|
+          offer_items << (OfferItem.from_hash(structure) if structure)
+        end
+      end
+
+      offer_items = SKIP unless hash.key?('offer_items')
+      # Parameter is an array, so we need to iterate through it
+      offer_discounts = nil
+      unless hash['offer_discounts'].nil?
+        offer_discounts = []
+        hash['offer_discounts'].each do |structure|
+          offer_discounts << (OfferDiscount.from_hash(structure) if structure)
+        end
+      end
+
+      offer_discounts = SKIP unless hash.key?('offer_discounts')
+      product_family_name =
+        hash.key?('product_family_name') ? hash['product_family_name'] : SKIP
+      product_name = hash.key?('product_name') ? hash['product_name'] : SKIP
+      product_price_point_name =
+        hash.key?('product_price_point_name') ? hash['product_price_point_name'] : SKIP
+      product_price_in_cents =
+        hash.key?('product_price_in_cents') ? hash['product_price_in_cents'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      offer_signup_pages = nil
+      unless hash['offer_signup_pages'].nil?
+        offer_signup_pages = []
+        hash['offer_signup_pages'].each do |structure|
+          offer_signup_pages << (OfferSignupPage.from_hash(structure) if structure)
+        end
+      end
+
+      offer_signup_pages = SKIP unless hash.key?('offer_signup_pages')
+
+      # Create object from extracted values.
+      Offer.new(id,
+                site_id,
+                product_family_id,
+                product_id,
+                product_price_point_id,
+                product_revisable_number,
+                name,
+                handle,
+                description,
+                created_at,
+                updated_at,
+                archived_at,
+                offer_items,
+                offer_discounts,
+                product_family_name,
+                product_name,
+                product_price_point_name,
+                product_price_in_cents,
+                offer_signup_pages)
+    end
+  end
+end

data/lib/advanced_billing/models/offer_discount.rb

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

data/lib/advanced_billing/models/offer_item.rb

@@ -0,0 +1,159 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # OfferItem Model.
+  class OfferItem < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :component_id
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :price_point_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :starting_quantity
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :editable
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :component_unit_price
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :component_name
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :price_point_name
+
+    # TODO: Write general description for this method
+    # @return [Array[CurrencyPrice]]
+    attr_accessor :currency_prices
+
+    # The numerical interval. i.e. an interval of '30' coupled with an
+    # interval_unit of day would mean this component price point would renew
+    # every 30 days. This property is only available for sites with
+    # Multifrequency enabled.
+    # @return [Integer]
+    attr_accessor :interval
+
+    # A string representing the interval unit for this component price point,
+    # either month or day. This property is only available for sites with
+    # Multifrequency enabled.
+    # @return [IntervalUnit]
+    attr_accessor :interval_unit
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['component_id'] = 'component_id'
+      @_hash['price_point_id'] = 'price_point_id'
+      @_hash['starting_quantity'] = 'starting_quantity'
+      @_hash['editable'] = 'editable'
+      @_hash['component_unit_price'] = 'component_unit_price'
+      @_hash['component_name'] = 'component_name'
+      @_hash['price_point_name'] = 'price_point_name'
+      @_hash['currency_prices'] = 'currency_prices'
+      @_hash['interval'] = 'interval'
+      @_hash['interval_unit'] = 'interval_unit'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        component_id
+        price_point_id
+        starting_quantity
+        editable
+        component_unit_price
+        component_name
+        price_point_name
+        currency_prices
+        interval
+        interval_unit
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(component_id = SKIP,
+                   price_point_id = SKIP,
+                   starting_quantity = SKIP,
+                   editable = SKIP,
+                   component_unit_price = SKIP,
+                   component_name = SKIP,
+                   price_point_name = SKIP,
+                   currency_prices = SKIP,
+                   interval = SKIP,
+                   interval_unit = SKIP)
+      @component_id = component_id unless component_id == SKIP
+      @price_point_id = price_point_id unless price_point_id == SKIP
+      @starting_quantity = starting_quantity unless starting_quantity == SKIP
+      @editable = editable unless editable == SKIP
+      @component_unit_price = component_unit_price unless component_unit_price == SKIP
+      @component_name = component_name unless component_name == SKIP
+      @price_point_name = price_point_name unless price_point_name == SKIP
+      @currency_prices = currency_prices unless currency_prices == SKIP
+      @interval = interval unless interval == SKIP
+      @interval_unit = interval_unit unless interval_unit == 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.
+      component_id = hash.key?('component_id') ? hash['component_id'] : SKIP
+      price_point_id =
+        hash.key?('price_point_id') ? hash['price_point_id'] : SKIP
+      starting_quantity =
+        hash.key?('starting_quantity') ? hash['starting_quantity'] : SKIP
+      editable = hash.key?('editable') ? hash['editable'] : SKIP
+      component_unit_price =
+        hash.key?('component_unit_price') ? hash['component_unit_price'] : SKIP
+      component_name =
+        hash.key?('component_name') ? hash['component_name'] : SKIP
+      price_point_name =
+        hash.key?('price_point_name') ? hash['price_point_name'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      currency_prices = nil
+      unless hash['currency_prices'].nil?
+        currency_prices = []
+        hash['currency_prices'].each do |structure|
+          currency_prices << (CurrencyPrice.from_hash(structure) if structure)
+        end
+      end
+
+      currency_prices = SKIP unless hash.key?('currency_prices')
+      interval = hash.key?('interval') ? hash['interval'] : SKIP
+      interval_unit = hash.key?('interval_unit') ? hash['interval_unit'] : SKIP
+
+      # Create object from extracted values.
+      OfferItem.new(component_id,
+                    price_point_id,
+                    starting_quantity,
+                    editable,
+                    component_unit_price,
+                    component_name,
+                    price_point_name,
+                    currency_prices,
+                    interval,
+                    interval_unit)
+    end
+  end
+end

data/lib/advanced_billing/models/offer_response.rb

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