maxio-advanced-billing-sdk 0.0.3 → 0.0.4

data/lib/advanced_billing/models/event.rb

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

data/lib/advanced_billing/models/event_based_billing_segment_error.rb

@@ -0,0 +1,51 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # EventBasedBillingSegmentError Model.
+  class EventBasedBillingSegmentError < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The key of the object would be a number (an index in the request array)
+    # where the error occurred. In the value object, the key represents the
+    # field and the value is an array with error messages. In most cases, this
+    # object would contain just one key.
+    # @return [Hash[String, Object]]
+    attr_accessor :segments
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['segments'] = 'segments'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(segments = nil)
+      @segments = segments
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      segments = hash.key?('segments') ? hash['segments'] : nil
+
+      # Create object from extracted values.
+      EventBasedBillingSegmentError.new(segments)
+    end
+  end
+end

data/lib/advanced_billing/models/event_response.rb

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

data/lib/advanced_billing/models/event_type.rb

@@ -0,0 +1,121 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Event Type.
+  class EventType
+    EVENT_TYPE = [
+      # TODO: Write general description for ACCOUNT_TRANSACTION_CHANGED
+      ACCOUNT_TRANSACTION_CHANGED = 'account_transaction_changed'.freeze,
+
+      # TODO: Write general description for BILLING_DATE_CHANGE
+      BILLING_DATE_CHANGE = 'billing_date_change'.freeze,
+
+      # TODO: Write general description for COMPONENT_ALLOCATION_CHANGE
+      COMPONENT_ALLOCATION_CHANGE = 'component_allocation_change'.freeze,
+
+      # TODO: Write general description for CUSTOMER_UPDATE
+      CUSTOMER_UPDATE = 'customer_update'.freeze,
+
+      # TODO: Write general description for CUSTOMER_CREATE
+      CUSTOMER_CREATE = 'customer_create'.freeze,
+
+      # TODO: Write general description for DUNNING_STEP_REACHED
+      DUNNING_STEP_REACHED = 'dunning_step_reached'.freeze,
+
+      # TODO: Write general description for EXPIRATION_DATE_CHANGE
+      EXPIRATION_DATE_CHANGE = 'expiration_date_change'.freeze,
+
+      # TODO: Write general description for EXPIRING_CARD
+      EXPIRING_CARD = 'expiring_card'.freeze,
+
+      # TODO: Write general description for METERED_USAGE
+      METERED_USAGE = 'metered_usage'.freeze,
+
+      # TODO: Write general description for PAYMENT_SUCCESS
+      PAYMENT_SUCCESS = 'payment_success'.freeze,
+
+      # TODO: Write general description for PAYMENT_SUCCESS_RECREATED
+      PAYMENT_SUCCESS_RECREATED = 'payment_success_recreated'.freeze,
+
+      # TODO: Write general description for PAYMENT_FAILURE
+      PAYMENT_FAILURE = 'payment_failure'.freeze,
+
+      # TODO: Write general description for PAYMENT_FAILURE_RECREATED
+      PAYMENT_FAILURE_RECREATED = 'payment_failure_recreated'.freeze,
+
+      # TODO: Write general description for REFUND_FAILURE
+      REFUND_FAILURE = 'refund_failure'.freeze,
+
+      # TODO: Write general description for REFUND_SUCCESS
+      REFUND_SUCCESS = 'refund_success'.freeze,
+
+      # TODO: Write general description for RENEWAL_SUCCESS
+      RENEWAL_SUCCESS = 'renewal_success'.freeze,
+
+      # TODO: Write general description for RENEWAL_SUCCESS_RECREATED
+      RENEWAL_SUCCESS_RECREATED = 'renewal_success_recreated'.freeze,
+
+      # TODO: Write general description for RENEWAL_FAILURE
+      RENEWAL_FAILURE = 'renewal_failure'.freeze,
+
+      # TODO: Write general description for SIGNUP_SUCCESS
+      SIGNUP_SUCCESS = 'signup_success'.freeze,
+
+      # TODO: Write general description for SIGNUP_FAILURE
+      SIGNUP_FAILURE = 'signup_failure'.freeze,
+
+      # TODO: Write general description for STATEMENT_CLOSED
+      STATEMENT_CLOSED = 'statement_closed'.freeze,
+
+      # TODO: Write general description for STATEMENT_SETTLED
+      STATEMENT_SETTLED = 'statement_settled'.freeze,
+
+      # TODO: Write general description for SUBSCRIPTION_BANK_ACCOUNT_UPDATE
+      SUBSCRIPTION_BANK_ACCOUNT_UPDATE = 'subscription_bank_account_update'.freeze,
+
+      # TODO: Write general description for SUBSCRIPTION_DELETION
+      SUBSCRIPTION_DELETION = 'subscription_deletion'.freeze,
+
+      # TODO: Write general description for SUBSCRIPTION_PAYPAL_ACCOUNT_UPDATE
+      SUBSCRIPTION_PAYPAL_ACCOUNT_UPDATE = 'subscription_paypal_account_update'.freeze,
+
+      # TODO: Write general description for SUBSCRIPTION_PRODUCT_CHANGE
+      SUBSCRIPTION_PRODUCT_CHANGE = 'subscription_product_change'.freeze,
+
+      # TODO: Write general description for SUBSCRIPTION_STATE_CHANGE
+      SUBSCRIPTION_STATE_CHANGE = 'subscription_state_change'.freeze,
+
+      # TODO: Write general description for TRIAL_END_NOTICE
+      TRIAL_END_NOTICE = 'trial_end_notice'.freeze,
+
+      # TODO: Write general description for UPGRADE_DOWNGRADE_SUCCESS
+      UPGRADE_DOWNGRADE_SUCCESS = 'upgrade_downgrade_success'.freeze,
+
+      # TODO: Write general description for UPGRADE_DOWNGRADE_FAILURE
+      UPGRADE_DOWNGRADE_FAILURE = 'upgrade_downgrade_failure'.freeze,
+
+      # TODO: Write general description for UPCOMING_RENEWAL_NOTICE
+      UPCOMING_RENEWAL_NOTICE = 'upcoming_renewal_notice'.freeze,
+
+      # TODO: Write general description for CUSTOM_FIELD_VALUE_CHANGE
+      CUSTOM_FIELD_VALUE_CHANGE = 'custom_field_value_change'.freeze,
+
+      # TODO: Write general description for
+      # SUBSCRIPTION_PREPAYMENT_ACCOUNT_BALANCE_CHANGED
+      SUBSCRIPTION_PREPAYMENT_ACCOUNT_BALANCE_CHANGED = 'subscription_prepayment_account_balance_changed'.freeze,
+
+      # TODO: Write general description for
+      # SUBSCRIPTION_SERVICE_CREDIT_ACCOUNT_BALANCE_CHANGED
+      SUBSCRIPTION_SERVICE_CREDIT_ACCOUNT_BALANCE_CHANGED = 'subscription_service_credit_account_balance_changed'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      EVENT_TYPE.include?(value)
+    end
+  end
+end

data/lib/advanced_billing/models/extended_interval_unit.rb

@@ -0,0 +1,26 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Extended Interval Unit.
+  class ExtendedIntervalUnit
+    EXTENDED_INTERVAL_UNIT = [
+      # TODO: Write general description for DAY
+      DAY = 'day'.freeze,
+
+      # TODO: Write general description for MONTH
+      MONTH = 'month'.freeze,
+
+      # TODO: Write general description for NEVER
+      NEVER = 'never'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      EXTENDED_INTERVAL_UNIT.include?(value)
+    end
+  end
+end

data/lib/advanced_billing/models/failed_payment_action.rb

@@ -0,0 +1,37 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Action taken when payment for an invoice fails: - `leave_open_invoice` -
+  # prepayments and credits applied to invoice; invoice status set to "open";
+  # email sent to the customer for the issued invoice (if setting applies);
+  # payment failure recorded in the invoice history. This is the default option.
+  # - `rollback_to_pending` - prepayments and credits not applied; invoice
+  # remains in "pending" status; no email sent to the customer; payment failure
+  # recorded in the invoice history. - `initiate_dunning` - prepayments and
+  # credits applied to the invoice; invoice status set to "open"; email sent to
+  # the customer for the issued invoice (if setting applies); payment failure
+  # recorded in the invoice history; subscription will  most likely go into
+  # "past_due" or "canceled" state (depending upon net terms and dunning
+  # settings).
+  class FailedPaymentAction
+    FAILED_PAYMENT_ACTION = [
+      # TODO: Write general description for LEAVE_OPEN_INVOICE
+      LEAVE_OPEN_INVOICE = 'leave_open_invoice'.freeze,
+
+      # TODO: Write general description for ROLLBACK_TO_PENDING
+      ROLLBACK_TO_PENDING = 'rollback_to_pending'.freeze,
+
+      # TODO: Write general description for INITIATE_DUNNING
+      INITIATE_DUNNING = 'initiate_dunning'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      FAILED_PAYMENT_ACTION.include?(value)
+    end
+  end
+end

data/lib/advanced_billing/models/first_charge_type.rb

@@ -0,0 +1,26 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # First Charge Type.
+  class FirstChargeType
+    FIRST_CHARGE_TYPE = [
+      # TODO: Write general description for PRORATED
+      PRORATED = 'prorated'.freeze,
+
+      # TODO: Write general description for IMMEDIATE
+      IMMEDIATE = 'immediate'.freeze,
+
+      # TODO: Write general description for DELAYED
+      DELAYED = 'delayed'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      FIRST_CHARGE_TYPE.include?(value)
+    end
+  end
+end

data/lib/advanced_billing/models/full_subscription_group_response.rb

@@ -0,0 +1,171 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # FullSubscriptionGroupResponse Model.
+  class FullSubscriptionGroupResponse < 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 [Integer]
+    attr_accessor :current_billing_amount_in_cents
+
+    # TODO: Write general description for this method
+    # @return [SubscriptionGroupCustomer]
+    attr_accessor :customer
+
+    # TODO: Write general description for this method
+    # @return [SubscriptionGroupBalances]
+    attr_accessor :account_balances
+
+    # 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['current_billing_amount_in_cents'] =
+        'current_billing_amount_in_cents'
+      @_hash['customer'] = 'customer'
+      @_hash['account_balances'] = 'account_balances'
+      @_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
+        current_billing_amount_in_cents
+        customer
+        account_balances
+      ]
+    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,
+                   current_billing_amount_in_cents = SKIP,
+                   customer = SKIP,
+                   account_balances = SKIP)
+      @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
+      unless current_billing_amount_in_cents == SKIP
+        @current_billing_amount_in_cents =
+          current_billing_amount_in_cents
+      end
+      @customer = customer unless customer == SKIP
+      @account_balances = account_balances unless account_balances == 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.
+      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
+      current_billing_amount_in_cents =
+        hash.key?('current_billing_amount_in_cents') ? hash['current_billing_amount_in_cents'] : SKIP
+      customer = SubscriptionGroupCustomer.from_hash(hash['customer']) if hash['customer']
+      account_balances = SubscriptionGroupBalances.from_hash(hash['account_balances']) if
+        hash['account_balances']
+
+      # Create object from extracted values.
+      FullSubscriptionGroupResponse.new(uid,
+                                        scheme,
+                                        customer_id,
+                                        payment_profile_id,
+                                        subscription_ids,
+                                        primary_subscription_id,
+                                        next_assessment_at,
+                                        state,
+                                        cancel_at_end_of_period,
+                                        current_billing_amount_in_cents,
+                                        customer,
+                                        account_balances)
+    end
+  end
+end