maxio-advanced-billing-sdk 0.0.3 → 1.0.0

data/lib/advanced_billing/models/subscription_group_signup_item.rb

@@ -0,0 +1,197 @@
+# 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 [SubscriptionCustomPrice]
+    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 = SubscriptionCustomPrice.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
+  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

data/lib/advanced_billing/models/subscription_group_signup_response.rb

@@ -0,0 +1,171 @@
+# 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 [CollectionMethod]
+    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 = CollectionMethod::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'] ||= CollectionMethod::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,81 @@
+# 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) }) and
+            APIHelper.valid_type?(value.customer,
+                                  ->(val) { Customer.validate(val) })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['subscription_group'],
+                              ->(val) { SubscriptionGroupSignupSuccessData.validate(val) }) and
+          APIHelper.valid_type?(value['customer'],
+                                ->(val) { Customer.validate(val) })
+      )
+    end
+  end
+end

data/lib/advanced_billing/models/subscription_group_signup_success_data.rb

@@ -0,0 +1,125 @@
+# 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
+  end
+end