subtain-apimatic-sdk 4.1.1 → 9.1.1

data/lib/advanced_billing/models/subscription_group_signup_response.rb

@@ -0,0 +1,167 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # SubscriptionGroupSignupResponse Model.
+  class SubscriptionGroupSignupResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :uid
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :scheme
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :customer_id
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :payment_profile_id
+
+    # TODO: Write general description for this method
+    # @return [Array[Integer]]
+    attr_accessor :subscription_ids
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :primary_subscription_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :next_assessment_at
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :state
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :cancel_at_end_of_period
+
+    # TODO: Write general description for this method
+    # @return [Array[SubscriptionGroupItem]]
+    attr_accessor :subscriptions
+
+    # The type of payment collection to be used in the subscription. For legacy
+    # Statements Architecture valid options are - `invoice`, `automatic`. For
+    # current Relationship Invoicing Architecture valid options are -
+    # `remittance`, `automatic`, `prepaid`.
+    # @return [PaymentCollectionMethod]
+    attr_accessor :payment_collection_method
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['uid'] = 'uid'
+      @_hash['scheme'] = 'scheme'
+      @_hash['customer_id'] = 'customer_id'
+      @_hash['payment_profile_id'] = 'payment_profile_id'
+      @_hash['subscription_ids'] = 'subscription_ids'
+      @_hash['primary_subscription_id'] = 'primary_subscription_id'
+      @_hash['next_assessment_at'] = 'next_assessment_at'
+      @_hash['state'] = 'state'
+      @_hash['cancel_at_end_of_period'] = 'cancel_at_end_of_period'
+      @_hash['subscriptions'] = 'subscriptions'
+      @_hash['payment_collection_method'] = 'payment_collection_method'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        uid
+        scheme
+        customer_id
+        payment_profile_id
+        subscription_ids
+        primary_subscription_id
+        next_assessment_at
+        state
+        cancel_at_end_of_period
+        subscriptions
+        payment_collection_method
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(
+      uid = SKIP, scheme = SKIP, customer_id = SKIP, payment_profile_id = SKIP,
+      subscription_ids = SKIP, primary_subscription_id = SKIP,
+      next_assessment_at = SKIP, state = SKIP, cancel_at_end_of_period = SKIP,
+      subscriptions = SKIP,
+      payment_collection_method = PaymentCollectionMethod::AUTOMATIC
+    )
+      @uid = uid unless uid == SKIP
+      @scheme = scheme unless scheme == SKIP
+      @customer_id = customer_id unless customer_id == SKIP
+      @payment_profile_id = payment_profile_id unless payment_profile_id == SKIP
+      @subscription_ids = subscription_ids unless subscription_ids == SKIP
+      @primary_subscription_id = primary_subscription_id unless primary_subscription_id == SKIP
+      @next_assessment_at = next_assessment_at unless next_assessment_at == SKIP
+      @state = state unless state == SKIP
+      @cancel_at_end_of_period = cancel_at_end_of_period unless cancel_at_end_of_period == SKIP
+      @subscriptions = subscriptions unless subscriptions == SKIP
+      unless payment_collection_method == SKIP
+        @payment_collection_method =
+          payment_collection_method
+      end
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      uid = hash.key?('uid') ? hash['uid'] : SKIP
+      scheme = hash.key?('scheme') ? hash['scheme'] : SKIP
+      customer_id = hash.key?('customer_id') ? hash['customer_id'] : SKIP
+      payment_profile_id =
+        hash.key?('payment_profile_id') ? hash['payment_profile_id'] : SKIP
+      subscription_ids =
+        hash.key?('subscription_ids') ? hash['subscription_ids'] : SKIP
+      primary_subscription_id =
+        hash.key?('primary_subscription_id') ? hash['primary_subscription_id'] : SKIP
+      next_assessment_at =
+        hash.key?('next_assessment_at') ? hash['next_assessment_at'] : SKIP
+      state = hash.key?('state') ? hash['state'] : SKIP
+      cancel_at_end_of_period =
+        hash.key?('cancel_at_end_of_period') ? hash['cancel_at_end_of_period'] : 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 << (SubscriptionGroupItem.from_hash(structure) if structure)
+        end
+      end
+
+      subscriptions = SKIP unless hash.key?('subscriptions')
+      payment_collection_method =
+        hash['payment_collection_method'] ||= PaymentCollectionMethod::AUTOMATIC
+
+      # Create object from extracted values.
+      SubscriptionGroupSignupResponse.new(uid,
+                                          scheme,
+                                          customer_id,
+                                          payment_profile_id,
+                                          subscription_ids,
+                                          primary_subscription_id,
+                                          next_assessment_at,
+                                          state,
+                                          cancel_at_end_of_period,
+                                          subscriptions,
+                                          payment_collection_method)
+    end
+  end
+end

data/lib/advanced_billing/models/subscription_group_signup_success.rb

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

data/lib/advanced_billing/models/subscription_group_signup_success_data.rb

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

data/lib/advanced_billing/models/subscription_group_subscription_error.rb

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

data/lib/advanced_billing/models/subscription_group_update_error.rb

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

data/lib/advanced_billing/models/subscription_include.rb

@@ -0,0 +1,23 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Subscription Include.
+  class SubscriptionInclude
+    SUBSCRIPTION_INCLUDE = [
+      # TODO: Write general description for COUPONS
+      COUPONS = 'coupons'.freeze,
+
+      # TODO: Write general description for SELF_SERVICE_PAGE_TOKEN
+      SELF_SERVICE_PAGE_TOKEN = 'self_service_page_token'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SUBSCRIPTION_INCLUDE.include?(value)
+    end
+  end
+end