maxio-advanced-billing-sdk 0.0.3 → 0.0.4

data/lib/advanced_billing/models/subscription_component_subscription.rb

@@ -0,0 +1,197 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # An optional object, will be returned if provided `include=subscription`
+  # query param.
+  class SubscriptionComponentSubscription < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The state of a subscription.
+    # * **Live States**
+    #     * `active` - A normal, active subscription. It is not in a trial and
+    # is paid and up to date.
+    #     * `assessing` - An internal (transient) state that indicates a
+    # subscription is in the middle of periodic assessment. Do not base any
+    # access decisions in your app on this state, as it may not always be
+    # exposed.
+    #     * `pending` - An internal (transient) state that indicates a
+    # subscription is in the creation process. Do not base any access decisions
+    # in your app on this state, as it may not always be exposed.
+    #     * `trialing` - A subscription in trialing state has a valid trial
+    # subscription. This type of subscription may transition to active once
+    # payment is received when the trial has ended. Otherwise, it may go to a
+    # Problem or End of Life state.
+    #     * `paused` - An internal state that indicates that your account with
+    # Advanced Billing is in arrears.
+    # * **Problem States**
+    #     * `past_due` - Indicates that the most recent payment has failed, and
+    # payment is past due for this subscription. If you have enabled our
+    # automated dunning, this subscription will be in the dunning process
+    # (additional status and callbacks from the dunning process will be
+    # available in the future). If you are handling dunning and payment updates
+    # yourself, you will want to use this state to initiate a payment update
+    # from your customers.
+    #     * `soft_failure` - Indicates that normal assessment/processing of the
+    # subscription has failed for a reason that cannot be fixed by the Customer.
+    # For example, a Soft Fail may result from a timeout at the gateway or
+    # incorrect credentials on your part. The subscriptions should be retried
+    # automatically. An interface is being built for you to review problems
+    # resulting from these events to take manual action when needed.
+    #     * `unpaid` - Indicates an unpaid subscription. A subscription is
+    # marked unpaid if the retry period expires and you have configured your
+    # [Dunning](https://maxio-chargify.zendesk.com/hc/en-us/articles/54055051410
+    # 05) settings to have a Final Action of `mark the subscription unpaid`.
+    # * **End of Life States**
+    #     * `canceled` - Indicates a canceled subscription. This may happen at
+    # your request (via the API or the web interface) or due to the expiration
+    # of the
+    # [Dunning](https://maxio-chargify.zendesk.com/hc/en-us/articles/54055051410
+    # 05) process without payment. See the
+    # [Reactivation](https://maxio-chargify.zendesk.com/hc/en-us/articles/540455
+    # 9291021) documentation for info on how to restart a canceled subscription.
+    #     While a subscription is canceled, its period will not advance, it will
+    # not accrue any new charges, and Advanced Billing will not attempt to
+    # collect the overdue balance.
+    #     * `expired` - Indicates a subscription that has expired due to running
+    # its normal life cycle. Some products may be configured to have an
+    # expiration period. An expired subscription then is one that stayed active
+    # until it fulfilled its full period.
+    #     * `failed_to_create` - Indicates that signup has failed. (You may see
+    # this state in a signup_failure webhook.)
+    #     * `on_hold` - Indicates that a subscription’s billing has been
+    # temporarily stopped. While it is expected that the subscription will
+    # resume and return to active status, this is still treated as an “End of
+    # Life” state because the customer is not paying for services during this
+    # time.
+    #     * `suspended` - Indicates that a prepaid subscription has used up all
+    # their prepayment balance. If a prepayment is applied, it will return to an
+    # active state.
+    #     * `trial_ended` - A subscription in a trial_ended state is a
+    # subscription that completed a no-obligation trial and did not have a card
+    # on file at the expiration of the trial period. See [Product Pricing – No
+    # Obligation
+    # Trials](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405246782221
+    # ) for more details.
+    # See [Subscription
+    # States](https://maxio-chargify.zendesk.com/hc/en-us/articles/5404222005773
+    # ) for more info about subscription states and state transitions.
+    # @return [SubscriptionState]
+    attr_accessor :state
+
+    # The state of a subscription.
+    # * **Live States**
+    #     * `active` - A normal, active subscription. It is not in a trial and
+    # is paid and up to date.
+    #     * `assessing` - An internal (transient) state that indicates a
+    # subscription is in the middle of periodic assessment. Do not base any
+    # access decisions in your app on this state, as it may not always be
+    # exposed.
+    #     * `pending` - An internal (transient) state that indicates a
+    # subscription is in the creation process. Do not base any access decisions
+    # in your app on this state, as it may not always be exposed.
+    #     * `trialing` - A subscription in trialing state has a valid trial
+    # subscription. This type of subscription may transition to active once
+    # payment is received when the trial has ended. Otherwise, it may go to a
+    # Problem or End of Life state.
+    #     * `paused` - An internal state that indicates that your account with
+    # Advanced Billing is in arrears.
+    # * **Problem States**
+    #     * `past_due` - Indicates that the most recent payment has failed, and
+    # payment is past due for this subscription. If you have enabled our
+    # automated dunning, this subscription will be in the dunning process
+    # (additional status and callbacks from the dunning process will be
+    # available in the future). If you are handling dunning and payment updates
+    # yourself, you will want to use this state to initiate a payment update
+    # from your customers.
+    #     * `soft_failure` - Indicates that normal assessment/processing of the
+    # subscription has failed for a reason that cannot be fixed by the Customer.
+    # For example, a Soft Fail may result from a timeout at the gateway or
+    # incorrect credentials on your part. The subscriptions should be retried
+    # automatically. An interface is being built for you to review problems
+    # resulting from these events to take manual action when needed.
+    #     * `unpaid` - Indicates an unpaid subscription. A subscription is
+    # marked unpaid if the retry period expires and you have configured your
+    # [Dunning](https://maxio-chargify.zendesk.com/hc/en-us/articles/54055051410
+    # 05) settings to have a Final Action of `mark the subscription unpaid`.
+    # * **End of Life States**
+    #     * `canceled` - Indicates a canceled subscription. This may happen at
+    # your request (via the API or the web interface) or due to the expiration
+    # of the
+    # [Dunning](https://maxio-chargify.zendesk.com/hc/en-us/articles/54055051410
+    # 05) process without payment. See the
+    # [Reactivation](https://maxio-chargify.zendesk.com/hc/en-us/articles/540455
+    # 9291021) documentation for info on how to restart a canceled subscription.
+    #     While a subscription is canceled, its period will not advance, it will
+    # not accrue any new charges, and Advanced Billing will not attempt to
+    # collect the overdue balance.
+    #     * `expired` - Indicates a subscription that has expired due to running
+    # its normal life cycle. Some products may be configured to have an
+    # expiration period. An expired subscription then is one that stayed active
+    # until it fulfilled its full period.
+    #     * `failed_to_create` - Indicates that signup has failed. (You may see
+    # this state in a signup_failure webhook.)
+    #     * `on_hold` - Indicates that a subscription’s billing has been
+    # temporarily stopped. While it is expected that the subscription will
+    # resume and return to active status, this is still treated as an “End of
+    # Life” state because the customer is not paying for services during this
+    # time.
+    #     * `suspended` - Indicates that a prepaid subscription has used up all
+    # their prepayment balance. If a prepayment is applied, it will return to an
+    # active state.
+    #     * `trial_ended` - A subscription in a trial_ended state is a
+    # subscription that completed a no-obligation trial and did not have a card
+    # on file at the expiration of the trial period. See [Product Pricing – No
+    # Obligation
+    # Trials](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405246782221
+    # ) for more details.
+    # See [Subscription
+    # States](https://maxio-chargify.zendesk.com/hc/en-us/articles/5404222005773
+    # ) for more info about subscription states and state transitions.
+    # @return [String]
+    attr_accessor :updated_at
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['state'] = 'state'
+      @_hash['updated_at'] = 'updated_at'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        state
+        updated_at
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(state = SKIP,
+                   updated_at = SKIP)
+      @state = state unless state == 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.
+      state = hash.key?('state') ? hash['state'] : SKIP
+      updated_at = hash.key?('updated_at') ? hash['updated_at'] : SKIP
+
+      # Create object from extracted values.
+      SubscriptionComponentSubscription.new(state,
+                                            updated_at)
+    end
+  end
+end

data/lib/advanced_billing/models/subscription_custom_price.rb

@@ -0,0 +1,212 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # (Optional) Used in place of `product_price_point_id` to define a custom
+  # price point unique to the subscription
+  class SubscriptionCustomPrice < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # (Optional)
+    # @return [String]
+    attr_accessor :name
+
+    # (Optional)
+    # @return [String]
+    attr_accessor :handle
+
+    # Required if using `custom_price` attribute.
+    # @return [Object]
+    attr_accessor :price_in_cents
+
+    # Required if using `custom_price` attribute.
+    # @return [Object]
+    attr_accessor :interval
+
+    # Required if using `custom_price` attribute.
+    # @return [IntervalUnit]
+    attr_accessor :interval_unit
+
+    # (Optional)
+    # @return [Object]
+    attr_accessor :trial_price_in_cents
+
+    # (Optional)
+    # @return [Object]
+    attr_accessor :trial_interval
+
+    # (Optional)
+    # @return [IntervalUnit]
+    attr_accessor :trial_interval_unit
+
+    # (Optional)
+    # @return [Object]
+    attr_accessor :initial_charge_in_cents
+
+    # (Optional)
+    # @return [TrueClass | FalseClass]
+    attr_accessor :initial_charge_after_trial
+
+    # (Optional)
+    # @return [Object]
+    attr_accessor :expiration_interval
+
+    # (Optional)
+    # @return [IntervalUnit]
+    attr_accessor :expiration_interval_unit
+
+    # (Optional)
+    # @return [TrueClass | FalseClass]
+    attr_accessor :tax_included
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['handle'] = 'handle'
+      @_hash['price_in_cents'] = 'price_in_cents'
+      @_hash['interval'] = 'interval'
+      @_hash['interval_unit'] = 'interval_unit'
+      @_hash['trial_price_in_cents'] = 'trial_price_in_cents'
+      @_hash['trial_interval'] = 'trial_interval'
+      @_hash['trial_interval_unit'] = 'trial_interval_unit'
+      @_hash['initial_charge_in_cents'] = 'initial_charge_in_cents'
+      @_hash['initial_charge_after_trial'] = 'initial_charge_after_trial'
+      @_hash['expiration_interval'] = 'expiration_interval'
+      @_hash['expiration_interval_unit'] = 'expiration_interval_unit'
+      @_hash['tax_included'] = 'tax_included'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        handle
+        trial_price_in_cents
+        trial_interval
+        trial_interval_unit
+        initial_charge_in_cents
+        initial_charge_after_trial
+        expiration_interval
+        expiration_interval_unit
+        tax_included
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(price_in_cents = nil,
+                   interval = nil,
+                   interval_unit = nil,
+                   name = SKIP,
+                   handle = SKIP,
+                   trial_price_in_cents = SKIP,
+                   trial_interval = SKIP,
+                   trial_interval_unit = SKIP,
+                   initial_charge_in_cents = SKIP,
+                   initial_charge_after_trial = SKIP,
+                   expiration_interval = SKIP,
+                   expiration_interval_unit = SKIP,
+                   tax_included = SKIP)
+      @name = name unless name == SKIP
+      @handle = handle unless handle == SKIP
+      @price_in_cents = price_in_cents
+      @interval = interval
+      @interval_unit = interval_unit
+      @trial_price_in_cents = trial_price_in_cents unless trial_price_in_cents == SKIP
+      @trial_interval = trial_interval unless trial_interval == SKIP
+      @trial_interval_unit = trial_interval_unit unless trial_interval_unit == SKIP
+      @initial_charge_in_cents = initial_charge_in_cents unless initial_charge_in_cents == SKIP
+      unless initial_charge_after_trial == SKIP
+        @initial_charge_after_trial =
+          initial_charge_after_trial
+      end
+      @expiration_interval = expiration_interval unless expiration_interval == SKIP
+      @expiration_interval_unit = expiration_interval_unit unless expiration_interval_unit == SKIP
+      @tax_included = tax_included unless tax_included == 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.
+      price_in_cents = hash.key?('price_in_cents') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:SubscriptionCustomPricePriceInCents), hash['price_in_cents']
+      ) : nil
+      interval = hash.key?('interval') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:SubscriptionCustomPriceInterval), hash['interval']
+      ) : nil
+      interval_unit = hash.key?('interval_unit') ? hash['interval_unit'] : nil
+      name = hash.key?('name') ? hash['name'] : SKIP
+      handle = hash.key?('handle') ? hash['handle'] : SKIP
+      trial_price_in_cents = hash.key?('trial_price_in_cents') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:SubscriptionCustomPriceTrialPriceInCents), hash['trial_price_in_cents']
+      ) : SKIP
+      trial_interval = hash.key?('trial_interval') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:SubscriptionCustomPriceTrialInterval), hash['trial_interval']
+      ) : SKIP
+      trial_interval_unit =
+        hash.key?('trial_interval_unit') ? hash['trial_interval_unit'] : SKIP
+      initial_charge_in_cents = hash.key?('initial_charge_in_cents') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:SubscriptionCustomPriceInitialChargeInCents), hash['initial_charge_in_cents']
+      ) : SKIP
+      initial_charge_after_trial =
+        hash.key?('initial_charge_after_trial') ? hash['initial_charge_after_trial'] : SKIP
+      expiration_interval = hash.key?('expiration_interval') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:SubscriptionCustomPriceExpirationInterval), hash['expiration_interval']
+      ) : SKIP
+      expiration_interval_unit =
+        hash.key?('expiration_interval_unit') ? hash['expiration_interval_unit'] : SKIP
+      tax_included = hash.key?('tax_included') ? hash['tax_included'] : SKIP
+
+      # Create object from extracted values.
+      SubscriptionCustomPrice.new(price_in_cents,
+                                  interval,
+                                  interval_unit,
+                                  name,
+                                  handle,
+                                  trial_price_in_cents,
+                                  trial_interval,
+                                  trial_interval_unit,
+                                  initial_charge_in_cents,
+                                  initial_charge_after_trial,
+                                  expiration_interval,
+                                  expiration_interval_unit,
+                                  tax_included)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [SubscriptionCustomPrice | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          UnionTypeLookUp.get(:SubscriptionCustomPricePriceInCents)
+                         .validate(value.price_in_cents) and
+            UnionTypeLookUp.get(:SubscriptionCustomPriceInterval)
+                           .validate(value.interval) and
+            APIHelper.valid_type?(value.interval_unit,
+                                  ->(val) { IntervalUnit.validate(val) })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        UnionTypeLookUp.get(:SubscriptionCustomPricePriceInCents)
+                       .validate(value['price_in_cents']) and
+          UnionTypeLookUp.get(:SubscriptionCustomPriceInterval)
+                         .validate(value['interval']) and
+          APIHelper.valid_type?(value['interval_unit'],
+                                ->(val) { IntervalUnit.validate(val) })
+      )
+    end
+  end
+end

data/lib/advanced_billing/models/subscription_date_field.rb

@@ -0,0 +1,44 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Subscription Date Field.
+  class SubscriptionDateField
+    SUBSCRIPTION_DATE_FIELD = [
+      # TODO: Write general description for CURRENT_PERIOD_ENDS_AT
+      CURRENT_PERIOD_ENDS_AT = 'current_period_ends_at'.freeze,
+
+      # TODO: Write general description for CURRENT_PERIOD_STARTS_AT
+      CURRENT_PERIOD_STARTS_AT = 'current_period_starts_at'.freeze,
+
+      # TODO: Write general description for CREATED_AT
+      CREATED_AT = 'created_at'.freeze,
+
+      # TODO: Write general description for ACTIVATED_AT
+      ACTIVATED_AT = 'activated_at'.freeze,
+
+      # TODO: Write general description for CANCELED_AT
+      CANCELED_AT = 'canceled_at'.freeze,
+
+      # TODO: Write general description for EXPIRES_AT
+      EXPIRES_AT = 'expires_at'.freeze,
+
+      # TODO: Write general description for TRIAL_STARTED_AT
+      TRIAL_STARTED_AT = 'trial_started_at'.freeze,
+
+      # TODO: Write general description for TRIAL_ENDED_AT
+      TRIAL_ENDED_AT = 'trial_ended_at'.freeze,
+
+      # TODO: Write general description for UPDATED_AT
+      UPDATED_AT = 'updated_at'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SUBSCRIPTION_DATE_FIELD.include?(value)
+    end
+  end
+end

data/lib/advanced_billing/models/subscription_group.rb

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

data/lib/advanced_billing/models/subscription_group_balances.rb

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