maxio-advanced-billing-sdk 0.0.3 → 0.0.4

data/lib/advanced_billing/models/create_or_update_flat_amount_coupon.rb

@@ -0,0 +1,228 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module AdvancedBilling
+  # CreateOrUpdateFlatAmountCoupon Model.
+  class CreateOrUpdateFlatAmountCoupon < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # the name of the coupon
+    # @return [String]
+    attr_accessor :name
+
+    # may contain uppercase alphanumeric characters and these special characters
+    # (which allow for email addresses to be used): “%”, “@”, “+”, “-”, “_”, and
+    # “.”
+    # @return [String]
+    attr_accessor :code
+
+    # may contain uppercase alphanumeric characters and these special characters
+    # (which allow for email addresses to be used): “%”, “@”, “+”, “-”, “_”, and
+    # “.”
+    # @return [String]
+    attr_accessor :description
+
+    # may contain uppercase alphanumeric characters and these special characters
+    # (which allow for email addresses to be used): “%”, “@”, “+”, “-”, “_”, and
+    # “.”
+    # @return [Integer]
+    attr_accessor :amount_in_cents
+
+    # may contain uppercase alphanumeric characters and these special characters
+    # (which allow for email addresses to be used): “%”, “@”, “+”, “-”, “_”, and
+    # “.”
+    # @return [TrueClass | FalseClass]
+    attr_accessor :allow_negative_balance
+
+    # may contain uppercase alphanumeric characters and these special characters
+    # (which allow for email addresses to be used): “%”, “@”, “+”, “-”, “_”, and
+    # “.”
+    # @return [TrueClass | FalseClass]
+    attr_accessor :recurring
+
+    # may contain uppercase alphanumeric characters and these special characters
+    # (which allow for email addresses to be used): “%”, “@”, “+”, “-”, “_”, and
+    # “.”
+    # @return [DateTime]
+    attr_accessor :end_date
+
+    # may contain uppercase alphanumeric characters and these special characters
+    # (which allow for email addresses to be used): “%”, “@”, “+”, “-”, “_”, and
+    # “.”
+    # @return [String]
+    attr_accessor :product_family_id
+
+    # may contain uppercase alphanumeric characters and these special characters
+    # (which allow for email addresses to be used): “%”, “@”, “+”, “-”, “_”, and
+    # “.”
+    # @return [TrueClass | FalseClass]
+    attr_accessor :stackable
+
+    # may contain uppercase alphanumeric characters and these special characters
+    # (which allow for email addresses to be used): “%”, “@”, “+”, “-”, “_”, and
+    # “.”
+    # @return [CompoundingStrategy]
+    attr_accessor :compounding_strategy
+
+    # may contain uppercase alphanumeric characters and these special characters
+    # (which allow for email addresses to be used): “%”, “@”, “+”, “-”, “_”, and
+    # “.”
+    # @return [TrueClass | FalseClass]
+    attr_accessor :exclude_mid_period_allocations
+
+    # may contain uppercase alphanumeric characters and these special characters
+    # (which allow for email addresses to be used): “%”, “@”, “+”, “-”, “_”, and
+    # “.”
+    # @return [TrueClass | FalseClass]
+    attr_accessor :apply_on_cancel_at_end_of_period
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['code'] = 'code'
+      @_hash['description'] = 'description'
+      @_hash['amount_in_cents'] = 'amount_in_cents'
+      @_hash['allow_negative_balance'] = 'allow_negative_balance'
+      @_hash['recurring'] = 'recurring'
+      @_hash['end_date'] = 'end_date'
+      @_hash['product_family_id'] = 'product_family_id'
+      @_hash['stackable'] = 'stackable'
+      @_hash['compounding_strategy'] = 'compounding_strategy'
+      @_hash['exclude_mid_period_allocations'] =
+        'exclude_mid_period_allocations'
+      @_hash['apply_on_cancel_at_end_of_period'] =
+        'apply_on_cancel_at_end_of_period'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        description
+        allow_negative_balance
+        recurring
+        end_date
+        product_family_id
+        stackable
+        compounding_strategy
+        exclude_mid_period_allocations
+        apply_on_cancel_at_end_of_period
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name = nil,
+                   code = nil,
+                   amount_in_cents = nil,
+                   description = SKIP,
+                   allow_negative_balance = SKIP,
+                   recurring = SKIP,
+                   end_date = SKIP,
+                   product_family_id = SKIP,
+                   stackable = SKIP,
+                   compounding_strategy = SKIP,
+                   exclude_mid_period_allocations = SKIP,
+                   apply_on_cancel_at_end_of_period = SKIP)
+      @name = name
+      @code = code
+      @description = description unless description == SKIP
+      @amount_in_cents = amount_in_cents
+      @allow_negative_balance = allow_negative_balance unless allow_negative_balance == SKIP
+      @recurring = recurring unless recurring == SKIP
+      @end_date = end_date unless end_date == SKIP
+      @product_family_id = product_family_id unless product_family_id == SKIP
+      @stackable = stackable unless stackable == SKIP
+      @compounding_strategy = compounding_strategy unless compounding_strategy == SKIP
+      unless exclude_mid_period_allocations == SKIP
+        @exclude_mid_period_allocations =
+          exclude_mid_period_allocations
+      end
+      unless apply_on_cancel_at_end_of_period == SKIP
+        @apply_on_cancel_at_end_of_period =
+          apply_on_cancel_at_end_of_period
+      end
+    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
+      code = hash.key?('code') ? hash['code'] : nil
+      amount_in_cents =
+        hash.key?('amount_in_cents') ? hash['amount_in_cents'] : nil
+      description = hash.key?('description') ? hash['description'] : SKIP
+      allow_negative_balance =
+        hash.key?('allow_negative_balance') ? hash['allow_negative_balance'] : SKIP
+      recurring = hash.key?('recurring') ? hash['recurring'] : SKIP
+      end_date = if hash.key?('end_date')
+                   (DateTimeHelper.from_rfc3339(hash['end_date']) if hash['end_date'])
+                 else
+                   SKIP
+                 end
+      product_family_id =
+        hash.key?('product_family_id') ? hash['product_family_id'] : SKIP
+      stackable = hash.key?('stackable') ? hash['stackable'] : SKIP
+      compounding_strategy =
+        hash.key?('compounding_strategy') ? hash['compounding_strategy'] : SKIP
+      exclude_mid_period_allocations =
+        hash.key?('exclude_mid_period_allocations') ? hash['exclude_mid_period_allocations'] : SKIP
+      apply_on_cancel_at_end_of_period =
+        hash.key?('apply_on_cancel_at_end_of_period') ? hash['apply_on_cancel_at_end_of_period'] : SKIP
+
+      # Create object from extracted values.
+      CreateOrUpdateFlatAmountCoupon.new(name,
+                                         code,
+                                         amount_in_cents,
+                                         description,
+                                         allow_negative_balance,
+                                         recurring,
+                                         end_date,
+                                         product_family_id,
+                                         stackable,
+                                         compounding_strategy,
+                                         exclude_mid_period_allocations,
+                                         apply_on_cancel_at_end_of_period)
+    end
+
+    def to_custom_end_date
+      DateTimeHelper.to_rfc3339(end_date)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [CreateOrUpdateFlatAmountCoupon | 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.code,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.amount_in_cents,
+                                  ->(val) { val.instance_of? Integer })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['name'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['code'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['amount_in_cents'],
+                                ->(val) { val.instance_of? Integer })
+      )
+    end
+  end
+end

data/lib/advanced_billing/models/create_or_update_percentage_coupon.rb

@@ -0,0 +1,229 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module AdvancedBilling
+  # CreateOrUpdatePercentageCoupon Model.
+  class CreateOrUpdatePercentageCoupon < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # the name of the coupon
+    # @return [String]
+    attr_accessor :name
+
+    # may contain uppercase alphanumeric characters and these special characters
+    # (which allow for email addresses to be used): “%”, “@”, “+”, “-”, “_”, and
+    # “.”
+    # @return [String]
+    attr_accessor :code
+
+    # may contain uppercase alphanumeric characters and these special characters
+    # (which allow for email addresses to be used): “%”, “@”, “+”, “-”, “_”, and
+    # “.”
+    # @return [String]
+    attr_accessor :description
+
+    # may contain uppercase alphanumeric characters and these special characters
+    # (which allow for email addresses to be used): “%”, “@”, “+”, “-”, “_”, and
+    # “.”
+    # @return [Object]
+    attr_accessor :percentage
+
+    # may contain uppercase alphanumeric characters and these special characters
+    # (which allow for email addresses to be used): “%”, “@”, “+”, “-”, “_”, and
+    # “.”
+    # @return [TrueClass | FalseClass]
+    attr_accessor :allow_negative_balance
+
+    # may contain uppercase alphanumeric characters and these special characters
+    # (which allow for email addresses to be used): “%”, “@”, “+”, “-”, “_”, and
+    # “.”
+    # @return [TrueClass | FalseClass]
+    attr_accessor :recurring
+
+    # may contain uppercase alphanumeric characters and these special characters
+    # (which allow for email addresses to be used): “%”, “@”, “+”, “-”, “_”, and
+    # “.”
+    # @return [DateTime]
+    attr_accessor :end_date
+
+    # may contain uppercase alphanumeric characters and these special characters
+    # (which allow for email addresses to be used): “%”, “@”, “+”, “-”, “_”, and
+    # “.”
+    # @return [String]
+    attr_accessor :product_family_id
+
+    # may contain uppercase alphanumeric characters and these special characters
+    # (which allow for email addresses to be used): “%”, “@”, “+”, “-”, “_”, and
+    # “.”
+    # @return [TrueClass | FalseClass]
+    attr_accessor :stackable
+
+    # may contain uppercase alphanumeric characters and these special characters
+    # (which allow for email addresses to be used): “%”, “@”, “+”, “-”, “_”, and
+    # “.”
+    # @return [CompoundingStrategy]
+    attr_accessor :compounding_strategy
+
+    # may contain uppercase alphanumeric characters and these special characters
+    # (which allow for email addresses to be used): “%”, “@”, “+”, “-”, “_”, and
+    # “.”
+    # @return [TrueClass | FalseClass]
+    attr_accessor :exclude_mid_period_allocations
+
+    # may contain uppercase alphanumeric characters and these special characters
+    # (which allow for email addresses to be used): “%”, “@”, “+”, “-”, “_”, and
+    # “.”
+    # @return [TrueClass | FalseClass]
+    attr_accessor :apply_on_cancel_at_end_of_period
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['code'] = 'code'
+      @_hash['description'] = 'description'
+      @_hash['percentage'] = 'percentage'
+      @_hash['allow_negative_balance'] = 'allow_negative_balance'
+      @_hash['recurring'] = 'recurring'
+      @_hash['end_date'] = 'end_date'
+      @_hash['product_family_id'] = 'product_family_id'
+      @_hash['stackable'] = 'stackable'
+      @_hash['compounding_strategy'] = 'compounding_strategy'
+      @_hash['exclude_mid_period_allocations'] =
+        'exclude_mid_period_allocations'
+      @_hash['apply_on_cancel_at_end_of_period'] =
+        'apply_on_cancel_at_end_of_period'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        description
+        allow_negative_balance
+        recurring
+        end_date
+        product_family_id
+        stackable
+        compounding_strategy
+        exclude_mid_period_allocations
+        apply_on_cancel_at_end_of_period
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name = nil,
+                   code = nil,
+                   percentage = nil,
+                   description = SKIP,
+                   allow_negative_balance = SKIP,
+                   recurring = SKIP,
+                   end_date = SKIP,
+                   product_family_id = SKIP,
+                   stackable = SKIP,
+                   compounding_strategy = SKIP,
+                   exclude_mid_period_allocations = SKIP,
+                   apply_on_cancel_at_end_of_period = SKIP)
+      @name = name
+      @code = code
+      @description = description unless description == SKIP
+      @percentage = percentage
+      @allow_negative_balance = allow_negative_balance unless allow_negative_balance == SKIP
+      @recurring = recurring unless recurring == SKIP
+      @end_date = end_date unless end_date == SKIP
+      @product_family_id = product_family_id unless product_family_id == SKIP
+      @stackable = stackable unless stackable == SKIP
+      @compounding_strategy = compounding_strategy unless compounding_strategy == SKIP
+      unless exclude_mid_period_allocations == SKIP
+        @exclude_mid_period_allocations =
+          exclude_mid_period_allocations
+      end
+      unless apply_on_cancel_at_end_of_period == SKIP
+        @apply_on_cancel_at_end_of_period =
+          apply_on_cancel_at_end_of_period
+      end
+    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
+      code = hash.key?('code') ? hash['code'] : nil
+      percentage = hash.key?('percentage') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:CreateOrUpdatePercentageCouponPercentage), hash['percentage']
+      ) : nil
+      description = hash.key?('description') ? hash['description'] : SKIP
+      allow_negative_balance =
+        hash.key?('allow_negative_balance') ? hash['allow_negative_balance'] : SKIP
+      recurring = hash.key?('recurring') ? hash['recurring'] : SKIP
+      end_date = if hash.key?('end_date')
+                   (DateTimeHelper.from_rfc3339(hash['end_date']) if hash['end_date'])
+                 else
+                   SKIP
+                 end
+      product_family_id =
+        hash.key?('product_family_id') ? hash['product_family_id'] : SKIP
+      stackable = hash.key?('stackable') ? hash['stackable'] : SKIP
+      compounding_strategy =
+        hash.key?('compounding_strategy') ? hash['compounding_strategy'] : SKIP
+      exclude_mid_period_allocations =
+        hash.key?('exclude_mid_period_allocations') ? hash['exclude_mid_period_allocations'] : SKIP
+      apply_on_cancel_at_end_of_period =
+        hash.key?('apply_on_cancel_at_end_of_period') ? hash['apply_on_cancel_at_end_of_period'] : SKIP
+
+      # Create object from extracted values.
+      CreateOrUpdatePercentageCoupon.new(name,
+                                         code,
+                                         percentage,
+                                         description,
+                                         allow_negative_balance,
+                                         recurring,
+                                         end_date,
+                                         product_family_id,
+                                         stackable,
+                                         compounding_strategy,
+                                         exclude_mid_period_allocations,
+                                         apply_on_cancel_at_end_of_period)
+    end
+
+    def to_custom_end_date
+      DateTimeHelper.to_rfc3339(end_date)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [CreateOrUpdatePercentageCoupon | 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.code,
+                                  ->(val) { val.instance_of? String }) and
+            UnionTypeLookUp.get(:CreateOrUpdatePercentageCouponPercentage)
+                           .validate(value.percentage)
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['name'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['code'],
+                                ->(val) { val.instance_of? String }) and
+          UnionTypeLookUp.get(:CreateOrUpdatePercentageCouponPercentage)
+                         .validate(value['percentage'])
+      )
+    end
+  end
+end

data/lib/advanced_billing/models/create_or_update_product.rb

@@ -0,0 +1,146 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # CreateOrUpdateProduct Model.
+  class CreateOrUpdateProduct < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The product name
+    # @return [String]
+    attr_accessor :name
+
+    # The product API handle
+    # @return [String]
+    attr_accessor :handle
+
+    # The product description
+    # @return [String]
+    attr_accessor :description
+
+    # E.g. Internal ID or SKU Number
+    # @return [String]
+    attr_accessor :accounting_code
+
+    # Deprecated value that can be ignored unless you have legacy hosted pages.
+    # For Public Signup Page users, please read this attribute from under the
+    # signup page.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :require_credit_card
+
+    # The product 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 would renew every 30 days
+    # @return [Integer]
+    attr_accessor :interval
+
+    # A string representing the interval unit for this product, either month or
+    # day
+    # @return [IntervalUnit]
+    attr_accessor :interval_unit
+
+    # A string representing the interval unit for this product, either month or
+    # day
+    # @return [TrueClass | FalseClass]
+    attr_accessor :auto_create_signup_page
+
+    # A string representing the tax code related to the product type. This is
+    # especially important when using the Avalara service to tax based on
+    # locale. This attribute has a max length of 10 characters.
+    # @return [String]
+    attr_accessor :tax_code
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['handle'] = 'handle'
+      @_hash['description'] = 'description'
+      @_hash['accounting_code'] = 'accounting_code'
+      @_hash['require_credit_card'] = 'require_credit_card'
+      @_hash['price_in_cents'] = 'price_in_cents'
+      @_hash['interval'] = 'interval'
+      @_hash['interval_unit'] = 'interval_unit'
+      @_hash['auto_create_signup_page'] = 'auto_create_signup_page'
+      @_hash['tax_code'] = 'tax_code'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        handle
+        accounting_code
+        require_credit_card
+        auto_create_signup_page
+        tax_code
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name = nil,
+                   description = nil,
+                   price_in_cents = nil,
+                   interval = nil,
+                   interval_unit = nil,
+                   handle = SKIP,
+                   accounting_code = SKIP,
+                   require_credit_card = SKIP,
+                   auto_create_signup_page = SKIP,
+                   tax_code = SKIP)
+      @name = name
+      @handle = handle unless handle == SKIP
+      @description = description
+      @accounting_code = accounting_code unless accounting_code == SKIP
+      @require_credit_card = require_credit_card unless require_credit_card == SKIP
+      @price_in_cents = price_in_cents
+      @interval = interval
+      @interval_unit = interval_unit
+      @auto_create_signup_page = auto_create_signup_page unless auto_create_signup_page == SKIP
+      @tax_code = tax_code unless tax_code == 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
+      description = hash.key?('description') ? hash['description'] : 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
+      accounting_code =
+        hash.key?('accounting_code') ? hash['accounting_code'] : SKIP
+      require_credit_card =
+        hash.key?('require_credit_card') ? hash['require_credit_card'] : SKIP
+      auto_create_signup_page =
+        hash.key?('auto_create_signup_page') ? hash['auto_create_signup_page'] : SKIP
+      tax_code = hash.key?('tax_code') ? hash['tax_code'] : SKIP
+
+      # Create object from extracted values.
+      CreateOrUpdateProduct.new(name,
+                                description,
+                                price_in_cents,
+                                interval,
+                                interval_unit,
+                                handle,
+                                accounting_code,
+                                require_credit_card,
+                                auto_create_signup_page,
+                                tax_code)
+    end
+  end
+end

data/lib/advanced_billing/models/create_or_update_product_request.rb

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