subtain-apimatic-sdk 4.1.1 → 9.1.1

data/lib/advanced_billing/models/subscription_group_component_custom_price.rb

@@ -0,0 +1,105 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Used in place of `price_point_id` to define a custom price point unique to
+  # the subscription. You still need to provide `component_id`.
+  class SubscriptionGroupComponentCustomPrice < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The identifier for the pricing scheme. See [Product
+    # Components](https://help.chargify.com/products/product-components.html)
+    # for an overview of pricing schemes.
+    # @return [PricingScheme]
+    attr_accessor :pricing_scheme
+
+    # The identifier for the pricing scheme. See [Product
+    # Components](https://help.chargify.com/products/product-components.html)
+    # for an overview of pricing schemes.
+    # @return [Array[Price]]
+    attr_accessor :prices
+
+    # The identifier for the pricing scheme. See [Product
+    # Components](https://help.chargify.com/products/product-components.html)
+    # for an overview of pricing schemes.
+    # @return [Array[ComponentCustomPrice]]
+    attr_accessor :overage_pricing
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['pricing_scheme'] = 'pricing_scheme'
+      @_hash['prices'] = 'prices'
+      @_hash['overage_pricing'] = 'overage_pricing'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        pricing_scheme
+        prices
+        overage_pricing
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(pricing_scheme = SKIP, prices = SKIP, overage_pricing = SKIP)
+      @pricing_scheme = pricing_scheme unless pricing_scheme == SKIP
+      @prices = prices unless prices == SKIP
+      @overage_pricing = overage_pricing unless overage_pricing == 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.
+      pricing_scheme = hash.key?('pricing_scheme') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:SubscriptionGroupComponentCustomPricePricingScheme), hash['pricing_scheme']
+      ) : SKIP
+      # Parameter is an array, so we need to iterate through it
+      prices = nil
+      unless hash['prices'].nil?
+        prices = []
+        hash['prices'].each do |structure|
+          prices << (Price.from_hash(structure) if structure)
+        end
+      end
+
+      prices = SKIP unless hash.key?('prices')
+      # Parameter is an array, so we need to iterate through it
+      overage_pricing = nil
+      unless hash['overage_pricing'].nil?
+        overage_pricing = []
+        hash['overage_pricing'].each do |structure|
+          overage_pricing << (ComponentCustomPrice.from_hash(structure) if structure)
+        end
+      end
+
+      overage_pricing = SKIP unless hash.key?('overage_pricing')
+
+      # Create object from extracted values.
+      SubscriptionGroupComponentCustomPrice.new(pricing_scheme,
+                                                prices,
+                                                overage_pricing)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [SubscriptionGroupComponentCustomPrice | 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_credit_card.rb

@@ -0,0 +1,266 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # SubscriptionGroupCreditCard Model.
+  class SubscriptionGroupCreditCard < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Object]
+    attr_accessor :full_number
+
+    # TODO: Write general description for this method
+    # @return [Object]
+    attr_accessor :expiration_month
+
+    # TODO: Write general description for this method
+    # @return [Object]
+    attr_accessor :expiration_year
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :chargify_token
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :vault_token
+
+    # 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 :gateway_handle
+
+    # The vault that stores the payment profile with the provided `vault_token`.
+    # Use `bogus` for testing.
+    # @return [String]
+    attr_accessor :first_name
+
+    # The vault that stores the payment profile with the provided `vault_token`.
+    # Use `bogus` for testing.
+    # @return [String]
+    attr_accessor :last_name
+
+    # 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_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 :billing_country
+
+    # The vault that stores the payment profile with the provided `vault_token`.
+    # Use `bogus` for testing.
+    # @return [String]
+    attr_accessor :last_four
+
+    # The vault that stores the payment profile with the provided `vault_token`.
+    # Use `bogus` for testing.
+    # @return [String]
+    attr_accessor :card_type
+
+    # 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 :cvv
+
+    # The vault that stores the payment profile with the provided `vault_token`.
+    # Use `bogus` for testing.
+    # @return [String]
+    attr_accessor :payment_type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['full_number'] = 'full_number'
+      @_hash['expiration_month'] = 'expiration_month'
+      @_hash['expiration_year'] = 'expiration_year'
+      @_hash['chargify_token'] = 'chargify_token'
+      @_hash['vault_token'] = 'vault_token'
+      @_hash['current_vault'] = 'current_vault'
+      @_hash['gateway_handle'] = 'gateway_handle'
+      @_hash['first_name'] = 'first_name'
+      @_hash['last_name'] = 'last_name'
+      @_hash['billing_address'] = 'billing_address'
+      @_hash['billing_address_2'] = 'billing_address_2'
+      @_hash['billing_city'] = 'billing_city'
+      @_hash['billing_state'] = 'billing_state'
+      @_hash['billing_zip'] = 'billing_zip'
+      @_hash['billing_country'] = 'billing_country'
+      @_hash['last_four'] = 'last_four'
+      @_hash['card_type'] = 'card_type'
+      @_hash['customer_vault_token'] = 'customer_vault_token'
+      @_hash['cvv'] = 'cvv'
+      @_hash['payment_type'] = 'payment_type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        full_number
+        expiration_month
+        expiration_year
+        chargify_token
+        vault_token
+        current_vault
+        gateway_handle
+        first_name
+        last_name
+        billing_address
+        billing_address_2
+        billing_city
+        billing_state
+        billing_zip
+        billing_country
+        last_four
+        card_type
+        customer_vault_token
+        cvv
+        payment_type
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(full_number = SKIP, expiration_month = SKIP,
+                   expiration_year = SKIP, chargify_token = SKIP,
+                   vault_token = SKIP, current_vault = SKIP,
+                   gateway_handle = SKIP, first_name = SKIP, last_name = SKIP,
+                   billing_address = SKIP, billing_address_2 = SKIP,
+                   billing_city = SKIP, billing_state = SKIP,
+                   billing_zip = SKIP, billing_country = SKIP, last_four = SKIP,
+                   card_type = SKIP, customer_vault_token = SKIP, cvv = SKIP,
+                   payment_type = SKIP)
+      @full_number = full_number unless full_number == SKIP
+      @expiration_month = expiration_month unless expiration_month == SKIP
+      @expiration_year = expiration_year unless expiration_year == SKIP
+      @chargify_token = chargify_token unless chargify_token == SKIP
+      @vault_token = vault_token unless vault_token == SKIP
+      @current_vault = current_vault unless current_vault == SKIP
+      @gateway_handle = gateway_handle unless gateway_handle == SKIP
+      @first_name = first_name unless first_name == SKIP
+      @last_name = last_name unless last_name == SKIP
+      @billing_address = billing_address unless billing_address == SKIP
+      @billing_address_2 = billing_address_2 unless billing_address_2 == SKIP
+      @billing_city = billing_city unless billing_city == SKIP
+      @billing_state = billing_state unless billing_state == SKIP
+      @billing_zip = billing_zip unless billing_zip == SKIP
+      @billing_country = billing_country unless billing_country == SKIP
+      @last_four = last_four unless last_four == SKIP
+      @card_type = card_type unless card_type == SKIP
+      @customer_vault_token = customer_vault_token unless customer_vault_token == SKIP
+      @cvv = cvv unless cvv == SKIP
+      @payment_type = payment_type unless payment_type == 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.
+      full_number = hash.key?('full_number') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:SubscriptionGroupCreditCardFullNumber), hash['full_number']
+      ) : SKIP
+      expiration_month = hash.key?('expiration_month') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:SubscriptionGroupCreditCardExpirationMonth), hash['expiration_month']
+      ) : SKIP
+      expiration_year = hash.key?('expiration_year') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:SubscriptionGroupCreditCardExpirationYear), hash['expiration_year']
+      ) : SKIP
+      chargify_token =
+        hash.key?('chargify_token') ? hash['chargify_token'] : SKIP
+      vault_token = hash.key?('vault_token') ? hash['vault_token'] : SKIP
+      current_vault = hash.key?('current_vault') ? hash['current_vault'] : SKIP
+      gateway_handle =
+        hash.key?('gateway_handle') ? hash['gateway_handle'] : SKIP
+      first_name = hash.key?('first_name') ? hash['first_name'] : SKIP
+      last_name = hash.key?('last_name') ? hash['last_name'] : SKIP
+      billing_address =
+        hash.key?('billing_address') ? hash['billing_address'] : SKIP
+      billing_address_2 =
+        hash.key?('billing_address_2') ? hash['billing_address_2'] : SKIP
+      billing_city = hash.key?('billing_city') ? hash['billing_city'] : SKIP
+      billing_state = hash.key?('billing_state') ? hash['billing_state'] : SKIP
+      billing_zip = hash.key?('billing_zip') ? hash['billing_zip'] : SKIP
+      billing_country =
+        hash.key?('billing_country') ? hash['billing_country'] : SKIP
+      last_four = hash.key?('last_four') ? hash['last_four'] : SKIP
+      card_type = hash.key?('card_type') ? hash['card_type'] : SKIP
+      customer_vault_token =
+        hash.key?('customer_vault_token') ? hash['customer_vault_token'] : SKIP
+      cvv = hash.key?('cvv') ? hash['cvv'] : SKIP
+      payment_type = hash.key?('payment_type') ? hash['payment_type'] : SKIP
+
+      # Create object from extracted values.
+      SubscriptionGroupCreditCard.new(full_number,
+                                      expiration_month,
+                                      expiration_year,
+                                      chargify_token,
+                                      vault_token,
+                                      current_vault,
+                                      gateway_handle,
+                                      first_name,
+                                      last_name,
+                                      billing_address,
+                                      billing_address_2,
+                                      billing_city,
+                                      billing_state,
+                                      billing_zip,
+                                      billing_country,
+                                      last_four,
+                                      card_type,
+                                      customer_vault_token,
+                                      cvv,
+                                      payment_type)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [SubscriptionGroupCreditCard | 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_customer.rb

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

data/lib/advanced_billing/models/subscription_group_inlined.rb

@@ -0,0 +1,92 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # SubscriptionGroupInlined Model.
+  class SubscriptionGroupInlined < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The UID for the group
+    # @return [String]
+    attr_accessor :uid
+
+    # Whether the group is configured to rely on a primary subscription for
+    # billing. At this time, it will always be 1.
+    # @return [String]
+    attr_accessor :scheme
+
+    # The subscription ID of the primary within the group. Applicable to scheme
+    # 1.
+    # @return [String]
+    attr_accessor :primary_subscription_id
+
+    # A boolean indicating whether the subscription is the primary in the group.
+    # Applicable to scheme 1.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :primary
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['uid'] = 'uid'
+      @_hash['scheme'] = 'scheme'
+      @_hash['primary_subscription_id'] = 'primary_subscription_id'
+      @_hash['primary'] = 'primary'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        uid
+        scheme
+        primary_subscription_id
+        primary
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(uid = SKIP, scheme = SKIP, primary_subscription_id = SKIP,
+                   primary = SKIP)
+      @uid = uid unless uid == SKIP
+      @scheme = scheme unless scheme == SKIP
+      @primary_subscription_id = primary_subscription_id unless primary_subscription_id == SKIP
+      @primary = primary unless primary == 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
+      primary_subscription_id =
+        hash.key?('primary_subscription_id') ? hash['primary_subscription_id'] : SKIP
+      primary = hash.key?('primary') ? hash['primary'] : SKIP
+
+      # Create object from extracted values.
+      SubscriptionGroupInlined.new(uid,
+                                   scheme,
+                                   primary_subscription_id,
+                                   primary)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [SubscriptionGroupInlined | 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_item.rb

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