maxio-advanced-billing-sdk 0.0.3 → 1.0.0

data/lib/advanced_billing/models/subscription_group_signup.rb

@@ -0,0 +1,154 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # SubscriptionGroupSignup Model.
+  class SubscriptionGroupSignup < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :payment_profile_id
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :payer_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :payer_reference
+
+    # The type of payment collection to be used in the subscription. For legacy
+    # Statements Architecture valid options are - `invoice`, `automatic`. For
+    # current Relationship Invoicing Architecture valid options are -
+    # `remittance`, `automatic`, `prepaid`.
+    # @return [CollectionMethod]
+    attr_accessor :payment_collection_method
+
+    # The type of payment collection to be used in the subscription. For legacy
+    # Statements Architecture valid options are - `invoice`, `automatic`. For
+    # current Relationship Invoicing Architecture valid options are -
+    # `remittance`, `automatic`, `prepaid`.
+    # @return [PayerAttributes]
+    attr_accessor :payer_attributes
+
+    # The type of payment collection to be used in the subscription. For legacy
+    # Statements Architecture valid options are - `invoice`, `automatic`. For
+    # current Relationship Invoicing Architecture valid options are -
+    # `remittance`, `automatic`, `prepaid`.
+    # @return [SubscriptionGroupCreditCard]
+    attr_accessor :credit_card_attributes
+
+    # The type of payment collection to be used in the subscription. For legacy
+    # Statements Architecture valid options are - `invoice`, `automatic`. For
+    # current Relationship Invoicing Architecture valid options are -
+    # `remittance`, `automatic`, `prepaid`.
+    # @return [SubscriptionGroupBankAccount]
+    attr_accessor :bank_account_attributes
+
+    # The type of payment collection to be used in the subscription. For legacy
+    # Statements Architecture valid options are - `invoice`, `automatic`. For
+    # current Relationship Invoicing Architecture valid options are -
+    # `remittance`, `automatic`, `prepaid`.
+    # @return [Array[SubscriptionGroupSignupItem]]
+    attr_accessor :subscriptions
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['payment_profile_id'] = 'payment_profile_id'
+      @_hash['payer_id'] = 'payer_id'
+      @_hash['payer_reference'] = 'payer_reference'
+      @_hash['payment_collection_method'] = 'payment_collection_method'
+      @_hash['payer_attributes'] = 'payer_attributes'
+      @_hash['credit_card_attributes'] = 'credit_card_attributes'
+      @_hash['bank_account_attributes'] = 'bank_account_attributes'
+      @_hash['subscriptions'] = 'subscriptions'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        payment_profile_id
+        payer_id
+        payer_reference
+        payment_collection_method
+        payer_attributes
+        credit_card_attributes
+        bank_account_attributes
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(subscriptions = nil,
+                   payment_profile_id = SKIP,
+                   payer_id = SKIP,
+                   payer_reference = SKIP,
+                   payment_collection_method = CollectionMethod::AUTOMATIC,
+                   payer_attributes = SKIP,
+                   credit_card_attributes = SKIP,
+                   bank_account_attributes = SKIP)
+      @payment_profile_id = payment_profile_id unless payment_profile_id == SKIP
+      @payer_id = payer_id unless payer_id == SKIP
+      @payer_reference = payer_reference unless payer_reference == SKIP
+      unless payment_collection_method == SKIP
+        @payment_collection_method =
+          payment_collection_method
+      end
+      @payer_attributes = payer_attributes unless payer_attributes == SKIP
+      @credit_card_attributes = credit_card_attributes unless credit_card_attributes == SKIP
+      @bank_account_attributes = bank_account_attributes unless bank_account_attributes == SKIP
+      @subscriptions = subscriptions
+    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
+      subscriptions = nil
+      unless hash['subscriptions'].nil?
+        subscriptions = []
+        hash['subscriptions'].each do |structure|
+          subscriptions << (SubscriptionGroupSignupItem.from_hash(structure) if structure)
+        end
+      end
+
+      subscriptions = nil unless hash.key?('subscriptions')
+      payment_profile_id =
+        hash.key?('payment_profile_id') ? hash['payment_profile_id'] : SKIP
+      payer_id = hash.key?('payer_id') ? hash['payer_id'] : SKIP
+      payer_reference =
+        hash.key?('payer_reference') ? hash['payer_reference'] : SKIP
+      payment_collection_method =
+        hash['payment_collection_method'] ||= CollectionMethod::AUTOMATIC
+      payer_attributes = PayerAttributes.from_hash(hash['payer_attributes']) if
+        hash['payer_attributes']
+      if hash['credit_card_attributes']
+        credit_card_attributes = SubscriptionGroupCreditCard.from_hash(hash['credit_card_attributes'])
+      end
+      if hash['bank_account_attributes']
+        bank_account_attributes = SubscriptionGroupBankAccount.from_hash(hash['bank_account_attributes'])
+      end
+
+      # Create object from extracted values.
+      SubscriptionGroupSignup.new(subscriptions,
+                                  payment_profile_id,
+                                  payer_id,
+                                  payer_reference,
+                                  payment_collection_method,
+                                  payer_attributes,
+                                  credit_card_attributes,
+                                  bank_account_attributes)
+    end
+  end
+end

data/lib/advanced_billing/models/subscription_group_signup_component.rb

@@ -0,0 +1,110 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # SubscriptionGroupSignupComponent Model.
+  class SubscriptionGroupSignupComponent < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Required if passing any component to `components` attribute.
+    # @return [Object]
+    attr_accessor :component_id
+
+    # Required if passing any component to `components` attribute.
+    # @return [Object]
+    attr_accessor :allocated_quantity
+
+    # Required if passing any component to `components` attribute.
+    # @return [Object]
+    attr_accessor :unit_balance
+
+    # Required if passing any component to `components` attribute.
+    # @return [Object]
+    attr_accessor :price_point_id
+
+    # Used in place of `price_point_id` to define a custom price point unique to
+    # the subscription. You still need to provide `component_id`.
+    # @return [SubscriptionGroupComponentCustomPrice]
+    attr_accessor :custom_price
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['component_id'] = 'component_id'
+      @_hash['allocated_quantity'] = 'allocated_quantity'
+      @_hash['unit_balance'] = 'unit_balance'
+      @_hash['price_point_id'] = 'price_point_id'
+      @_hash['custom_price'] = 'custom_price'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        component_id
+        allocated_quantity
+        unit_balance
+        price_point_id
+        custom_price
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(component_id = SKIP,
+                   allocated_quantity = SKIP,
+                   unit_balance = SKIP,
+                   price_point_id = SKIP,
+                   custom_price = SKIP)
+      @component_id = component_id unless component_id == SKIP
+      @allocated_quantity = allocated_quantity unless allocated_quantity == SKIP
+      @unit_balance = unit_balance unless unit_balance == SKIP
+      @price_point_id = price_point_id unless price_point_id == SKIP
+      @custom_price = custom_price unless custom_price == 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') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:SubscriptionGroupSignupComponentComponentId), hash['component_id']
+      ) : SKIP
+      allocated_quantity = hash.key?('allocated_quantity') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:SubscriptionGroupSignupComponentAllocatedQuantity), hash['allocated_quantity']
+      ) : SKIP
+      unit_balance = hash.key?('unit_balance') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:SubscriptionGroupSignupComponentUnitBalance), hash['unit_balance']
+      ) : SKIP
+      price_point_id = hash.key?('price_point_id') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:SubscriptionGroupSignupComponentPricePointId), hash['price_point_id']
+      ) : SKIP
+      custom_price = SubscriptionGroupComponentCustomPrice.from_hash(hash['custom_price']) if
+        hash['custom_price']
+
+      # Create object from extracted values.
+      SubscriptionGroupSignupComponent.new(component_id,
+                                           allocated_quantity,
+                                           unit_balance,
+                                           price_point_id,
+                                           custom_price)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [SubscriptionGroupSignupComponent | 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/subscription_group_signup_error.rb

@@ -0,0 +1,112 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # SubscriptionGroupSignupError Model.
+  class SubscriptionGroupSignupError < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Object that as key have subscription position in request subscriptions
+    # array and as value subscription errors object.
+    # @return [Hash[String, SubscriptionGroupSubscriptionError]]
+    attr_accessor :subscriptions
+
+    # Object that as key have subscription position in request subscriptions
+    # array and as value subscription errors object.
+    # @return [String]
+    attr_accessor :payer_reference
+
+    # Object that as key have subscription position in request subscriptions
+    # array and as value subscription errors object.
+    # @return [PayerError]
+    attr_accessor :payer
+
+    # Object that as key have subscription position in request subscriptions
+    # array and as value subscription errors object.
+    # @return [Array[String]]
+    attr_accessor :subscription_group
+
+    # Object that as key have subscription position in request subscriptions
+    # array and as value subscription errors object.
+    # @return [String]
+    attr_accessor :payment_profile_id
+
+    # Object that as key have subscription position in request subscriptions
+    # array and as value subscription errors object.
+    # @return [String]
+    attr_accessor :payer_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['subscriptions'] = 'subscriptions'
+      @_hash['payer_reference'] = 'payer_reference'
+      @_hash['payer'] = 'payer'
+      @_hash['subscription_group'] = 'subscription_group'
+      @_hash['payment_profile_id'] = 'payment_profile_id'
+      @_hash['payer_id'] = 'payer_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        subscriptions
+        payer_reference
+        payer
+        subscription_group
+        payment_profile_id
+        payer_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(subscriptions = SKIP,
+                   payer_reference = SKIP,
+                   payer = SKIP,
+                   subscription_group = SKIP,
+                   payment_profile_id = SKIP,
+                   payer_id = SKIP)
+      @subscriptions = subscriptions unless subscriptions == SKIP
+      @payer_reference = payer_reference unless payer_reference == SKIP
+      @payer = payer unless payer == SKIP
+      @subscription_group = subscription_group unless subscription_group == SKIP
+      @payment_profile_id = payment_profile_id unless payment_profile_id == SKIP
+      @payer_id = payer_id unless payer_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.
+      subscriptions = SubscriptionGroupSubscriptionError.from_hash(hash['subscriptions']) if
+        hash['subscriptions']
+
+      subscriptions = SKIP unless hash.key?('subscriptions')
+      payer_reference =
+        hash.key?('payer_reference') ? hash['payer_reference'] : SKIP
+      payer = PayerError.from_hash(hash['payer']) if hash['payer']
+      subscription_group =
+        hash.key?('subscription_group') ? hash['subscription_group'] : SKIP
+      payment_profile_id =
+        hash.key?('payment_profile_id') ? hash['payment_profile_id'] : SKIP
+      payer_id = hash.key?('payer_id') ? hash['payer_id'] : SKIP
+
+      # Create object from extracted values.
+      SubscriptionGroupSignupError.new(subscriptions,
+                                       payer_reference,
+                                       payer,
+                                       subscription_group,
+                                       payment_profile_id,
+                                       payer_id)
+    end
+  end
+end

data/lib/advanced_billing/models/subscription_group_signup_failure.rb

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

data/lib/advanced_billing/models/subscription_group_signup_failure_data.rb

@@ -0,0 +1,140 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # SubscriptionGroupSignupFailureData Model.
+  class SubscriptionGroupSignupFailureData < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :payer_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :payer_reference
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :payment_profile_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :payment_collection_method
+
+    # TODO: Write general description for this method
+    # @return [PayerAttributes]
+    attr_accessor :payer_attributes
+
+    # TODO: Write general description for this method
+    # @return [SubscriptionGroupCreditCard]
+    attr_accessor :credit_card_attributes
+
+    # TODO: Write general description for this method
+    # @return [SubscriptionGroupBankAccount]
+    attr_accessor :bank_account_attributes
+
+    # TODO: Write general description for this method
+    # @return [Array[SubscriptionGroupSignupItem]]
+    attr_accessor :subscriptions
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['payer_id'] = 'payer_id'
+      @_hash['payer_reference'] = 'payer_reference'
+      @_hash['payment_profile_id'] = 'payment_profile_id'
+      @_hash['payment_collection_method'] = 'payment_collection_method'
+      @_hash['payer_attributes'] = 'payer_attributes'
+      @_hash['credit_card_attributes'] = 'credit_card_attributes'
+      @_hash['bank_account_attributes'] = 'bank_account_attributes'
+      @_hash['subscriptions'] = 'subscriptions'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        payer_id
+        payer_reference
+        payment_profile_id
+        payment_collection_method
+        payer_attributes
+        credit_card_attributes
+        bank_account_attributes
+        subscriptions
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(payer_id = SKIP,
+                   payer_reference = SKIP,
+                   payment_profile_id = SKIP,
+                   payment_collection_method = SKIP,
+                   payer_attributes = SKIP,
+                   credit_card_attributes = SKIP,
+                   bank_account_attributes = SKIP,
+                   subscriptions = SKIP)
+      @payer_id = payer_id unless payer_id == SKIP
+      @payer_reference = payer_reference unless payer_reference == SKIP
+      @payment_profile_id = payment_profile_id unless payment_profile_id == SKIP
+      unless payment_collection_method == SKIP
+        @payment_collection_method =
+          payment_collection_method
+      end
+      @payer_attributes = payer_attributes unless payer_attributes == SKIP
+      @credit_card_attributes = credit_card_attributes unless credit_card_attributes == SKIP
+      @bank_account_attributes = bank_account_attributes unless bank_account_attributes == SKIP
+      @subscriptions = subscriptions unless subscriptions == 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.
+      payer_id = hash.key?('payer_id') ? hash['payer_id'] : SKIP
+      payer_reference =
+        hash.key?('payer_reference') ? hash['payer_reference'] : SKIP
+      payment_profile_id =
+        hash.key?('payment_profile_id') ? hash['payment_profile_id'] : SKIP
+      payment_collection_method =
+        hash.key?('payment_collection_method') ? hash['payment_collection_method'] : SKIP
+      payer_attributes = PayerAttributes.from_hash(hash['payer_attributes']) if
+        hash['payer_attributes']
+      if hash['credit_card_attributes']
+        credit_card_attributes = SubscriptionGroupCreditCard.from_hash(hash['credit_card_attributes'])
+      end
+      if hash['bank_account_attributes']
+        bank_account_attributes = SubscriptionGroupBankAccount.from_hash(hash['bank_account_attributes'])
+      end
+      # Parameter is an array, so we need to iterate through it
+      subscriptions = nil
+      unless hash['subscriptions'].nil?
+        subscriptions = []
+        hash['subscriptions'].each do |structure|
+          subscriptions << (SubscriptionGroupSignupItem.from_hash(structure) if structure)
+        end
+      end
+
+      subscriptions = SKIP unless hash.key?('subscriptions')
+
+      # Create object from extracted values.
+      SubscriptionGroupSignupFailureData.new(payer_id,
+                                             payer_reference,
+                                             payment_profile_id,
+                                             payment_collection_method,
+                                             payer_attributes,
+                                             credit_card_attributes,
+                                             bank_account_attributes,
+                                             subscriptions)
+    end
+  end
+end