subtain-apimatic-sdk 4.1.1 → 9.1.1

data/lib/advanced_billing/models/subscription_group_signup_component.rb

@@ -0,0 +1,108 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # SubscriptionGroupSignupComponent Model.
+  class SubscriptionGroupSignupComponent < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Required if passing any component to `components` attribute.
+    # @return [Object]
+    attr_accessor :component_id
+
+    # Required if passing any component to `components` attribute.
+    # @return [Object]
+    attr_accessor :allocated_quantity
+
+    # Required if passing any component to `components` attribute.
+    # @return [Object]
+    attr_accessor :unit_balance
+
+    # Required if passing any component to `components` attribute.
+    # @return [Object]
+    attr_accessor :price_point_id
+
+    # Used in place of `price_point_id` to define a custom price point unique to
+    # the subscription. You still need to provide `component_id`.
+    # @return [SubscriptionGroupComponentCustomPrice]
+    attr_accessor :custom_price
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['component_id'] = 'component_id'
+      @_hash['allocated_quantity'] = 'allocated_quantity'
+      @_hash['unit_balance'] = 'unit_balance'
+      @_hash['price_point_id'] = 'price_point_id'
+      @_hash['custom_price'] = 'custom_price'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        component_id
+        allocated_quantity
+        unit_balance
+        price_point_id
+        custom_price
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(component_id = SKIP, allocated_quantity = SKIP,
+                   unit_balance = SKIP, price_point_id = SKIP,
+                   custom_price = SKIP)
+      @component_id = component_id unless component_id == SKIP
+      @allocated_quantity = allocated_quantity unless allocated_quantity == SKIP
+      @unit_balance = unit_balance unless unit_balance == SKIP
+      @price_point_id = price_point_id unless price_point_id == SKIP
+      @custom_price = custom_price unless custom_price == 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(:SubscriptionGroupSignupComponentComponentId), hash['component_id']
+      ) : SKIP
+      allocated_quantity = hash.key?('allocated_quantity') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:SubscriptionGroupSignupComponentAllocatedQuantity), hash['allocated_quantity']
+      ) : SKIP
+      unit_balance = hash.key?('unit_balance') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:SubscriptionGroupSignupComponentUnitBalance), hash['unit_balance']
+      ) : SKIP
+      price_point_id = hash.key?('price_point_id') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:SubscriptionGroupSignupComponentPricePointId), hash['price_point_id']
+      ) : SKIP
+      custom_price = SubscriptionGroupComponentCustomPrice.from_hash(hash['custom_price']) if
+        hash['custom_price']
+
+      # Create object from extracted values.
+      SubscriptionGroupSignupComponent.new(component_id,
+                                           allocated_quantity,
+                                           unit_balance,
+                                           price_point_id,
+                                           custom_price)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [SubscriptionGroupSignupComponent | 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/subscription_group_signup_error.rb

@@ -0,0 +1,109 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # SubscriptionGroupSignupError Model.
+  class SubscriptionGroupSignupError < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Object that as key have subscription position in request subscriptions
+    # array and as value subscription errors object.
+    # @return [Hash[String, SubscriptionGroupSubscriptionError]]
+    attr_accessor :subscriptions
+
+    # Object that as key have subscription position in request subscriptions
+    # array and as value subscription errors object.
+    # @return [String]
+    attr_accessor :payer_reference
+
+    # Object that as key have subscription position in request subscriptions
+    # array and as value subscription errors object.
+    # @return [PayerError]
+    attr_accessor :payer
+
+    # Object that as key have subscription position in request subscriptions
+    # array and as value subscription errors object.
+    # @return [Array[String]]
+    attr_accessor :subscription_group
+
+    # Object that as key have subscription position in request subscriptions
+    # array and as value subscription errors object.
+    # @return [String]
+    attr_accessor :payment_profile_id
+
+    # Object that as key have subscription position in request subscriptions
+    # array and as value subscription errors object.
+    # @return [String]
+    attr_accessor :payer_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['subscriptions'] = 'subscriptions'
+      @_hash['payer_reference'] = 'payer_reference'
+      @_hash['payer'] = 'payer'
+      @_hash['subscription_group'] = 'subscription_group'
+      @_hash['payment_profile_id'] = 'payment_profile_id'
+      @_hash['payer_id'] = 'payer_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        subscriptions
+        payer_reference
+        payer
+        subscription_group
+        payment_profile_id
+        payer_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(subscriptions = SKIP, payer_reference = SKIP, payer = SKIP,
+                   subscription_group = SKIP, payment_profile_id = SKIP,
+                   payer_id = SKIP)
+      @subscriptions = subscriptions unless subscriptions == SKIP
+      @payer_reference = payer_reference unless payer_reference == SKIP
+      @payer = payer unless payer == SKIP
+      @subscription_group = subscription_group unless subscription_group == SKIP
+      @payment_profile_id = payment_profile_id unless payment_profile_id == SKIP
+      @payer_id = payer_id unless payer_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.
+      subscriptions = SubscriptionGroupSubscriptionError.from_hash(hash['subscriptions']) if
+        hash['subscriptions']
+
+      subscriptions = SKIP unless hash.key?('subscriptions')
+      payer_reference =
+        hash.key?('payer_reference') ? hash['payer_reference'] : SKIP
+      payer = PayerError.from_hash(hash['payer']) if hash['payer']
+      subscription_group =
+        hash.key?('subscription_group') ? hash['subscription_group'] : SKIP
+      payment_profile_id =
+        hash.key?('payment_profile_id') ? hash['payment_profile_id'] : SKIP
+      payer_id = hash.key?('payer_id') ? hash['payer_id'] : SKIP
+
+      # Create object from extracted values.
+      SubscriptionGroupSignupError.new(subscriptions,
+                                       payer_reference,
+                                       payer,
+                                       subscription_group,
+                                       payment_profile_id,
+                                       payer_id)
+    end
+  end
+end

data/lib/advanced_billing/models/subscription_group_signup_failure.rb

@@ -0,0 +1,84 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # SubscriptionGroupSignupFailure Model.
+  class SubscriptionGroupSignupFailure < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [SubscriptionGroupSignupFailureData]
+    attr_accessor :subscription_group
+
+    # TODO: Write general description for this method
+    # @return [String]
+    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
+      %w[
+        customer
+      ]
+    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 = SubscriptionGroupSignupFailureData.from_hash(hash['subscription_group'])
+      end
+      customer = hash.key?('customer') ? hash['customer'] : nil
+
+      # Create object from extracted values.
+      SubscriptionGroupSignupFailure.new(subscription_group,
+                                         customer)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [SubscriptionGroupSignupFailure | 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) { SubscriptionGroupSignupFailureData.validate(val) },
+                                is_model_hash: true) and
+            APIHelper.valid_type?(value.customer,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['subscription_group'],
+                              ->(val) { SubscriptionGroupSignupFailureData.validate(val) },
+                              is_model_hash: true) and
+          APIHelper.valid_type?(value['customer'],
+                                ->(val) { val.instance_of? String })
+      )
+    end
+  end
+end

data/lib/advanced_billing/models/subscription_group_signup_failure_data.rb

@@ -0,0 +1,146 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # SubscriptionGroupSignupFailureData Model.
+  class SubscriptionGroupSignupFailureData < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :payer_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :payer_reference
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :payment_profile_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :payment_collection_method
+
+    # TODO: Write general description for this method
+    # @return [PayerAttributes]
+    attr_accessor :payer_attributes
+
+    # TODO: Write general description for this method
+    # @return [SubscriptionGroupCreditCard]
+    attr_accessor :credit_card_attributes
+
+    # TODO: Write general description for this method
+    # @return [SubscriptionGroupBankAccount]
+    attr_accessor :bank_account_attributes
+
+    # TODO: Write general description for this method
+    # @return [Array[SubscriptionGroupSignupItem]]
+    attr_accessor :subscriptions
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['payer_id'] = 'payer_id'
+      @_hash['payer_reference'] = 'payer_reference'
+      @_hash['payment_profile_id'] = 'payment_profile_id'
+      @_hash['payment_collection_method'] = 'payment_collection_method'
+      @_hash['payer_attributes'] = 'payer_attributes'
+      @_hash['credit_card_attributes'] = 'credit_card_attributes'
+      @_hash['bank_account_attributes'] = 'bank_account_attributes'
+      @_hash['subscriptions'] = 'subscriptions'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        payer_id
+        payer_reference
+        payment_profile_id
+        payment_collection_method
+        payer_attributes
+        credit_card_attributes
+        bank_account_attributes
+        subscriptions
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(payer_id = SKIP, payer_reference = SKIP,
+                   payment_profile_id = SKIP, payment_collection_method = SKIP,
+                   payer_attributes = SKIP, credit_card_attributes = SKIP,
+                   bank_account_attributes = SKIP, subscriptions = SKIP)
+      @payer_id = payer_id unless payer_id == SKIP
+      @payer_reference = payer_reference unless payer_reference == SKIP
+      @payment_profile_id = payment_profile_id unless payment_profile_id == SKIP
+      unless payment_collection_method == SKIP
+        @payment_collection_method =
+          payment_collection_method
+      end
+      @payer_attributes = payer_attributes unless payer_attributes == SKIP
+      @credit_card_attributes = credit_card_attributes unless credit_card_attributes == SKIP
+      @bank_account_attributes = bank_account_attributes unless bank_account_attributes == 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.
+      payer_id = hash.key?('payer_id') ? hash['payer_id'] : SKIP
+      payer_reference =
+        hash.key?('payer_reference') ? hash['payer_reference'] : SKIP
+      payment_profile_id =
+        hash.key?('payment_profile_id') ? hash['payment_profile_id'] : SKIP
+      payment_collection_method =
+        hash.key?('payment_collection_method') ? hash['payment_collection_method'] : SKIP
+      payer_attributes = PayerAttributes.from_hash(hash['payer_attributes']) if
+        hash['payer_attributes']
+      if hash['credit_card_attributes']
+        credit_card_attributes = SubscriptionGroupCreditCard.from_hash(hash['credit_card_attributes'])
+      end
+      if hash['bank_account_attributes']
+        bank_account_attributes = SubscriptionGroupBankAccount.from_hash(hash['bank_account_attributes'])
+      end
+      # Parameter is an array, so we need to iterate through it
+      subscriptions = nil
+      unless hash['subscriptions'].nil?
+        subscriptions = []
+        hash['subscriptions'].each do |structure|
+          subscriptions << (SubscriptionGroupSignupItem.from_hash(structure) if structure)
+        end
+      end
+
+      subscriptions = SKIP unless hash.key?('subscriptions')
+
+      # Create object from extracted values.
+      SubscriptionGroupSignupFailureData.new(payer_id,
+                                             payer_reference,
+                                             payment_profile_id,
+                                             payment_collection_method,
+                                             payer_attributes,
+                                             credit_card_attributes,
+                                             bank_account_attributes,
+                                             subscriptions)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [SubscriptionGroupSignupFailureData | 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/subscription_group_signup_item.rb

@@ -0,0 +1,200 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # SubscriptionGroupSignupItem Model.
+  class SubscriptionGroupSignupItem < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The API Handle of the product for which you are creating a subscription.
+    # Required, unless a `product_id` is given instead.
+    # @return [String]
+    attr_accessor :product_handle
+
+    # The Product ID of the product for which you are creating a subscription.
+    # You can pass either `product_id` or `product_handle`.
+    # @return [Integer]
+    attr_accessor :product_id
+
+    # The ID of the particular price point on the product.
+    # @return [Integer]
+    attr_accessor :product_price_point_id
+
+    # The user-friendly API handle of a product's particular price point.
+    # @return [String]
+    attr_accessor :product_price_point_handle
+
+    # Use in place of passing product and component information to set up the
+    # subscription with an existing offer. May be either the Chargify ID of the
+    # offer or its handle prefixed with `handle:`
+    # @return [Integer]
+    attr_accessor :offer_id
+
+    # The reference value (provided by your app) for the subscription itelf.
+    # @return [String]
+    attr_accessor :reference
+
+    # One of the subscriptions must be marked as primary in the group.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :primary
+
+    # (Optional) If Multi-Currency is enabled and the currency is configured in
+    # Chargify, pass it at signup to create a subscription on a non-default
+    # currency. Note that you cannot update the currency of an existing
+    # subscription.
+    # @return [String]
+    attr_accessor :currency
+
+    # An array for all the coupons attached to the subscription.
+    # @return [Array[String]]
+    attr_accessor :coupon_codes
+
+    # An array for all the coupons attached to the subscription.
+    # @return [Array[SubscriptionGroupSignupComponent]]
+    attr_accessor :components
+
+    # (Optional) Used in place of `product_price_point_id` to define a custom
+    # price point unique to the subscription
+    # @return [CustomPriceUsedForSubscriptionCreateUpdate]
+    attr_accessor :custom_price
+
+    # (Optional). Cannot be used when also specifying next_billing_at
+    # @return [CalendarBilling]
+    attr_accessor :calendar_billing
+
+    # (Optional) A set of key/value pairs representing custom fields and their
+    # values. Metafields will be created “on-the-fly” in your site for a given
+    # key, if they have not been created yet.
+    # @return [Hash[String, String]]
+    attr_accessor :metafields
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['product_handle'] = 'product_handle'
+      @_hash['product_id'] = 'product_id'
+      @_hash['product_price_point_id'] = 'product_price_point_id'
+      @_hash['product_price_point_handle'] = 'product_price_point_handle'
+      @_hash['offer_id'] = 'offer_id'
+      @_hash['reference'] = 'reference'
+      @_hash['primary'] = 'primary'
+      @_hash['currency'] = 'currency'
+      @_hash['coupon_codes'] = 'coupon_codes'
+      @_hash['components'] = 'components'
+      @_hash['custom_price'] = 'custom_price'
+      @_hash['calendar_billing'] = 'calendar_billing'
+      @_hash['metafields'] = 'metafields'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        product_handle
+        product_id
+        product_price_point_id
+        product_price_point_handle
+        offer_id
+        reference
+        primary
+        currency
+        coupon_codes
+        components
+        custom_price
+        calendar_billing
+        metafields
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(product_handle = SKIP, product_id = SKIP,
+                   product_price_point_id = SKIP,
+                   product_price_point_handle = SKIP, offer_id = SKIP,
+                   reference = SKIP, primary = SKIP, currency = SKIP,
+                   coupon_codes = SKIP, components = SKIP, custom_price = SKIP,
+                   calendar_billing = SKIP, metafields = SKIP)
+      @product_handle = product_handle unless product_handle == SKIP
+      @product_id = product_id unless product_id == SKIP
+      @product_price_point_id = product_price_point_id unless product_price_point_id == SKIP
+      unless product_price_point_handle == SKIP
+        @product_price_point_handle =
+          product_price_point_handle
+      end
+      @offer_id = offer_id unless offer_id == SKIP
+      @reference = reference unless reference == SKIP
+      @primary = primary unless primary == SKIP
+      @currency = currency unless currency == SKIP
+      @coupon_codes = coupon_codes unless coupon_codes == SKIP
+      @components = components unless components == SKIP
+      @custom_price = custom_price unless custom_price == SKIP
+      @calendar_billing = calendar_billing unless calendar_billing == SKIP
+      @metafields = metafields unless metafields == 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_handle =
+        hash.key?('product_handle') ? hash['product_handle'] : SKIP
+      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
+      product_price_point_handle =
+        hash.key?('product_price_point_handle') ? hash['product_price_point_handle'] : SKIP
+      offer_id = hash.key?('offer_id') ? hash['offer_id'] : SKIP
+      reference = hash.key?('reference') ? hash['reference'] : SKIP
+      primary = hash.key?('primary') ? hash['primary'] : SKIP
+      currency = hash.key?('currency') ? hash['currency'] : SKIP
+      coupon_codes = hash.key?('coupon_codes') ? hash['coupon_codes'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      components = nil
+      unless hash['components'].nil?
+        components = []
+        hash['components'].each do |structure|
+          components << (SubscriptionGroupSignupComponent.from_hash(structure) if structure)
+        end
+      end
+
+      components = SKIP unless hash.key?('components')
+      custom_price = CustomPriceUsedForSubscriptionCreateUpdate.from_hash(hash['custom_price']) if
+        hash['custom_price']
+      calendar_billing = CalendarBilling.from_hash(hash['calendar_billing']) if
+        hash['calendar_billing']
+      metafields = hash.key?('metafields') ? hash['metafields'] : SKIP
+
+      # Create object from extracted values.
+      SubscriptionGroupSignupItem.new(product_handle,
+                                      product_id,
+                                      product_price_point_id,
+                                      product_price_point_handle,
+                                      offer_id,
+                                      reference,
+                                      primary,
+                                      currency,
+                                      coupon_codes,
+                                      components,
+                                      custom_price,
+                                      calendar_billing,
+                                      metafields)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [SubscriptionGroupSignupItem | 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/subscription_group_signup_request.rb

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