subtain-apimatic-sdk 4.1.1 → 9.1.1

data/lib/advanced_billing/models/subscription_included_coupon.rb

@@ -0,0 +1,121 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # SubscriptionIncludedCoupon Model.
+  class SubscriptionIncludedCoupon < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :code
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :use_count
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :uses_allowed
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :expires_at
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :recurring
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :amount_in_cents
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :percentage
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['code'] = 'code'
+      @_hash['use_count'] = 'use_count'
+      @_hash['uses_allowed'] = 'uses_allowed'
+      @_hash['expires_at'] = 'expires_at'
+      @_hash['recurring'] = 'recurring'
+      @_hash['amount_in_cents'] = 'amount_in_cents'
+      @_hash['percentage'] = 'percentage'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        code
+        use_count
+        uses_allowed
+        expires_at
+        recurring
+        amount_in_cents
+        percentage
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        expires_at
+        amount_in_cents
+        percentage
+      ]
+    end
+
+    def initialize(code = SKIP, use_count = SKIP, uses_allowed = SKIP,
+                   expires_at = SKIP, recurring = SKIP, amount_in_cents = SKIP,
+                   percentage = SKIP)
+      @code = code unless code == SKIP
+      @use_count = use_count unless use_count == SKIP
+      @uses_allowed = uses_allowed unless uses_allowed == SKIP
+      @expires_at = expires_at unless expires_at == SKIP
+      @recurring = recurring unless recurring == SKIP
+      @amount_in_cents = amount_in_cents unless amount_in_cents == SKIP
+      @percentage = percentage unless percentage == 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.
+      code = hash.key?('code') ? hash['code'] : SKIP
+      use_count = hash.key?('use_count') ? hash['use_count'] : SKIP
+      uses_allowed = hash.key?('uses_allowed') ? hash['uses_allowed'] : SKIP
+      expires_at = hash.key?('expires_at') ? hash['expires_at'] : SKIP
+      recurring = hash.key?('recurring') ? hash['recurring'] : SKIP
+      amount_in_cents =
+        hash.key?('amount_in_cents') ? hash['amount_in_cents'] : SKIP
+      percentage = hash.key?('percentage') ? hash['percentage'] : SKIP
+
+      # Create object from extracted values.
+      SubscriptionIncludedCoupon.new(code,
+                                     use_count,
+                                     uses_allowed,
+                                     expires_at,
+                                     recurring,
+                                     amount_in_cents,
+                                     percentage)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [SubscriptionIncludedCoupon | 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_list_date_field.rb

@@ -0,0 +1,20 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Subscription List Date Field.
+  class SubscriptionListDateField
+    SUBSCRIPTION_LIST_DATE_FIELD = [
+      # TODO: Write general description for UPDATED_AT
+      UPDATED_AT = 'updated_at'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SUBSCRIPTION_LIST_DATE_FIELD.include?(value)
+    end
+  end
+end

data/lib/advanced_billing/models/subscription_migration_preview.rb

@@ -0,0 +1,88 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # SubscriptionMigrationPreview Model.
+  class SubscriptionMigrationPreview < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The amount of the prorated adjustment that would be issued for the current
+    # subscription.
+    # @return [Integer]
+    attr_accessor :prorated_adjustment_in_cents
+
+    # The amount of the charge that would be created for the new product.
+    # @return [Integer]
+    attr_accessor :charge_in_cents
+
+    # The amount of the payment due in the case of an upgrade.
+    # @return [Integer]
+    attr_accessor :payment_due_in_cents
+
+    # Represents a credit in cents that is applied to your subscription as part
+    # of a migration process for a specific product, which reduces the amount
+    # owed for the subscription.
+    # @return [Integer]
+    attr_accessor :credit_applied_in_cents
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['prorated_adjustment_in_cents'] = 'prorated_adjustment_in_cents'
+      @_hash['charge_in_cents'] = 'charge_in_cents'
+      @_hash['payment_due_in_cents'] = 'payment_due_in_cents'
+      @_hash['credit_applied_in_cents'] = 'credit_applied_in_cents'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        prorated_adjustment_in_cents
+        charge_in_cents
+        payment_due_in_cents
+        credit_applied_in_cents
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(prorated_adjustment_in_cents = SKIP, charge_in_cents = SKIP,
+                   payment_due_in_cents = SKIP, credit_applied_in_cents = SKIP)
+      unless prorated_adjustment_in_cents == SKIP
+        @prorated_adjustment_in_cents =
+          prorated_adjustment_in_cents
+      end
+      @charge_in_cents = charge_in_cents unless charge_in_cents == SKIP
+      @payment_due_in_cents = payment_due_in_cents unless payment_due_in_cents == SKIP
+      @credit_applied_in_cents = credit_applied_in_cents unless credit_applied_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.
+      prorated_adjustment_in_cents =
+        hash.key?('prorated_adjustment_in_cents') ? hash['prorated_adjustment_in_cents'] : SKIP
+      charge_in_cents =
+        hash.key?('charge_in_cents') ? hash['charge_in_cents'] : SKIP
+      payment_due_in_cents =
+        hash.key?('payment_due_in_cents') ? hash['payment_due_in_cents'] : SKIP
+      credit_applied_in_cents =
+        hash.key?('credit_applied_in_cents') ? hash['credit_applied_in_cents'] : SKIP
+
+      # Create object from extracted values.
+      SubscriptionMigrationPreview.new(prorated_adjustment_in_cents,
+                                       charge_in_cents,
+                                       payment_due_in_cents,
+                                       credit_applied_in_cents)
+    end
+  end
+end

data/lib/advanced_billing/models/subscription_migration_preview_options.rb

@@ -0,0 +1,158 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # SubscriptionMigrationPreviewOptions Model.
+  class SubscriptionMigrationPreviewOptions < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The ID of the target Product. Either a product_id or product_handle must
+    # be present. A Subscription can be migrated to another product for both the
+    # current Product Family and another Product Family. Note: Going to another
+    # Product Family, components will not be migrated as well.
+    # @return [Integer]
+    attr_accessor :product_id
+
+    # The ID of the specified product's price point. This can be passed to
+    # migrate to a non-default price point.
+    # @return [Integer]
+    attr_accessor :product_price_point_id
+
+    # Whether to include the trial period configured for the product price point
+    # when starting a new billing period. Note that if preserve_period is set,
+    # then include_trial will be ignored.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :include_trial
+
+    # If `true` is sent initial charges will be assessed.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :include_initial_charge
+
+    # If `true` is sent, any coupons associated with the subscription will be
+    # applied to the migration. If `false` is sent, coupons will not be applied.
+    # Note: When migrating to a new product family, the coupon cannot migrate.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :include_coupons
+
+    # If `false` is sent, the subscription's billing period will be reset to
+    # today and the full price of the new product will be charged. If `true` is
+    # sent, the billing period will not change and a prorated charge will be
+    # issued for the new product.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :preserve_period
+
+    # The handle of the target Product. Either a product_id or product_handle
+    # must be present. A Subscription can be migrated to another product for
+    # both the current Product Family and another Product Family. Note: Going to
+    # another Product Family, components will not be migrated as well.
+    # @return [String]
+    attr_accessor :product_handle
+
+    # The ID or handle of the specified product's price point. This can be
+    # passed to migrate to a non-default price point.
+    # @return [String]
+    attr_accessor :product_price_point_handle
+
+    # The ID or handle of the specified product's price point. This can be
+    # passed to migrate to a non-default price point.
+    # @return [Proration]
+    attr_accessor :proration
+
+    # The date that the proration is calculated from for the preview
+    # @return [String]
+    attr_accessor :proration_date
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['product_id'] = 'product_id'
+      @_hash['product_price_point_id'] = 'product_price_point_id'
+      @_hash['include_trial'] = 'include_trial'
+      @_hash['include_initial_charge'] = 'include_initial_charge'
+      @_hash['include_coupons'] = 'include_coupons'
+      @_hash['preserve_period'] = 'preserve_period'
+      @_hash['product_handle'] = 'product_handle'
+      @_hash['product_price_point_handle'] = 'product_price_point_handle'
+      @_hash['proration'] = 'proration'
+      @_hash['proration_date'] = 'proration_date'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        product_id
+        product_price_point_id
+        include_trial
+        include_initial_charge
+        include_coupons
+        preserve_period
+        product_handle
+        product_price_point_handle
+        proration
+        proration_date
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(product_id = SKIP, product_price_point_id = SKIP,
+                   include_trial = false, include_initial_charge = false,
+                   include_coupons = true, preserve_period = false,
+                   product_handle = SKIP, product_price_point_handle = SKIP,
+                   proration = SKIP, proration_date = SKIP)
+      @product_id = product_id unless product_id == SKIP
+      @product_price_point_id = product_price_point_id unless product_price_point_id == SKIP
+      @include_trial = include_trial unless include_trial == SKIP
+      @include_initial_charge = include_initial_charge unless include_initial_charge == SKIP
+      @include_coupons = include_coupons unless include_coupons == SKIP
+      @preserve_period = preserve_period unless preserve_period == SKIP
+      @product_handle = product_handle unless product_handle == SKIP
+      unless product_price_point_handle == SKIP
+        @product_price_point_handle =
+          product_price_point_handle
+      end
+      @proration = proration unless proration == SKIP
+      @proration_date = proration_date unless proration_date == 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.
+      product_id = hash.key?('product_id') ? hash['product_id'] : SKIP
+      product_price_point_id =
+        hash.key?('product_price_point_id') ? hash['product_price_point_id'] : SKIP
+      include_trial = hash['include_trial'] ||= false
+      include_initial_charge = hash['include_initial_charge'] ||= false
+      include_coupons = hash['include_coupons'] ||= true
+      preserve_period = hash['preserve_period'] ||= false
+      product_handle =
+        hash.key?('product_handle') ? hash['product_handle'] : SKIP
+      product_price_point_handle =
+        hash.key?('product_price_point_handle') ? hash['product_price_point_handle'] : SKIP
+      proration = Proration.from_hash(hash['proration']) if hash['proration']
+      proration_date =
+        hash.key?('proration_date') ? hash['proration_date'] : SKIP
+
+      # Create object from extracted values.
+      SubscriptionMigrationPreviewOptions.new(product_id,
+                                              product_price_point_id,
+                                              include_trial,
+                                              include_initial_charge,
+                                              include_coupons,
+                                              preserve_period,
+                                              product_handle,
+                                              product_price_point_handle,
+                                              proration,
+                                              proration_date)
+    end
+  end
+end

data/lib/advanced_billing/models/subscription_migration_preview_request.rb

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

data/lib/advanced_billing/models/subscription_migration_preview_response.rb

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

data/lib/advanced_billing/models/subscription_mrr.rb

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

data/lib/advanced_billing/models/subscription_mrr_breakout.rb

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

data/lib/advanced_billing/models/subscription_mrr_response.rb

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