subtain-apimatic-sdk 4.1.1 → 9.1.1

data/lib/advanced_billing/models/subscription_group_member_error.rb

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

data/lib/advanced_billing/models/subscription_group_payment_profile.rb

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

data/lib/advanced_billing/models/subscription_group_prepayment.rb

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

data/lib/advanced_billing/models/subscription_group_prepayment_method.rb

@@ -0,0 +1,35 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Subscription Group Prepayment Method.
+  class SubscriptionGroupPrepaymentMethod
+    SUBSCRIPTION_GROUP_PREPAYMENT_METHOD = [
+      # TODO: Write general description for CHECK
+      CHECK = 'check'.freeze,
+
+      # TODO: Write general description for CASH
+      CASH = 'cash'.freeze,
+
+      # TODO: Write general description for MONEY_ORDER
+      MONEY_ORDER = 'money_order'.freeze,
+
+      # TODO: Write general description for ACH
+      ACH = 'ach'.freeze,
+
+      # TODO: Write general description for PAYPAL_ACCOUNT
+      PAYPAL_ACCOUNT = 'paypal_account'.freeze,
+
+      # TODO: Write general description for OTHER
+      OTHER = 'other'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SUBSCRIPTION_GROUP_PREPAYMENT_METHOD.include?(value)
+    end
+  end
+end

data/lib/advanced_billing/models/subscription_group_prepayment_request.rb

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

data/lib/advanced_billing/models/subscription_group_prepayment_response.rb

@@ -0,0 +1,90 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # SubscriptionGroupPrepaymentResponse Model.
+  class SubscriptionGroupPrepaymentResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :id
+
+    # The amount in cents of the entry.
+    # @return [Integer]
+    attr_accessor :amount_in_cents
+
+    # The ending balance in cents of the account.
+    # @return [Integer]
+    attr_accessor :ending_balance_in_cents
+
+    # The type of entry
+    # @return [ServiceCreditType]
+    attr_accessor :entry_type
+
+    # A memo attached to the entry.
+    # @return [String]
+    attr_accessor :memo
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['amount_in_cents'] = 'amount_in_cents'
+      @_hash['ending_balance_in_cents'] = 'ending_balance_in_cents'
+      @_hash['entry_type'] = 'entry_type'
+      @_hash['memo'] = 'memo'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        amount_in_cents
+        ending_balance_in_cents
+        entry_type
+        memo
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = SKIP, amount_in_cents = SKIP,
+                   ending_balance_in_cents = SKIP, entry_type = SKIP,
+                   memo = SKIP)
+      @id = id unless id == SKIP
+      @amount_in_cents = amount_in_cents unless amount_in_cents == SKIP
+      @ending_balance_in_cents = ending_balance_in_cents unless ending_balance_in_cents == SKIP
+      @entry_type = entry_type unless entry_type == SKIP
+      @memo = memo unless memo == 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
+      amount_in_cents =
+        hash.key?('amount_in_cents') ? hash['amount_in_cents'] : SKIP
+      ending_balance_in_cents =
+        hash.key?('ending_balance_in_cents') ? hash['ending_balance_in_cents'] : SKIP
+      entry_type = hash.key?('entry_type') ? hash['entry_type'] : SKIP
+      memo = hash.key?('memo') ? hash['memo'] : SKIP
+
+      # Create object from extracted values.
+      SubscriptionGroupPrepaymentResponse.new(id,
+                                              amount_in_cents,
+                                              ending_balance_in_cents,
+                                              entry_type,
+                                              memo)
+    end
+  end
+end

data/lib/advanced_billing/models/subscription_group_response.rb

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

data/lib/advanced_billing/models/subscription_group_signup.rb

@@ -0,0 +1,153 @@
+# 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 [PaymentCollectionMethod]
+    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 = PaymentCollectionMethod::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'] ||= PaymentCollectionMethod::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