maxio-advanced-billing-sdk 0.0.3 → 0.0.4

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,83 @@
+# 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,76 @@
+# 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

data/lib/advanced_billing/models/revoked_invitation.rb

@@ -0,0 +1,72 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # RevokedInvitation Model.
+  class RevokedInvitation < 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 [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['uninvited_count'] = 'uninvited_count'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        last_sent_at
+        last_accepted_at
+        uninvited_count
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(last_sent_at = SKIP,
+                   last_accepted_at = 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
+      @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
+      uninvited_count =
+        hash.key?('uninvited_count') ? hash['uninvited_count'] : SKIP
+
+      # Create object from extracted values.
+      RevokedInvitation.new(last_sent_at,
+                            last_accepted_at,
+                            uninvited_count)
+    end
+  end
+end

data/lib/advanced_billing/models/sale_rep.rb

@@ -0,0 +1,100 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # SaleRep Model.
+  class SaleRep < 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 :full_name
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :subscriptions_count
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :test_mode
+
+    # TODO: Write general description for this method
+    # @return [Array[SaleRepSubscription]]
+    attr_accessor :subscriptions
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['full_name'] = 'full_name'
+      @_hash['subscriptions_count'] = 'subscriptions_count'
+      @_hash['test_mode'] = 'test_mode'
+      @_hash['subscriptions'] = 'subscriptions'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        full_name
+        subscriptions_count
+        test_mode
+        subscriptions
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = SKIP,
+                   full_name = SKIP,
+                   subscriptions_count = SKIP,
+                   test_mode = SKIP,
+                   subscriptions = SKIP)
+      @id = id unless id == SKIP
+      @full_name = full_name unless full_name == SKIP
+      @subscriptions_count = subscriptions_count unless subscriptions_count == SKIP
+      @test_mode = test_mode unless test_mode == SKIP
+      @subscriptions = subscriptions unless subscriptions == 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
+      full_name = hash.key?('full_name') ? hash['full_name'] : SKIP
+      subscriptions_count =
+        hash.key?('subscriptions_count') ? hash['subscriptions_count'] : SKIP
+      test_mode = hash.key?('test_mode') ? hash['test_mode'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      subscriptions = nil
+      unless hash['subscriptions'].nil?
+        subscriptions = []
+        hash['subscriptions'].each do |structure|
+          subscriptions << (SaleRepSubscription.from_hash(structure) if structure)
+        end
+      end
+
+      subscriptions = SKIP unless hash.key?('subscriptions')
+
+      # Create object from extracted values.
+      SaleRep.new(id,
+                  full_name,
+                  subscriptions_count,
+                  test_mode,
+                  subscriptions)
+    end
+  end
+end

data/lib/advanced_billing/models/sale_rep_item_mrr.rb

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