subtain-apimatic-sdk 4.1.1 → 9.1.1

data/lib/advanced_billing/models/reactivate_subscription_request.rb

@@ -0,0 +1,122 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # ReactivateSubscriptionRequest Model.
+  class ReactivateSubscriptionRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # These values are only applicable to subscriptions using calendar billing
+    # @return [ReactivationBilling]
+    attr_accessor :calendar_billing
+
+    # If `true` is sent, the reactivated Subscription will include a trial if
+    # one is available. If `false` is sent, the trial period will be ignored.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :include_trial
+
+    # If `true` is passed, the existing subscription balance will NOT be
+    # cleared/reset before adding the additional reactivation charges.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :preserve_balance
+
+    # The coupon code to be applied during reactivation.
+    # @return [String]
+    attr_accessor :coupon_code
+
+    # If true is sent, Chargify will use service credits and prepayments upon
+    # reactivation. If false is sent, the service credits and prepayments will
+    # be ignored.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :use_credits_and_prepayments
+
+    # If `true`, Chargify will attempt to resume the subscription's billing
+    # period. if not resumable, the subscription will be reactivated with a new
+    # billing period. If `false`: Chargify will only attempt to reactivate the
+    # subscription.
+    # @return [Object]
+    attr_accessor :resume
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['calendar_billing'] = 'calendar_billing'
+      @_hash['include_trial'] = 'include_trial'
+      @_hash['preserve_balance'] = 'preserve_balance'
+      @_hash['coupon_code'] = 'coupon_code'
+      @_hash['use_credits_and_prepayments'] = 'use_credits_and_prepayments'
+      @_hash['resume'] = 'resume'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        calendar_billing
+        include_trial
+        preserve_balance
+        coupon_code
+        use_credits_and_prepayments
+        resume
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(calendar_billing = SKIP, include_trial = SKIP,
+                   preserve_balance = SKIP, coupon_code = SKIP,
+                   use_credits_and_prepayments = SKIP, resume = SKIP)
+      @calendar_billing = calendar_billing unless calendar_billing == SKIP
+      @include_trial = include_trial unless include_trial == SKIP
+      @preserve_balance = preserve_balance unless preserve_balance == SKIP
+      @coupon_code = coupon_code unless coupon_code == SKIP
+      unless use_credits_and_prepayments == SKIP
+        @use_credits_and_prepayments =
+          use_credits_and_prepayments
+      end
+      @resume = resume unless resume == 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.
+      calendar_billing = ReactivationBilling.from_hash(hash['calendar_billing']) if
+        hash['calendar_billing']
+      include_trial = hash.key?('include_trial') ? hash['include_trial'] : SKIP
+      preserve_balance =
+        hash.key?('preserve_balance') ? hash['preserve_balance'] : SKIP
+      coupon_code = hash.key?('coupon_code') ? hash['coupon_code'] : SKIP
+      use_credits_and_prepayments =
+        hash.key?('use_credits_and_prepayments') ? hash['use_credits_and_prepayments'] : SKIP
+      resume = hash.key?('resume') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:ReactivateSubscriptionRequestResume), hash['resume']
+      ) : SKIP
+
+      # Create object from extracted values.
+      ReactivateSubscriptionRequest.new(calendar_billing,
+                                        include_trial,
+                                        preserve_balance,
+                                        coupon_code,
+                                        use_credits_and_prepayments,
+                                        resume)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [ReactivateSubscriptionRequest | 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/reactivation_billing.rb

@@ -0,0 +1,66 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # These values are only applicable to subscriptions using calendar billing
+  class ReactivationBilling < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # You may choose how to handle the reactivation charge for that
+    # subscription: 1) `prorated` A prorated charge for the product price will
+    # be attempted for to complete the period 2) `immediate` A full-price charge
+    # for the product price will be attempted immediately 3) `delayed` A
+    # full-price charge for the product price will be attempted at the next
+    # renewal
+    # @return [ReactivationCharge]
+    attr_accessor :reactivation_charge
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['reactivation_charge'] = 'reactivation_charge'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        reactivation_charge
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(reactivation_charge = ReactivationCharge::PRORATED)
+      @reactivation_charge = reactivation_charge unless reactivation_charge == 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.
+      reactivation_charge =
+        hash['reactivation_charge'] ||= ReactivationCharge::PRORATED
+
+      # Create object from extracted values.
+      ReactivationBilling.new(reactivation_charge)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [ReactivationBilling | 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/reactivation_charge.rb

@@ -0,0 +1,30 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # You may choose how to handle the reactivation charge for that subscription:
+  # 1) `prorated` A prorated charge for the product price will be attempted for
+  # to complete the period 2) `immediate` A full-price charge for the product
+  # price will be attempted immediately 3) `delayed` A full-price charge for the
+  # product price will be attempted at the next renewal
+  class ReactivationCharge
+    REACTIVATION_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?
+
+      REACTIVATION_CHARGE.include?(value)
+    end
+  end
+end

data/lib/advanced_billing/models/read_payment_profile_response.rb

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

data/lib/advanced_billing/models/reason_code.rb

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

data/lib/advanced_billing/models/reason_code_response.rb

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

data/lib/advanced_billing/models/reason_codes_json_response.rb

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

data/lib/advanced_billing/models/record_payment_request.rb

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

data/lib/advanced_billing/models/recurring_scheme.rb

@@ -0,0 +1,26 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Recurring Scheme.
+  class RecurringScheme
+    RECURRING_SCHEME = [
+      # TODO: Write general description for DO_NOT_RECUR
+      DO_NOT_RECUR = 'do_not_recur'.freeze,
+
+      # TODO: Write general description for RECUR_INDEFINITELY
+      RECUR_INDEFINITELY = 'recur_indefinitely'.freeze,
+
+      # TODO: Write general description for RECUR_WITH_DURATION
+      RECUR_WITH_DURATION = 'recur_with_duration'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      RECURRING_SCHEME.include?(value)
+    end
+  end
+end

data/lib/advanced_billing/models/referral_code.rb

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

data/lib/advanced_billing/models/referral_validation_response.rb

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