subtain-apimatic-sdk 4.1.1 → 9.1.2

data/lib/advanced_billing/models/subscription_note.rb

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

data/lib/advanced_billing/models/subscription_note_response.rb

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

data/lib/advanced_billing/models/subscription_preview.rb

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

data/lib/advanced_billing/models/subscription_preview_response.rb

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

data/lib/advanced_billing/models/subscription_product_change.rb

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

data/lib/advanced_billing/models/subscription_product_migration.rb

@@ -0,0 +1,148 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # SubscriptionProductMigration Model.
+  class SubscriptionProductMigration < 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
+
+    # 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
+    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
+      ]
+    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)
+      @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
+    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']
+
+      # Create object from extracted values.
+      SubscriptionProductMigration.new(product_id,
+                                       product_price_point_id,
+                                       include_trial,
+                                       include_initial_charge,
+                                       include_coupons,
+                                       preserve_period,
+                                       product_handle,
+                                       product_price_point_handle,
+                                       proration)
+    end
+  end
+end

data/lib/advanced_billing/models/subscription_product_migration_request.rb

@@ -0,0 +1,48 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # SubscriptionProductMigrationRequest Model.
+  class SubscriptionProductMigrationRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [SubscriptionProductMigration]
+    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 = SubscriptionProductMigration.from_hash(hash['migration']) if hash['migration']
+
+      # Create object from extracted values.
+      SubscriptionProductMigrationRequest.new(migration)
+    end
+  end
+end

data/lib/advanced_billing/models/subscription_purge_type.rb

@@ -0,0 +1,23 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Subscription Purge Type.
+  class SubscriptionPurgeType
+    SUBSCRIPTION_PURGE_TYPE = [
+      # TODO: Write general description for CUSTOMER
+      CUSTOMER = 'customer'.freeze,
+
+      # TODO: Write general description for PAYMENT_PROFILE
+      PAYMENT_PROFILE = 'payment_profile'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SUBSCRIPTION_PURGE_TYPE.include?(value)
+    end
+  end
+end

data/lib/advanced_billing/models/subscription_response.rb

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

data/lib/advanced_billing/models/subscription_sort.rb

@@ -0,0 +1,35 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Subscription Sort.
+  class SubscriptionSort
+    SUBSCRIPTION_SORT = [
+      # TODO: Write general description for SIGNUP_DATE
+      SIGNUP_DATE = 'signup_date'.freeze,
+
+      # TODO: Write general description for PERIOD_START
+      PERIOD_START = 'period_start'.freeze,
+
+      # TODO: Write general description for PERIOD_END
+      PERIOD_END = 'period_end'.freeze,
+
+      # TODO: Write general description for NEXT_ASSESSMENT
+      NEXT_ASSESSMENT = 'next_assessment'.freeze,
+
+      # TODO: Write general description for UPDATED_AT
+      UPDATED_AT = 'updated_at'.freeze,
+
+      # TODO: Write general description for CREATED_AT
+      CREATED_AT = 'created_at'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SUBSCRIPTION_SORT.include?(value)
+    end
+  end
+end

data/lib/advanced_billing/models/subscription_state.rb

@@ -0,0 +1,53 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Subscription State.
+  class SubscriptionState
+    SUBSCRIPTION_STATE = [
+      # TODO: Write general description for ACTIVE
+      ACTIVE = 'active'.freeze,
+
+      # TODO: Write general description for CANCELED
+      CANCELED = 'canceled'.freeze,
+
+      # TODO: Write general description for EXPIRED
+      EXPIRED = 'expired'.freeze,
+
+      # TODO: Write general description for EXPIRED_CARDS
+      EXPIRED_CARDS = 'expired_cards'.freeze,
+
+      # TODO: Write general description for ON_HOLD
+      ON_HOLD = 'on_hold'.freeze,
+
+      # TODO: Write general description for PAST_DUE
+      PAST_DUE = 'past_due'.freeze,
+
+      # TODO: Write general description for PENDING_CANCELLATION
+      PENDING_CANCELLATION = 'pending_cancellation'.freeze,
+
+      # TODO: Write general description for PENDING_RENEWAL
+      PENDING_RENEWAL = 'pending_renewal'.freeze,
+
+      # TODO: Write general description for SUSPENDED
+      SUSPENDED = 'suspended'.freeze,
+
+      # TODO: Write general description for TRIAL_ENDED
+      TRIAL_ENDED = 'trial_ended'.freeze,
+
+      # TODO: Write general description for TRIALING
+      TRIALING = 'trialing'.freeze,
+
+      # TODO: Write general description for UNPAID
+      UNPAID = 'unpaid'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SUBSCRIPTION_STATE.include?(value)
+    end
+  end
+end