subtain-apimatic-sdk 4.1.1 → 9.1.1

data/lib/advanced_billing/models/coupon.rb

@@ -0,0 +1,367 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Coupon Model.
+  class Coupon < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Float]
+    attr_accessor :id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :name
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :code
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :description
+
+    # TODO: Write general description for this method
+    # @return [Float]
+    attr_accessor :amount
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :amount_in_cents
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :product_family_id
+
+    # 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 :start_date
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :end_date
+
+    # TODO: Write general description for this method
+    # @return [Float]
+    attr_accessor :percentage
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :recurring
+
+    # TODO: Write general description for this method
+    # @return [RecurringScheme]
+    attr_accessor :recurring_scheme
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :duration_period_count
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :duration_interval
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :duration_interval_unit
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :duration_interval_span
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :allow_negative_balance
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :archived_at
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :conversion_limit
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :stackable
+
+    # TODO: Write general description for this method
+    # @return [Object]
+    attr_accessor :compounding_strategy
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :use_site_exchange_rate
+
+    # 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 [DiscountType]
+    attr_accessor :discount_type
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :exclude_mid_period_allocations
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :apply_on_cancel_at_end_of_period
+
+    # TODO: Write general description for this method
+    # @return [Array[CouponRestriction]]
+    attr_accessor :coupon_restrictions
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['name'] = 'name'
+      @_hash['code'] = 'code'
+      @_hash['description'] = 'description'
+      @_hash['amount'] = 'amount'
+      @_hash['amount_in_cents'] = 'amount_in_cents'
+      @_hash['product_family_id'] = 'product_family_id'
+      @_hash['product_family_name'] = 'product_family_name'
+      @_hash['start_date'] = 'start_date'
+      @_hash['end_date'] = 'end_date'
+      @_hash['percentage'] = 'percentage'
+      @_hash['recurring'] = 'recurring'
+      @_hash['recurring_scheme'] = 'recurring_scheme'
+      @_hash['duration_period_count'] = 'duration_period_count'
+      @_hash['duration_interval'] = 'duration_interval'
+      @_hash['duration_interval_unit'] = 'duration_interval_unit'
+      @_hash['duration_interval_span'] = 'duration_interval_span'
+      @_hash['allow_negative_balance'] = 'allow_negative_balance'
+      @_hash['archived_at'] = 'archived_at'
+      @_hash['conversion_limit'] = 'conversion_limit'
+      @_hash['stackable'] = 'stackable'
+      @_hash['compounding_strategy'] = 'compounding_strategy'
+      @_hash['use_site_exchange_rate'] = 'use_site_exchange_rate'
+      @_hash['created_at'] = 'created_at'
+      @_hash['updated_at'] = 'updated_at'
+      @_hash['discount_type'] = 'discount_type'
+      @_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['coupon_restrictions'] = 'coupon_restrictions'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        name
+        code
+        description
+        amount
+        amount_in_cents
+        product_family_id
+        product_family_name
+        start_date
+        end_date
+        percentage
+        recurring
+        recurring_scheme
+        duration_period_count
+        duration_interval
+        duration_interval_unit
+        duration_interval_span
+        allow_negative_balance
+        archived_at
+        conversion_limit
+        stackable
+        compounding_strategy
+        use_site_exchange_rate
+        created_at
+        updated_at
+        discount_type
+        exclude_mid_period_allocations
+        apply_on_cancel_at_end_of_period
+        coupon_restrictions
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        amount
+        amount_in_cents
+        end_date
+        percentage
+        duration_period_count
+        duration_interval
+        duration_interval_unit
+        archived_at
+        conversion_limit
+      ]
+    end
+
+    def initialize(id = SKIP, name = SKIP, code = SKIP, description = SKIP,
+                   amount = SKIP, amount_in_cents = SKIP,
+                   product_family_id = SKIP, product_family_name = SKIP,
+                   start_date = SKIP, end_date = SKIP, percentage = SKIP,
+                   recurring = SKIP, recurring_scheme = SKIP,
+                   duration_period_count = SKIP, duration_interval = SKIP,
+                   duration_interval_unit = SKIP, duration_interval_span = SKIP,
+                   allow_negative_balance = SKIP, archived_at = SKIP,
+                   conversion_limit = SKIP, stackable = SKIP,
+                   compounding_strategy = SKIP, use_site_exchange_rate = SKIP,
+                   created_at = SKIP, updated_at = SKIP, discount_type = SKIP,
+                   exclude_mid_period_allocations = SKIP,
+                   apply_on_cancel_at_end_of_period = SKIP,
+                   coupon_restrictions = SKIP)
+      @id = id unless id == SKIP
+      @name = name unless name == SKIP
+      @code = code unless code == SKIP
+      @description = description unless description == SKIP
+      @amount = amount unless amount == SKIP
+      @amount_in_cents = amount_in_cents unless amount_in_cents == SKIP
+      @product_family_id = product_family_id unless product_family_id == SKIP
+      @product_family_name = product_family_name unless product_family_name == SKIP
+      @start_date = start_date unless start_date == SKIP
+      @end_date = end_date unless end_date == SKIP
+      @percentage = percentage unless percentage == SKIP
+      @recurring = recurring unless recurring == SKIP
+      @recurring_scheme = recurring_scheme unless recurring_scheme == SKIP
+      @duration_period_count = duration_period_count unless duration_period_count == SKIP
+      @duration_interval = duration_interval unless duration_interval == SKIP
+      @duration_interval_unit = duration_interval_unit unless duration_interval_unit == SKIP
+      @duration_interval_span = duration_interval_span unless duration_interval_span == SKIP
+      @allow_negative_balance = allow_negative_balance unless allow_negative_balance == SKIP
+      @archived_at = archived_at unless archived_at == SKIP
+      @conversion_limit = conversion_limit unless conversion_limit == SKIP
+      @stackable = stackable unless stackable == SKIP
+      @compounding_strategy = compounding_strategy unless compounding_strategy == SKIP
+      @use_site_exchange_rate = use_site_exchange_rate unless use_site_exchange_rate == SKIP
+      @created_at = created_at unless created_at == SKIP
+      @updated_at = updated_at unless updated_at == SKIP
+      @discount_type = discount_type unless discount_type == 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
+      @coupon_restrictions = coupon_restrictions unless coupon_restrictions == 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
+      code = hash.key?('code') ? hash['code'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+      amount = hash.key?('amount') ? hash['amount'] : SKIP
+      amount_in_cents =
+        hash.key?('amount_in_cents') ? hash['amount_in_cents'] : SKIP
+      product_family_id =
+        hash.key?('product_family_id') ? hash['product_family_id'] : SKIP
+      product_family_name =
+        hash.key?('product_family_name') ? hash['product_family_name'] : SKIP
+      start_date = hash.key?('start_date') ? hash['start_date'] : SKIP
+      end_date = hash.key?('end_date') ? hash['end_date'] : SKIP
+      percentage = hash.key?('percentage') ? hash['percentage'] : SKIP
+      recurring = hash.key?('recurring') ? hash['recurring'] : SKIP
+      recurring_scheme =
+        hash.key?('recurring_scheme') ? hash['recurring_scheme'] : SKIP
+      duration_period_count =
+        hash.key?('duration_period_count') ? hash['duration_period_count'] : SKIP
+      duration_interval =
+        hash.key?('duration_interval') ? hash['duration_interval'] : SKIP
+      duration_interval_unit =
+        hash.key?('duration_interval_unit') ? hash['duration_interval_unit'] : SKIP
+      duration_interval_span =
+        hash.key?('duration_interval_span') ? hash['duration_interval_span'] : SKIP
+      allow_negative_balance =
+        hash.key?('allow_negative_balance') ? hash['allow_negative_balance'] : SKIP
+      archived_at = hash.key?('archived_at') ? hash['archived_at'] : SKIP
+      conversion_limit =
+        hash.key?('conversion_limit') ? hash['conversion_limit'] : SKIP
+      stackable = hash.key?('stackable') ? hash['stackable'] : SKIP
+      compounding_strategy = hash.key?('compounding_strategy') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:CouponCompoundingStrategy), hash['compounding_strategy']
+      ) : SKIP
+      use_site_exchange_rate =
+        hash.key?('use_site_exchange_rate') ? hash['use_site_exchange_rate'] : SKIP
+      created_at = hash.key?('created_at') ? hash['created_at'] : SKIP
+      updated_at = hash.key?('updated_at') ? hash['updated_at'] : SKIP
+      discount_type = hash.key?('discount_type') ? hash['discount_type'] : 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
+      # Parameter is an array, so we need to iterate through it
+      coupon_restrictions = nil
+      unless hash['coupon_restrictions'].nil?
+        coupon_restrictions = []
+        hash['coupon_restrictions'].each do |structure|
+          coupon_restrictions << (CouponRestriction.from_hash(structure) if structure)
+        end
+      end
+
+      coupon_restrictions = SKIP unless hash.key?('coupon_restrictions')
+
+      # Create object from extracted values.
+      Coupon.new(id,
+                 name,
+                 code,
+                 description,
+                 amount,
+                 amount_in_cents,
+                 product_family_id,
+                 product_family_name,
+                 start_date,
+                 end_date,
+                 percentage,
+                 recurring,
+                 recurring_scheme,
+                 duration_period_count,
+                 duration_interval,
+                 duration_interval_unit,
+                 duration_interval_span,
+                 allow_negative_balance,
+                 archived_at,
+                 conversion_limit,
+                 stackable,
+                 compounding_strategy,
+                 use_site_exchange_rate,
+                 created_at,
+                 updated_at,
+                 discount_type,
+                 exclude_mid_period_allocations,
+                 apply_on_cancel_at_end_of_period,
+                 coupon_restrictions)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Coupon | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
+  end
+end

data/lib/advanced_billing/models/coupon_currency.rb

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

data/lib/advanced_billing/models/coupon_currency_request.rb

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

data/lib/advanced_billing/models/coupon_response.rb

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

data/lib/advanced_billing/models/coupon_restriction.rb

@@ -0,0 +1,99 @@
+# 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
+
+    # Validates an instance of the object from a given value.
+    # @param [CouponRestriction | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    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