subtain-apimatic-sdk 4.1.1 → 9.1.2

data/lib/advanced_billing/models/renewal_preview_component.rb

@@ -0,0 +1,91 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # RenewalPreviewComponent Model.
+  class RenewalPreviewComponent < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Either the component's Chargify id or its handle prefixed with `handle:`
+    # @return [Object]
+    attr_accessor :component_id
+
+    # The quantity for which you wish to preview billing. This is useful if you
+    # want to preview a predicted, higher usage value than is currently present
+    # on the subscription.
+    # This quantity represents:
+    # - Whether or not an on/off component is enabled - use 0 for disabled or 1
+    # for enabled
+    # - The desired allocated_quantity for a quantity-based component
+    # - The desired unit_balance for a metered component
+    # - The desired metric quantity for an events-based component
+    # @return [Integer]
+    attr_accessor :quantity
+
+    # Either the component price point's Chargify id or its handle prefixed with
+    # `handle:`
+    # @return [Object]
+    attr_accessor :price_point_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['component_id'] = 'component_id'
+      @_hash['quantity'] = 'quantity'
+      @_hash['price_point_id'] = 'price_point_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        component_id
+        quantity
+        price_point_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(component_id = SKIP, quantity = SKIP, price_point_id = SKIP)
+      @component_id = component_id unless component_id == SKIP
+      @quantity = quantity unless quantity == SKIP
+      @price_point_id = price_point_id unless price_point_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.
+      component_id = hash.key?('component_id') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:RenewalPreviewComponentComponentId), hash['component_id']
+      ) : SKIP
+      quantity = hash.key?('quantity') ? hash['quantity'] : SKIP
+      price_point_id = hash.key?('price_point_id') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:RenewalPreviewComponentPricePointId), hash['price_point_id']
+      ) : SKIP
+
+      # Create object from extracted values.
+      RenewalPreviewComponent.new(component_id,
+                                  quantity,
+                                  price_point_id)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [RenewalPreviewComponent | 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/renewal_preview_line_item.rb

@@ -0,0 +1,161 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # RenewalPreviewLineItem Model.
+  class RenewalPreviewLineItem < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :transaction_type
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :kind
+
+    # 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 :memo
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :discount_amount_in_cents
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :taxable_amount_in_cents
+
+    # 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_name
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :component_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :component_handle
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :component_name
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :product_handle
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['transaction_type'] = 'transaction_type'
+      @_hash['kind'] = 'kind'
+      @_hash['amount_in_cents'] = 'amount_in_cents'
+      @_hash['memo'] = 'memo'
+      @_hash['discount_amount_in_cents'] = 'discount_amount_in_cents'
+      @_hash['taxable_amount_in_cents'] = 'taxable_amount_in_cents'
+      @_hash['product_id'] = 'product_id'
+      @_hash['product_name'] = 'product_name'
+      @_hash['component_id'] = 'component_id'
+      @_hash['component_handle'] = 'component_handle'
+      @_hash['component_name'] = 'component_name'
+      @_hash['product_handle'] = 'product_handle'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        transaction_type
+        kind
+        amount_in_cents
+        memo
+        discount_amount_in_cents
+        taxable_amount_in_cents
+        product_id
+        product_name
+        component_id
+        component_handle
+        component_name
+        product_handle
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(transaction_type = SKIP, kind = SKIP, amount_in_cents = SKIP,
+                   memo = SKIP, discount_amount_in_cents = SKIP,
+                   taxable_amount_in_cents = SKIP, product_id = SKIP,
+                   product_name = SKIP, component_id = SKIP,
+                   component_handle = SKIP, component_name = SKIP,
+                   product_handle = SKIP)
+      @transaction_type = transaction_type unless transaction_type == SKIP
+      @kind = kind unless kind == SKIP
+      @amount_in_cents = amount_in_cents unless amount_in_cents == SKIP
+      @memo = memo unless memo == SKIP
+      @discount_amount_in_cents = discount_amount_in_cents unless discount_amount_in_cents == SKIP
+      @taxable_amount_in_cents = taxable_amount_in_cents unless taxable_amount_in_cents == SKIP
+      @product_id = product_id unless product_id == SKIP
+      @product_name = product_name unless product_name == SKIP
+      @component_id = component_id unless component_id == SKIP
+      @component_handle = component_handle unless component_handle == SKIP
+      @component_name = component_name unless component_name == SKIP
+      @product_handle = product_handle unless product_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.
+      transaction_type =
+        hash.key?('transaction_type') ? hash['transaction_type'] : SKIP
+      kind = hash.key?('kind') ? hash['kind'] : SKIP
+      amount_in_cents =
+        hash.key?('amount_in_cents') ? hash['amount_in_cents'] : SKIP
+      memo = hash.key?('memo') ? hash['memo'] : SKIP
+      discount_amount_in_cents =
+        hash.key?('discount_amount_in_cents') ? hash['discount_amount_in_cents'] : SKIP
+      taxable_amount_in_cents =
+        hash.key?('taxable_amount_in_cents') ? hash['taxable_amount_in_cents'] : SKIP
+      product_id = hash.key?('product_id') ? hash['product_id'] : SKIP
+      product_name = hash.key?('product_name') ? hash['product_name'] : SKIP
+      component_id = hash.key?('component_id') ? hash['component_id'] : SKIP
+      component_handle =
+        hash.key?('component_handle') ? hash['component_handle'] : SKIP
+      component_name =
+        hash.key?('component_name') ? hash['component_name'] : SKIP
+      product_handle =
+        hash.key?('product_handle') ? hash['product_handle'] : SKIP
+
+      # Create object from extracted values.
+      RenewalPreviewLineItem.new(transaction_type,
+                                 kind,
+                                 amount_in_cents,
+                                 memo,
+                                 discount_amount_in_cents,
+                                 taxable_amount_in_cents,
+                                 product_id,
+                                 product_name,
+                                 component_id,
+                                 component_handle,
+                                 component_name,
+                                 product_handle)
+    end
+  end
+end

data/lib/advanced_billing/models/renewal_preview_request.rb

@@ -0,0 +1,62 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # RenewalPreviewRequest Model.
+  class RenewalPreviewRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # An optional array of component definitions to preview. Providing any
+    # component definitions here will override the actual components on the
+    # subscription (and their quantities), and the billing preview will contain
+    # only these components (in addition to any product base fees).
+    # @return [Array[RenewalPreviewComponent]]
+    attr_accessor :components
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['components'] = 'components'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        components
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(components = SKIP)
+      @components = components unless components == 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.
+      # Parameter is an array, so we need to iterate through it
+      components = nil
+      unless hash['components'].nil?
+        components = []
+        hash['components'].each do |structure|
+          components << (RenewalPreviewComponent.from_hash(structure) if structure)
+        end
+      end
+
+      components = SKIP unless hash.key?('components')
+
+      # Create object from extracted values.
+      RenewalPreviewRequest.new(components)
+    end
+  end
+end

data/lib/advanced_billing/models/renewal_preview_response.rb

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

data/lib/advanced_billing/models/replay_webhooks_request.rb

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

data/lib/advanced_billing/models/replay_webhooks_response.rb

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

data/lib/advanced_billing/models/resent_invitation.rb

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

data/lib/advanced_billing/models/resource_type.rb

@@ -0,0 +1,23 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Resource Type.
+  class ResourceType
+    RESOURCE_TYPE = [
+      # TODO: Write general description for SUBSCRIPTIONS
+      SUBSCRIPTIONS = 'subscriptions'.freeze,
+
+      # TODO: Write general description for CUSTOMERS
+      CUSTOMERS = 'customers'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      RESOURCE_TYPE.include?(value)
+    end
+  end
+end

data/lib/advanced_billing/models/restriction_type.rb

@@ -0,0 +1,23 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Restriction Type.
+  class RestrictionType
+    RESTRICTION_TYPE = [
+      # TODO: Write general description for COMPONENT
+      COMPONENT = 'Component'.freeze,
+
+      # TODO: Write general description for PRODUCT
+      PRODUCT = 'Product'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      RESTRICTION_TYPE.include?(value)
+    end
+  end
+end

data/lib/advanced_billing/models/resume_options.rb

@@ -0,0 +1,75 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # ResumeOptions Model.
+  class ResumeOptions < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Chargify will only attempt to resume the subscription's billing period. If
+    # not resumable, the subscription will be left in it's current state.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :require_resume
+
+    # Indicates whether or not Chargify should clear the subscription's existing
+    # balance before attempting to resume the subscription. If subscription
+    # cannot be resumed, the balance will remain as it was before the attempt to
+    # resume was made.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :forgive_balance
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['require_resume'] = 'require_resume'
+      @_hash['forgive_balance'] = 'forgive_balance'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        require_resume
+        forgive_balance
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(require_resume = SKIP, forgive_balance = SKIP)
+      @require_resume = require_resume unless require_resume == SKIP
+      @forgive_balance = forgive_balance unless forgive_balance == 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.
+      require_resume =
+        hash.key?('require_resume') ? hash['require_resume'] : SKIP
+      forgive_balance =
+        hash.key?('forgive_balance') ? hash['forgive_balance'] : SKIP
+
+      # Create object from extracted values.
+      ResumeOptions.new(require_resume,
+                        forgive_balance)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [ResumeOptions | 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/resumption_charge.rb

@@ -0,0 +1,27 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # (For calendar billing subscriptions only) The way that the resumed
+  # subscription's charge should be handled
+  class ResumptionCharge
+    RESUMPTION_CHARGE = [
+      # TODO: Write general description for PRORATED
+      PRORATED = 'prorated'.freeze,
+
+      # TODO: Write general description for IMMEDIATE
+      IMMEDIATE = 'immediate'.freeze,
+
+      # TODO: Write general description for DELAYED
+      DELAYED = 'delayed'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      RESUMPTION_CHARGE.include?(value)
+    end
+  end
+end