maxio-advanced-billing-sdk 0.0.3 → 0.0.4

data/lib/advanced_billing/models/bulk_update_segments_item.rb

@@ -0,0 +1,80 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # BulkUpdateSegmentsItem Model.
+  class BulkUpdateSegmentsItem < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The ID of the segment you want to update.
+    # @return [Integer]
+    attr_accessor :id
+
+    # The identifier for the pricing scheme. See [Product
+    # Components](https://help.chargify.com/products/product-components.html)
+    # for an overview of pricing schemes.
+    # @return [PricingScheme]
+    attr_accessor :pricing_scheme
+
+    # The identifier for the pricing scheme. See [Product
+    # Components](https://help.chargify.com/products/product-components.html)
+    # for an overview of pricing schemes.
+    # @return [Array[CreateOrUpdateSegmentPrice]]
+    attr_accessor :prices
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['pricing_scheme'] = 'pricing_scheme'
+      @_hash['prices'] = 'prices'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = nil,
+                   pricing_scheme = nil,
+                   prices = nil)
+      @id = id
+      @pricing_scheme = pricing_scheme
+      @prices = prices
+    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
+      pricing_scheme =
+        hash.key?('pricing_scheme') ? hash['pricing_scheme'] : nil
+      # Parameter is an array, so we need to iterate through it
+      prices = nil
+      unless hash['prices'].nil?
+        prices = []
+        hash['prices'].each do |structure|
+          prices << (CreateOrUpdateSegmentPrice.from_hash(structure) if structure)
+        end
+      end
+
+      prices = nil unless hash.key?('prices')
+
+      # Create object from extracted values.
+      BulkUpdateSegmentsItem.new(id,
+                                 pricing_scheme,
+                                 prices)
+    end
+  end
+end

data/lib/advanced_billing/models/calendar_billing.rb

@@ -0,0 +1,79 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # (Optional). Cannot be used when also specifying next_billing_at
+  class CalendarBilling < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A day of month that subscription will be processed on. Can be 1 up to 28
+    # or 'end'.
+    # @return [Object]
+    attr_accessor :snap_day
+
+    # A day of month that subscription will be processed on. Can be 1 up to 28
+    # or 'end'.
+    # @return [FirstChargeType]
+    attr_accessor :calendar_billing_first_charge
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['snap_day'] = 'snap_day'
+      @_hash['calendar_billing_first_charge'] =
+        'calendar_billing_first_charge'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        snap_day
+        calendar_billing_first_charge
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(snap_day = SKIP,
+                   calendar_billing_first_charge = SKIP)
+      @snap_day = snap_day unless snap_day == SKIP
+      unless calendar_billing_first_charge == SKIP
+        @calendar_billing_first_charge =
+          calendar_billing_first_charge
+      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.
+      snap_day = hash.key?('snap_day') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:CalendarBillingSnapDay), hash['snap_day']
+      ) : SKIP
+      calendar_billing_first_charge =
+        hash.key?('calendar_billing_first_charge') ? hash['calendar_billing_first_charge'] : SKIP
+
+      # Create object from extracted values.
+      CalendarBilling.new(snap_day,
+                          calendar_billing_first_charge)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [CalendarBilling | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
+  end
+end

data/lib/advanced_billing/models/cancel_grouped_subscriptions_request.rb

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

data/lib/advanced_billing/models/cancellation_method.rb

@@ -0,0 +1,33 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # The process used to cancel the subscription, if the subscription has been
+  # canceled. It is nil if the subscription's state is not canceled.
+  class CancellationMethod
+    CANCELLATION_METHOD = [
+      # TODO: Write general description for MERCHANT_UI
+      MERCHANT_UI = 'merchant_ui'.freeze,
+
+      # TODO: Write general description for MERCHANT_API
+      MERCHANT_API = 'merchant_api'.freeze,
+
+      # TODO: Write general description for DUNNING
+      DUNNING = 'dunning'.freeze,
+
+      # TODO: Write general description for BILLING_PORTAL
+      BILLING_PORTAL = 'billing_portal'.freeze,
+
+      # TODO: Write general description for UNKNOWN
+      UNKNOWN = 'unknown'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CANCELLATION_METHOD.include?(value)
+    end
+  end
+end

data/lib/advanced_billing/models/cancellation_options.rb

@@ -0,0 +1,63 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # CancellationOptions Model.
+  class CancellationOptions < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # For your internal use. An indication as to why the subscription is being
+    # canceled.
+    # @return [String]
+    attr_accessor :cancellation_message
+
+    # The reason code associated with the cancellation. See the list of reason
+    # codes associated with your site.
+    # @return [String]
+    attr_accessor :reason_code
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['cancellation_message'] = 'cancellation_message'
+      @_hash['reason_code'] = 'reason_code'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        cancellation_message
+        reason_code
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(cancellation_message = SKIP,
+                   reason_code = SKIP)
+      @cancellation_message = cancellation_message unless cancellation_message == SKIP
+      @reason_code = reason_code unless reason_code == 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.
+      cancellation_message =
+        hash.key?('cancellation_message') ? hash['cancellation_message'] : SKIP
+      reason_code = hash.key?('reason_code') ? hash['reason_code'] : SKIP
+
+      # Create object from extracted values.
+      CancellationOptions.new(cancellation_message,
+                              reason_code)
+    end
+  end
+end

data/lib/advanced_billing/models/cancellation_request.rb

@@ -0,0 +1,48 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # CancellationRequest Model.
+  class CancellationRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [CancellationOptions]
+    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
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(subscription = nil)
+      @subscription = subscription
+    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 = CancellationOptions.from_hash(hash['subscription']) if hash['subscription']
+
+      # Create object from extracted values.
+      CancellationRequest.new(subscription)
+    end
+  end
+end

data/lib/advanced_billing/models/card_type.rb

@@ -0,0 +1,125 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # The type of card used.
+  class CardType
+    CARD_TYPE = [
+      # TODO: Write general description for VISA
+      VISA = 'visa'.freeze,
+
+      # TODO: Write general description for MASTER
+      MASTER = 'master'.freeze,
+
+      # TODO: Write general description for ELO
+      ELO = 'elo'.freeze,
+
+      # TODO: Write general description for CABAL
+      CABAL = 'cabal'.freeze,
+
+      # TODO: Write general description for ALELO
+      ALELO = 'alelo'.freeze,
+
+      # TODO: Write general description for DISCOVER
+      DISCOVER = 'discover'.freeze,
+
+      # TODO: Write general description for AMERICAN_EXPRESS
+      AMERICAN_EXPRESS = 'american_express'.freeze,
+
+      # TODO: Write general description for NARANJA
+      NARANJA = 'naranja'.freeze,
+
+      # TODO: Write general description for DINERS_CLUB
+      DINERS_CLUB = 'diners_club'.freeze,
+
+      # TODO: Write general description for JCB
+      JCB = 'jcb'.freeze,
+
+      # TODO: Write general description for DANKORT
+      DANKORT = 'dankort'.freeze,
+
+      # TODO: Write general description for MAESTRO
+      MAESTRO = 'maestro'.freeze,
+
+      # TODO: Write general description for MAESTRO_NO_LUHN
+      MAESTRO_NO_LUHN = 'maestro_no_luhn'.freeze,
+
+      # TODO: Write general description for FORBRUGSFORENINGEN
+      FORBRUGSFORENINGEN = 'forbrugsforeningen'.freeze,
+
+      # TODO: Write general description for SODEXO
+      SODEXO = 'sodexo'.freeze,
+
+      # TODO: Write general description for ALIA
+      ALIA = 'alia'.freeze,
+
+      # TODO: Write general description for VR
+      VR = 'vr'.freeze,
+
+      # TODO: Write general description for UNIONPAY
+      UNIONPAY = 'unionpay'.freeze,
+
+      # TODO: Write general description for CARNET
+      CARNET = 'carnet'.freeze,
+
+      # TODO: Write general description for CARTES_BANCAIRES
+      CARTES_BANCAIRES = 'cartes_bancaires'.freeze,
+
+      # TODO: Write general description for OLIMPICA
+      OLIMPICA = 'olimpica'.freeze,
+
+      # TODO: Write general description for CREDITEL
+      CREDITEL = 'creditel'.freeze,
+
+      # TODO: Write general description for CONFIABLE
+      CONFIABLE = 'confiable'.freeze,
+
+      # TODO: Write general description for SYNCHRONY
+      SYNCHRONY = 'synchrony'.freeze,
+
+      # TODO: Write general description for ROUTEX
+      ROUTEX = 'routex'.freeze,
+
+      # TODO: Write general description for MADA
+      MADA = 'mada'.freeze,
+
+      # TODO: Write general description for BP_PLUS
+      BP_PLUS = 'bp_plus'.freeze,
+
+      # TODO: Write general description for PASSCARD
+      PASSCARD = 'passcard'.freeze,
+
+      # TODO: Write general description for EDENRED
+      EDENRED = 'edenred'.freeze,
+
+      # TODO: Write general description for ANDA
+      ANDA = 'anda'.freeze,
+
+      # TODO: Write general description for TARJETAD
+      TARJETAD = 'tarjeta-d'.freeze,
+
+      # TODO: Write general description for HIPERCARD
+      HIPERCARD = 'hipercard'.freeze,
+
+      # TODO: Write general description for BOGUS
+      BOGUS = 'bogus'.freeze,
+
+      # TODO: Write general description for SWITCH
+      SWITCH = 'switch'.freeze,
+
+      # TODO: Write general description for SOLO
+      SOLO = 'solo'.freeze,
+
+      # TODO: Write general description for LASER
+      LASER = 'laser'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CARD_TYPE.include?(value)
+    end
+  end
+end

data/lib/advanced_billing/models/change_invoice_collection_method_event_data.rb

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

data/lib/advanced_billing/models/chargify_ebb.rb

@@ -0,0 +1,116 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # ChargifyEBB Model.
+  class ChargifyEBB < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # This timestamp determines what billing period the event will be billed in.
+    # If your request payload does not include it, Chargify will add
+    # `chargify.timestamp` to the event payload and set the value to `now`.
+    # @return [String]
+    attr_accessor :timestamp
+
+    # A unique ID set by Chargify. Please note that this field is reserved. If
+    # `chargify.id` is present in the request payload, it will be overwritten.
+    # @return [String]
+    attr_accessor :id
+
+    # An ISO-8601 timestamp, set by Chargify at the time each event is recorded.
+    # Please note that this field is reserved. If `chargify.created_at` is
+    # present in the request payload, it will be overwritten.
+    # @return [String]
+    attr_accessor :created_at
+
+    # User-defined string scoped per-stream. Duplicate events within a stream
+    # will be silently ignored. Tokens expire after 31 days.
+    # @return [String]
+    attr_accessor :uniqueness_token
+
+    # Id of Maxio Advanced Billing Subscription which is connected to this
+    # event. 
+    # Provide `subscription_id` if you configured `chargify.subscription_id` as
+    # Subscription Identifier in your Event Stream.
+    # @return [Integer]
+    attr_accessor :subscription_id
+
+    # Reference of Maxio Advanced Billing Subscription which is connected to
+    # this event. 
+    # Provide `subscription_reference` if you configured
+    # `chargify.subscription_reference` as Subscription Identifier in your Event
+    # Stream.
+    # @return [String]
+    attr_accessor :subscription_reference
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['timestamp'] = 'timestamp'
+      @_hash['id'] = 'id'
+      @_hash['created_at'] = 'created_at'
+      @_hash['uniqueness_token'] = 'uniqueness_token'
+      @_hash['subscription_id'] = 'subscription_id'
+      @_hash['subscription_reference'] = 'subscription_reference'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        timestamp
+        id
+        created_at
+        uniqueness_token
+        subscription_id
+        subscription_reference
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(timestamp = SKIP,
+                   id = SKIP,
+                   created_at = SKIP,
+                   uniqueness_token = SKIP,
+                   subscription_id = SKIP,
+                   subscription_reference = SKIP)
+      @timestamp = timestamp unless timestamp == SKIP
+      @id = id unless id == SKIP
+      @created_at = created_at unless created_at == SKIP
+      @uniqueness_token = uniqueness_token unless uniqueness_token == SKIP
+      @subscription_id = subscription_id unless subscription_id == SKIP
+      @subscription_reference = subscription_reference unless subscription_reference == 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.
+      timestamp = hash.key?('timestamp') ? hash['timestamp'] : SKIP
+      id = hash.key?('id') ? hash['id'] : SKIP
+      created_at = hash.key?('created_at') ? hash['created_at'] : SKIP
+      uniqueness_token =
+        hash.key?('uniqueness_token') ? hash['uniqueness_token'] : SKIP
+      subscription_id =
+        hash.key?('subscription_id') ? hash['subscription_id'] : SKIP
+      subscription_reference =
+        hash.key?('subscription_reference') ? hash['subscription_reference'] : SKIP
+
+      # Create object from extracted values.
+      ChargifyEBB.new(timestamp,
+                      id,
+                      created_at,
+                      uniqueness_token,
+                      subscription_id,
+                      subscription_reference)
+    end
+  end
+end