subtain-apimatic-sdk 4.1.1 → 9.1.1

data/lib/advanced_billing/models/bulk_component_s_price_point_assignment.rb

@@ -0,0 +1,59 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # BulkComponentSPricePointAssignment Model.
+  class BulkComponentSPricePointAssignment < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[ComponentSPricePointAssignment]]
+    attr_accessor :components
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['components'] = 'components'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        components
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(components = SKIP)
+      @components = components unless components == 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.
+      # Parameter is an array, so we need to iterate through it
+      components = nil
+      unless hash['components'].nil?
+        components = []
+        hash['components'].each do |structure|
+          components << (ComponentSPricePointAssignment.from_hash(structure) if structure)
+        end
+      end
+
+      components = SKIP unless hash.key?('components')
+
+      # Create object from extracted values.
+      BulkComponentSPricePointAssignment.new(components)
+    end
+  end
+end

data/lib/advanced_billing/models/bulk_create_product_price_points_request.rb

@@ -0,0 +1,57 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # BulkCreateProductPricePointsRequest Model.
+  class BulkCreateProductPricePointsRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[CreateProductPricePoint]]
+    attr_accessor :price_points
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['price_points'] = 'price_points'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(price_points = nil)
+      @price_points = price_points
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      # Parameter is an array, so we need to iterate through it
+      price_points = nil
+      unless hash['price_points'].nil?
+        price_points = []
+        hash['price_points'].each do |structure|
+          price_points << (CreateProductPricePoint.from_hash(structure) if structure)
+        end
+      end
+
+      price_points = nil unless hash.key?('price_points')
+
+      # Create object from extracted values.
+      BulkCreateProductPricePointsRequest.new(price_points)
+    end
+  end
+end

data/lib/advanced_billing/models/bulk_create_product_price_points_response.rb

@@ -0,0 +1,59 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # BulkCreateProductPricePointsResponse Model.
+  class BulkCreateProductPricePointsResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[ProductPricePoint]]
+    attr_accessor :price_points
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['price_points'] = 'price_points'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        price_points
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(price_points = SKIP)
+      @price_points = price_points unless price_points == 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.
+      # Parameter is an array, so we need to iterate through it
+      price_points = nil
+      unless hash['price_points'].nil?
+        price_points = []
+        hash['price_points'].each do |structure|
+          price_points << (ProductPricePoint.from_hash(structure) if structure)
+        end
+      end
+
+      price_points = SKIP unless hash.key?('price_points')
+
+      # Create object from extracted values.
+      BulkCreateProductPricePointsResponse.new(price_points)
+    end
+  end
+end

data/lib/advanced_billing/models/bulk_create_segments.rb

@@ -0,0 +1,59 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # BulkCreateSegments Model.
+  class BulkCreateSegments < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[CreateSegment]]
+    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
+      %w[
+        segments
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(segments = SKIP)
+      @segments = segments unless segments == 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.
+      # Parameter is an array, so we need to iterate through it
+      segments = nil
+      unless hash['segments'].nil?
+        segments = []
+        hash['segments'].each do |structure|
+          segments << (CreateSegment.from_hash(structure) if structure)
+        end
+      end
+
+      segments = SKIP unless hash.key?('segments')
+
+      # Create object from extracted values.
+      BulkCreateSegments.new(segments)
+    end
+  end
+end

data/lib/advanced_billing/models/bulk_update_segments.rb

@@ -0,0 +1,59 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # BulkUpdateSegments Model.
+  class BulkUpdateSegments < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[BulkUpdateSegmentsItem]]
+    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
+      %w[
+        segments
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(segments = SKIP)
+      @segments = segments unless segments == 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.
+      # Parameter is an array, so we need to iterate through it
+      segments = nil
+      unless hash['segments'].nil?
+        segments = []
+        hash['segments'].each do |structure|
+          segments << (BulkUpdateSegmentsItem.from_hash(structure) if structure)
+        end
+      end
+
+      segments = SKIP unless hash.key?('segments')
+
+      # Create object from extracted values.
+      BulkUpdateSegments.new(segments)
+    end
+  end
+end

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 handle for the pricing scheme. Available options: per_unit, volume,
+    # tiered, stairstep. See [Price Bracket
+    # Rules](https://help.chargify.com/products/product-components.html#price-br
+    # acket-rules) for an overview of pricing schemes.
+    # @return [String]
+    attr_accessor :pricing_scheme
+
+    # The handle for the pricing scheme. Available options: per_unit, volume,
+    # tiered, stairstep. See [Price Bracket
+    # Rules](https://help.chargify.com/products/product-components.html#price-br
+    # acket-rules) 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,78 @@
+# 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,30 @@
+# 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
+    ].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,62 @@
+# 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,56 @@
+# 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 BOGUS
+      BOGUS = 'bogus'.freeze,
+
+      # TODO: Write general description for VISA
+      VISA = 'visa'.freeze,
+
+      # TODO: Write general description for MASTER
+      MASTER = 'master'.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 DINERS_CLUB
+      DINERS_CLUB = 'diners_club'.freeze,
+
+      # TODO: Write general description for JCB
+      JCB = 'jcb'.freeze,
+
+      # TODO: Write general description for SWITCH
+      SWITCH = 'switch'.freeze,
+
+      # TODO: Write general description for SOLO
+      SOLO = 'solo'.freeze,
+
+      # TODO: Write general description for DANKORT
+      DANKORT = 'dankort'.freeze,
+
+      # TODO: Write general description for MAESTRO
+      MAESTRO = 'maestro'.freeze,
+
+      # TODO: Write general description for LASER
+      LASER = 'laser'.freeze,
+
+      # TODO: Write general description for FORBRUGSFORENINGEN
+      FORBRUGSFORENINGEN = 'forbrugsforeningen'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CARD_TYPE.include?(value)
+    end
+  end
+end