maxio-advanced-billing-sdk 0.0.3 → 0.0.4

data/lib/advanced_billing/models/subscription_product_migration_request.rb

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

data/lib/advanced_billing/models/subscription_purge_type.rb

@@ -0,0 +1,23 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Subscription Purge Type.
+  class SubscriptionPurgeType
+    SUBSCRIPTION_PURGE_TYPE = [
+      # TODO: Write general description for CUSTOMER
+      CUSTOMER = 'customer'.freeze,
+
+      # TODO: Write general description for PAYMENT_PROFILE
+      PAYMENT_PROFILE = 'payment_profile'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SUBSCRIPTION_PURGE_TYPE.include?(value)
+    end
+  end
+end

data/lib/advanced_billing/models/subscription_response.rb

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

data/lib/advanced_billing/models/subscription_sort.rb

@@ -0,0 +1,35 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Subscription Sort.
+  class SubscriptionSort
+    SUBSCRIPTION_SORT = [
+      # TODO: Write general description for SIGNUP_DATE
+      SIGNUP_DATE = 'signup_date'.freeze,
+
+      # TODO: Write general description for PERIOD_START
+      PERIOD_START = 'period_start'.freeze,
+
+      # TODO: Write general description for PERIOD_END
+      PERIOD_END = 'period_end'.freeze,
+
+      # TODO: Write general description for NEXT_ASSESSMENT
+      NEXT_ASSESSMENT = 'next_assessment'.freeze,
+
+      # TODO: Write general description for UPDATED_AT
+      UPDATED_AT = 'updated_at'.freeze,
+
+      # TODO: Write general description for CREATED_AT
+      CREATED_AT = 'created_at'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SUBSCRIPTION_SORT.include?(value)
+    end
+  end
+end

data/lib/advanced_billing/models/subscription_state.rb

@@ -0,0 +1,118 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # 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/5405505141005
+  # ) 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/5405505141005
+  # ) process without payment. See the
+  # [Reactivation](https://maxio-chargify.zendesk.com/hc/en-us/articles/54045592
+  # 91021) 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.
+  class SubscriptionState
+    SUBSCRIPTION_STATE = [
+      # TODO: Write general description for PENDING
+      PENDING = 'pending'.freeze,
+
+      # TODO: Write general description for FAILED_TO_CREATE
+      FAILED_TO_CREATE = 'failed_to_create'.freeze,
+
+      # TODO: Write general description for TRIALING
+      TRIALING = 'trialing'.freeze,
+
+      # TODO: Write general description for ASSESSING
+      ASSESSING = 'assessing'.freeze,
+
+      # TODO: Write general description for ACTIVE
+      ACTIVE = 'active'.freeze,
+
+      # TODO: Write general description for SOFT_FAILURE
+      SOFT_FAILURE = 'soft_failure'.freeze,
+
+      # TODO: Write general description for PAST_DUE
+      PAST_DUE = 'past_due'.freeze,
+
+      # TODO: Write general description for SUSPENDED
+      SUSPENDED = 'suspended'.freeze,
+
+      # TODO: Write general description for CANCELED
+      CANCELED = 'canceled'.freeze,
+
+      # TODO: Write general description for EXPIRED
+      EXPIRED = 'expired'.freeze,
+
+      # TODO: Write general description for PAUSED
+      PAUSED = 'paused'.freeze,
+
+      # TODO: Write general description for UNPAID
+      UNPAID = 'unpaid'.freeze,
+
+      # TODO: Write general description for TRIAL_ENDED
+      TRIAL_ENDED = 'trial_ended'.freeze,
+
+      # TODO: Write general description for ON_HOLD
+      ON_HOLD = 'on_hold'.freeze,
+
+      # TODO: Write general description for AWAITING_SIGNUP
+      AWAITING_SIGNUP = 'awaiting_signup'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SUBSCRIPTION_STATE.include?(value)
+    end
+  end
+end

data/lib/advanced_billing/models/subscription_state_change.rb

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

data/lib/advanced_billing/models/subscription_state_filter.rb

@@ -0,0 +1,53 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Allowed values for filtering by the current state of the subscription.
+  class SubscriptionStateFilter
+    SUBSCRIPTION_STATE_FILTER = [
+      # TODO: Write general description for ACTIVE
+      ACTIVE = 'active'.freeze,
+
+      # TODO: Write general description for CANCELED
+      CANCELED = 'canceled'.freeze,
+
+      # TODO: Write general description for EXPIRED
+      EXPIRED = 'expired'.freeze,
+
+      # TODO: Write general description for EXPIRED_CARDS
+      EXPIRED_CARDS = 'expired_cards'.freeze,
+
+      # TODO: Write general description for ON_HOLD
+      ON_HOLD = 'on_hold'.freeze,
+
+      # TODO: Write general description for PAST_DUE
+      PAST_DUE = 'past_due'.freeze,
+
+      # TODO: Write general description for PENDING_CANCELLATION
+      PENDING_CANCELLATION = 'pending_cancellation'.freeze,
+
+      # TODO: Write general description for PENDING_RENEWAL
+      PENDING_RENEWAL = 'pending_renewal'.freeze,
+
+      # TODO: Write general description for SUSPENDED
+      SUSPENDED = 'suspended'.freeze,
+
+      # TODO: Write general description for TRIAL_ENDED
+      TRIAL_ENDED = 'trial_ended'.freeze,
+
+      # TODO: Write general description for TRIALING
+      TRIALING = 'trialing'.freeze,
+
+      # TODO: Write general description for UNPAID
+      UNPAID = 'unpaid'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SUBSCRIPTION_STATE_FILTER.include?(value)
+    end
+  end
+end

data/lib/advanced_billing/models/tax_configuration.rb

@@ -0,0 +1,74 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # TaxConfiguration Model.
+  class TaxConfiguration < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [TaxConfigurationKind]
+    attr_accessor :kind
+
+    # TODO: Write general description for this method
+    # @return [TaxDestinationAddress]
+    attr_accessor :destination_address
+
+    # Returns `true` when Chargify has been properly configured to charge tax
+    # using the specified tax system. More details about taxes:
+    # https://maxio-chargify.zendesk.com/hc/en-us/articles/5405488905869-Taxes-I
+    # ntroduction
+    # @return [TrueClass | FalseClass]
+    attr_accessor :fully_configured
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['kind'] = 'kind'
+      @_hash['destination_address'] = 'destination_address'
+      @_hash['fully_configured'] = 'fully_configured'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        kind
+        destination_address
+        fully_configured
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(kind = TaxConfigurationKind::CUSTOM,
+                   destination_address = SKIP,
+                   fully_configured = false)
+      @kind = kind unless kind == SKIP
+      @destination_address = destination_address unless destination_address == SKIP
+      @fully_configured = fully_configured unless fully_configured == 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.
+      kind = hash['kind'] ||= TaxConfigurationKind::CUSTOM
+      destination_address =
+        hash.key?('destination_address') ? hash['destination_address'] : SKIP
+      fully_configured = hash['fully_configured'] ||= false
+
+      # Create object from extracted values.
+      TaxConfiguration.new(kind,
+                           destination_address,
+                           fully_configured)
+    end
+  end
+end

data/lib/advanced_billing/models/tax_configuration_kind.rb

@@ -0,0 +1,29 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Tax Configuration Kind.
+  class TaxConfigurationKind
+    TAX_CONFIGURATION_KIND = [
+      # TODO: Write general description for CUSTOM
+      CUSTOM = 'custom'.freeze,
+
+      # TODO: Write general description for ENUM_MANAGED_AVALARA
+      ENUM_MANAGED_AVALARA = 'managed avalara'.freeze,
+
+      # TODO: Write general description for ENUM_LINKED_AVALARA
+      ENUM_LINKED_AVALARA = 'linked avalara'.freeze,
+
+      # TODO: Write general description for ENUM_DIGITAL_RIVER
+      ENUM_DIGITAL_RIVER = 'digital river'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TAX_CONFIGURATION_KIND.include?(value)
+    end
+  end
+end

data/lib/advanced_billing/models/tax_destination_address.rb

@@ -0,0 +1,29 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Tax Destination Address.
+  class TaxDestinationAddress
+    TAX_DESTINATION_ADDRESS = [
+      # TODO: Write general description for SHIPPING_THEN_BILLING
+      SHIPPING_THEN_BILLING = 'shipping_then_billing'.freeze,
+
+      # TODO: Write general description for BILLING_THEN_SHIPPING
+      BILLING_THEN_SHIPPING = 'billing_then_shipping'.freeze,
+
+      # TODO: Write general description for SHIPPING_ONLY
+      SHIPPING_ONLY = 'shipping_only'.freeze,
+
+      # TODO: Write general description for BILLING_ONLY
+      BILLING_ONLY = 'billing_only'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TAX_DESTINATION_ADDRESS.include?(value)
+    end
+  end
+end

data/lib/advanced_billing/models/too_many_management_link_requests.rb

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

data/lib/advanced_billing/models/update_allocation_expiration_date.rb

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