subtain-apimatic-sdk 4.1.1 → 9.1.1

data/lib/advanced_billing/models/full_subscription_group_response.rb

@@ -0,0 +1,165 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # FullSubscriptionGroupResponse Model.
+  class FullSubscriptionGroupResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :uid
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :scheme
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :customer_id
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :payment_profile_id
+
+    # TODO: Write general description for this method
+    # @return [Array[Integer]]
+    attr_accessor :subscription_ids
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :primary_subscription_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :next_assessment_at
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :state
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :cancel_at_end_of_period
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :current_billing_amount_in_cents
+
+    # TODO: Write general description for this method
+    # @return [SubscriptionGroupCustomer]
+    attr_accessor :customer
+
+    # TODO: Write general description for this method
+    # @return [SubscriptionGroupBalances]
+    attr_accessor :account_balances
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['uid'] = 'uid'
+      @_hash['scheme'] = 'scheme'
+      @_hash['customer_id'] = 'customer_id'
+      @_hash['payment_profile_id'] = 'payment_profile_id'
+      @_hash['subscription_ids'] = 'subscription_ids'
+      @_hash['primary_subscription_id'] = 'primary_subscription_id'
+      @_hash['next_assessment_at'] = 'next_assessment_at'
+      @_hash['state'] = 'state'
+      @_hash['cancel_at_end_of_period'] = 'cancel_at_end_of_period'
+      @_hash['current_billing_amount_in_cents'] =
+        'current_billing_amount_in_cents'
+      @_hash['customer'] = 'customer'
+      @_hash['account_balances'] = 'account_balances'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        uid
+        scheme
+        customer_id
+        payment_profile_id
+        subscription_ids
+        primary_subscription_id
+        next_assessment_at
+        state
+        cancel_at_end_of_period
+        current_billing_amount_in_cents
+        customer
+        account_balances
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(uid = SKIP, scheme = SKIP, customer_id = SKIP,
+                   payment_profile_id = SKIP, subscription_ids = SKIP,
+                   primary_subscription_id = SKIP, next_assessment_at = SKIP,
+                   state = SKIP, cancel_at_end_of_period = SKIP,
+                   current_billing_amount_in_cents = SKIP, customer = SKIP,
+                   account_balances = SKIP)
+      @uid = uid unless uid == SKIP
+      @scheme = scheme unless scheme == SKIP
+      @customer_id = customer_id unless customer_id == SKIP
+      @payment_profile_id = payment_profile_id unless payment_profile_id == SKIP
+      @subscription_ids = subscription_ids unless subscription_ids == SKIP
+      @primary_subscription_id = primary_subscription_id unless primary_subscription_id == SKIP
+      @next_assessment_at = next_assessment_at unless next_assessment_at == SKIP
+      @state = state unless state == SKIP
+      @cancel_at_end_of_period = cancel_at_end_of_period unless cancel_at_end_of_period == SKIP
+      unless current_billing_amount_in_cents == SKIP
+        @current_billing_amount_in_cents =
+          current_billing_amount_in_cents
+      end
+      @customer = customer unless customer == SKIP
+      @account_balances = account_balances unless account_balances == 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.
+      uid = hash.key?('uid') ? hash['uid'] : SKIP
+      scheme = hash.key?('scheme') ? hash['scheme'] : SKIP
+      customer_id = hash.key?('customer_id') ? hash['customer_id'] : SKIP
+      payment_profile_id =
+        hash.key?('payment_profile_id') ? hash['payment_profile_id'] : SKIP
+      subscription_ids =
+        hash.key?('subscription_ids') ? hash['subscription_ids'] : SKIP
+      primary_subscription_id =
+        hash.key?('primary_subscription_id') ? hash['primary_subscription_id'] : SKIP
+      next_assessment_at =
+        hash.key?('next_assessment_at') ? hash['next_assessment_at'] : SKIP
+      state = hash.key?('state') ? hash['state'] : SKIP
+      cancel_at_end_of_period =
+        hash.key?('cancel_at_end_of_period') ? hash['cancel_at_end_of_period'] : SKIP
+      current_billing_amount_in_cents =
+        hash.key?('current_billing_amount_in_cents') ? hash['current_billing_amount_in_cents'] : SKIP
+      customer = SubscriptionGroupCustomer.from_hash(hash['customer']) if hash['customer']
+      account_balances = SubscriptionGroupBalances.from_hash(hash['account_balances']) if
+        hash['account_balances']
+
+      # Create object from extracted values.
+      FullSubscriptionGroupResponse.new(uid,
+                                        scheme,
+                                        customer_id,
+                                        payment_profile_id,
+                                        subscription_ids,
+                                        primary_subscription_id,
+                                        next_assessment_at,
+                                        state,
+                                        cancel_at_end_of_period,
+                                        current_billing_amount_in_cents,
+                                        customer,
+                                        account_balances)
+    end
+  end
+end

data/lib/advanced_billing/models/get_one_time_token_payment_profile.rb

@@ -0,0 +1,249 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # GetOneTimeTokenPaymentProfile Model.
+  class GetOneTimeTokenPaymentProfile < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    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
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :card_type
+
+    # TODO: Write general description for this method
+    # @return [Float]
+    attr_accessor :expiration_month
+
+    # TODO: Write general description for this method
+    # @return [Float]
+    attr_accessor :expiration_year
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :customer_id
+
+    # The vault that stores the payment profile with the provided `vault_token`.
+    # Use `bogus` for testing.
+    # @return [CurrentVault]
+    attr_accessor :current_vault
+
+    # The vault that stores the payment profile with the provided `vault_token`.
+    # Use `bogus` for testing.
+    # @return [String]
+    attr_accessor :vault_token
+
+    # The vault that stores the payment profile with the provided `vault_token`.
+    # Use `bogus` for testing.
+    # @return [String]
+    attr_accessor :billing_address
+
+    # The vault that stores the payment profile with the provided `vault_token`.
+    # Use `bogus` for testing.
+    # @return [String]
+    attr_accessor :billing_address_2
+
+    # The vault that stores the payment profile with the provided `vault_token`.
+    # Use `bogus` for testing.
+    # @return [String]
+    attr_accessor :billing_city
+
+    # The vault that stores the payment profile with the provided `vault_token`.
+    # Use `bogus` for testing.
+    # @return [String]
+    attr_accessor :billing_country
+
+    # The vault that stores the payment profile with the provided `vault_token`.
+    # Use `bogus` for testing.
+    # @return [String]
+    attr_accessor :billing_state
+
+    # The vault that stores the payment profile with the provided `vault_token`.
+    # Use `bogus` for testing.
+    # @return [String]
+    attr_accessor :billing_zip
+
+    # The vault that stores the payment profile with the provided `vault_token`.
+    # Use `bogus` for testing.
+    # @return [String]
+    attr_accessor :payment_type
+
+    # The vault that stores the payment profile with the provided `vault_token`.
+    # Use `bogus` for testing.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :disabled
+
+    # The vault that stores the payment profile with the provided `vault_token`.
+    # Use `bogus` for testing.
+    # @return [Integer]
+    attr_accessor :site_gateway_setting_id
+
+    # The vault that stores the payment profile with the provided `vault_token`.
+    # Use `bogus` for testing.
+    # @return [String]
+    attr_accessor :customer_vault_token
+
+    # The vault that stores the payment profile with the provided `vault_token`.
+    # Use `bogus` for testing.
+    # @return [String]
+    attr_accessor :gateway_handle
+
+    # 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['card_type'] = 'card_type'
+      @_hash['expiration_month'] = 'expiration_month'
+      @_hash['expiration_year'] = 'expiration_year'
+      @_hash['customer_id'] = 'customer_id'
+      @_hash['current_vault'] = 'current_vault'
+      @_hash['vault_token'] = 'vault_token'
+      @_hash['billing_address'] = 'billing_address'
+      @_hash['billing_address_2'] = 'billing_address_2'
+      @_hash['billing_city'] = 'billing_city'
+      @_hash['billing_country'] = 'billing_country'
+      @_hash['billing_state'] = 'billing_state'
+      @_hash['billing_zip'] = 'billing_zip'
+      @_hash['payment_type'] = 'payment_type'
+      @_hash['disabled'] = 'disabled'
+      @_hash['site_gateway_setting_id'] = 'site_gateway_setting_id'
+      @_hash['customer_vault_token'] = 'customer_vault_token'
+      @_hash['gateway_handle'] = 'gateway_handle'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        customer_id
+        billing_address_2
+        customer_vault_token
+        gateway_handle
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        id
+        customer_id
+        customer_vault_token
+        gateway_handle
+      ]
+    end
+
+    def initialize(first_name = nil, last_name = nil, masked_card_number = nil,
+                   card_type = nil, expiration_month = nil,
+                   expiration_year = nil, current_vault = nil,
+                   vault_token = nil, billing_address = nil, billing_city = nil,
+                   billing_country = nil, billing_state = nil,
+                   billing_zip = nil, payment_type = nil, disabled = nil,
+                   site_gateway_setting_id = nil, id = SKIP, customer_id = SKIP,
+                   billing_address_2 = SKIP, customer_vault_token = SKIP,
+                   gateway_handle = SKIP)
+      @id = id unless id == SKIP
+      @first_name = first_name
+      @last_name = last_name
+      @masked_card_number = masked_card_number
+      @card_type = card_type
+      @expiration_month = expiration_month
+      @expiration_year = expiration_year
+      @customer_id = customer_id unless customer_id == SKIP
+      @current_vault = current_vault
+      @vault_token = vault_token
+      @billing_address = billing_address
+      @billing_address_2 = billing_address_2 unless billing_address_2 == SKIP
+      @billing_city = billing_city
+      @billing_country = billing_country
+      @billing_state = billing_state
+      @billing_zip = billing_zip
+      @payment_type = payment_type
+      @disabled = disabled
+      @site_gateway_setting_id = site_gateway_setting_id
+      @customer_vault_token = customer_vault_token unless customer_vault_token == SKIP
+      @gateway_handle = gateway_handle unless gateway_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.
+      first_name = hash.key?('first_name') ? hash['first_name'] : nil
+      last_name = hash.key?('last_name') ? hash['last_name'] : nil
+      masked_card_number =
+        hash.key?('masked_card_number') ? hash['masked_card_number'] : nil
+      card_type = hash.key?('card_type') ? hash['card_type'] : nil
+      expiration_month =
+        hash.key?('expiration_month') ? hash['expiration_month'] : nil
+      expiration_year =
+        hash.key?('expiration_year') ? hash['expiration_year'] : nil
+      current_vault = hash.key?('current_vault') ? hash['current_vault'] : nil
+      vault_token = hash.key?('vault_token') ? hash['vault_token'] : nil
+      billing_address =
+        hash.key?('billing_address') ? hash['billing_address'] : nil
+      billing_city = hash.key?('billing_city') ? hash['billing_city'] : nil
+      billing_country =
+        hash.key?('billing_country') ? hash['billing_country'] : nil
+      billing_state = hash.key?('billing_state') ? hash['billing_state'] : nil
+      billing_zip = hash.key?('billing_zip') ? hash['billing_zip'] : nil
+      payment_type = hash.key?('payment_type') ? hash['payment_type'] : nil
+      disabled = hash.key?('disabled') ? hash['disabled'] : nil
+      site_gateway_setting_id =
+        hash.key?('site_gateway_setting_id') ? hash['site_gateway_setting_id'] : nil
+      id = hash.key?('id') ? hash['id'] : SKIP
+      customer_id = hash.key?('customer_id') ? hash['customer_id'] : SKIP
+      billing_address_2 =
+        hash.key?('billing_address_2') ? hash['billing_address_2'] : SKIP
+      customer_vault_token =
+        hash.key?('customer_vault_token') ? hash['customer_vault_token'] : SKIP
+      gateway_handle =
+        hash.key?('gateway_handle') ? hash['gateway_handle'] : SKIP
+
+      # Create object from extracted values.
+      GetOneTimeTokenPaymentProfile.new(first_name,
+                                        last_name,
+                                        masked_card_number,
+                                        card_type,
+                                        expiration_month,
+                                        expiration_year,
+                                        current_vault,
+                                        vault_token,
+                                        billing_address,
+                                        billing_city,
+                                        billing_country,
+                                        billing_state,
+                                        billing_zip,
+                                        payment_type,
+                                        disabled,
+                                        site_gateway_setting_id,
+                                        id,
+                                        customer_id,
+                                        billing_address_2,
+                                        customer_vault_token,
+                                        gateway_handle)
+    end
+  end
+end

data/lib/advanced_billing/models/get_one_time_token_request.rb

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

data/lib/advanced_billing/models/group_billing.rb

@@ -0,0 +1,85 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Optional attributes related to billing date and accrual. Note: Only
+  # applicable for new subscriptions.
+  class GroupBilling < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A flag indicating whether or not to accrue charges on the new
+    # subscription.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :accrue
+
+    # A flag indicating whether or not to align the billing date of the new
+    # subscription with the billing date of the primary subscription of the
+    # hierarchy's default subscription group. Required to be true if prorate is
+    # also true.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :align_date
+
+    # A flag indicating whether or not to prorate billing of the new
+    # subscription for the current period. A value of true is ignored unless
+    # align_date is also true.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :prorate
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['accrue'] = 'accrue'
+      @_hash['align_date'] = 'align_date'
+      @_hash['prorate'] = 'prorate'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        accrue
+        align_date
+        prorate
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(accrue = false, align_date = false, prorate = false)
+      @accrue = accrue unless accrue == SKIP
+      @align_date = align_date unless align_date == SKIP
+      @prorate = prorate unless prorate == 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.
+      accrue = hash['accrue'] ||= false
+      align_date = hash['align_date'] ||= false
+      prorate = hash['prorate'] ||= false
+
+      # Create object from extracted values.
+      GroupBilling.new(accrue,
+                       align_date,
+                       prorate)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [GroupBilling | 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/group_settings.rb

@@ -0,0 +1,76 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # GroupSettings Model.
+  class GroupSettings < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Attributes of the target customer who will be the responsible payer of the
+    # created subscription. Required.
+    # @return [GroupTarget]
+    attr_accessor :target
+
+    # Optional attributes related to billing date and accrual. Note: Only
+    # applicable for new subscriptions.
+    # @return [GroupBilling]
+    attr_accessor :billing
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['target'] = 'target'
+      @_hash['billing'] = 'billing'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        billing
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(target = nil, billing = SKIP)
+      @target = target
+      @billing = billing unless billing == 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.
+      target = GroupTarget.from_hash(hash['target']) if hash['target']
+      billing = GroupBilling.from_hash(hash['billing']) if hash['billing']
+
+      # Create object from extracted values.
+      GroupSettings.new(target,
+                        billing)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [GroupSettings | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.target,
+                                     ->(val) { GroupTarget.validate(val) },
+                                     is_model_hash: true)
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['target'],
+                            ->(val) { GroupTarget.validate(val) },
+                            is_model_hash: true)
+    end
+  end
+end

data/lib/advanced_billing/models/group_target.rb

@@ -0,0 +1,75 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Attributes of the target customer who will be the responsible payer of the
+  # created subscription. Required.
+  class GroupTarget < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The type of object indicated by the id attribute.
+    # @return [GroupTargetType]
+    attr_accessor :type
+
+    # The id of the target customer or subscription to group the existing
+    # subscription with. Ignored and should not be included if type is "self" ,
+    # "parent", or "eldest"
+    # @return [Integer]
+    attr_accessor :id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['id'] = 'id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(type = nil, id = SKIP)
+      @type = type
+      @id = id unless 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.
+      type = hash.key?('type') ? hash['type'] : nil
+      id = hash.key?('id') ? hash['id'] : SKIP
+
+      # Create object from extracted values.
+      GroupTarget.new(type,
+                      id)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [GroupTarget | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.type,
+                                     ->(val) { GroupTargetType.validate(val) })
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['type'],
+                            ->(val) { GroupTargetType.validate(val) })
+    end
+  end
+end