subtain-apimatic-sdk 4.1.1 → 9.1.1

data/lib/advanced_billing/models/create_offer_component.rb

@@ -0,0 +1,60 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # CreateOfferComponent Model.
+  class CreateOfferComponent < 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 :starting_quantity
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['component_id'] = 'component_id'
+      @_hash['starting_quantity'] = 'starting_quantity'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        component_id
+        starting_quantity
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(component_id = SKIP, starting_quantity = SKIP)
+      @component_id = component_id unless component_id == SKIP
+      @starting_quantity = starting_quantity unless starting_quantity == 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
+      starting_quantity =
+        hash.key?('starting_quantity') ? hash['starting_quantity'] : SKIP
+
+      # Create object from extracted values.
+      CreateOfferComponent.new(component_id,
+                               starting_quantity)
+    end
+  end
+end

data/lib/advanced_billing/models/create_offer_request.rb

@@ -0,0 +1,48 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # CreateOfferRequest Model.
+  class CreateOfferRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [CreateOffer]
+    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
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(offer = nil)
+      @offer = offer
+    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 = CreateOffer.from_hash(hash['offer']) if hash['offer']
+
+      # Create object from extracted values.
+      CreateOfferRequest.new(offer)
+    end
+  end
+end

data/lib/advanced_billing/models/create_on_off_component.rb

@@ -0,0 +1,65 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # CreateOnOffComponent Model.
+  class CreateOnOffComponent < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [OnOffComponent]
+    attr_accessor :on_off_component
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['on_off_component'] = 'on_off_component'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(on_off_component = nil)
+      @on_off_component = on_off_component
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      on_off_component = OnOffComponent.from_hash(hash['on_off_component']) if
+        hash['on_off_component']
+
+      # Create object from extracted values.
+      CreateOnOffComponent.new(on_off_component)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [CreateOnOffComponent | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.on_off_component,
+                                     ->(val) { OnOffComponent.validate(val) },
+                                     is_model_hash: true)
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['on_off_component'],
+                            ->(val) { OnOffComponent.validate(val) },
+                            is_model_hash: true)
+    end
+  end
+end

data/lib/advanced_billing/models/create_or_update_coupon.rb

@@ -0,0 +1,85 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # CreateOrUpdateCoupon Model.
+  class CreateOrUpdateCoupon < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Object]
+    attr_accessor :coupon
+
+    # An object where the keys are product_ids and the values are booleans
+    # indicating if the coupon should be applicable to the product
+    # @return [Hash[String, TrueClass | FalseClass]]
+    attr_accessor :restricted_products
+
+    # An object where the keys are component_ids and the values are booleans
+    # indicating if the coupon should be applicable to the component
+    # @return [Hash[String, TrueClass | FalseClass]]
+    attr_accessor :restricted_components
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['coupon'] = 'coupon'
+      @_hash['restricted_products'] = 'restricted_products'
+      @_hash['restricted_components'] = 'restricted_components'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        coupon
+        restricted_products
+        restricted_components
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(coupon = SKIP, restricted_products = SKIP,
+                   restricted_components = SKIP)
+      @coupon = coupon unless coupon == SKIP
+      @restricted_products = restricted_products unless restricted_products == SKIP
+      @restricted_components = restricted_components unless restricted_components == 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 = hash.key?('coupon') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:CreateOrUpdateCouponCoupon), hash['coupon']
+      ) : SKIP
+      restricted_products =
+        hash.key?('restricted_products') ? hash['restricted_products'] : SKIP
+      restricted_components =
+        hash.key?('restricted_components') ? hash['restricted_components'] : SKIP
+
+      # Create object from extracted values.
+      CreateOrUpdateCoupon.new(coupon,
+                               restricted_products,
+                               restricted_components)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [CreateOrUpdateCoupon | 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/create_or_update_flat_amount_coupon.rb

@@ -0,0 +1,214 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+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 [String]
+    attr_accessor :allow_negative_balance
+
+    # may contain uppercase alphanumeric characters and these special characters
+    # (which allow for email addresses to be used): “%”, “@”, “+”, “-”, “_”, and
+    # “.”
+    # @return [String]
+    attr_accessor :recurring
+
+    # may contain uppercase alphanumeric characters and these special characters
+    # (which allow for email addresses to be used): “%”, “@”, “+”, “-”, “_”, and
+    # “.”
+    # @return [String]
+    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 [String]
+    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 = hash.key?('end_date') ? hash['end_date'] : SKIP
+      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') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:CreateOrUpdateFlatAmountCouponCompoundingStrategy), 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
+
+    # 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,215 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+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 [String]
+    attr_accessor :allow_negative_balance
+
+    # may contain uppercase alphanumeric characters and these special characters
+    # (which allow for email addresses to be used): “%”, “@”, “+”, “-”, “_”, and
+    # “.”
+    # @return [String]
+    attr_accessor :recurring
+
+    # may contain uppercase alphanumeric characters and these special characters
+    # (which allow for email addresses to be used): “%”, “@”, “+”, “-”, “_”, and
+    # “.”
+    # @return [String]
+    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 [String]
+    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 = hash.key?('end_date') ? hash['end_date'] : SKIP
+      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') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:CreateOrUpdatePercentageCouponCompoundingStrategy), 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
+
+    # 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