orb-apiamtic-sdk 0.0.1

data/lib/api_reference/models/cadence104.rb

@@ -0,0 +1,52 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # Cadence104.
+  class Cadence104
+    CADENCE104 = [
+      # TODO: Write general description for ONE_TIME
+      ONE_TIME = 'one_time'.freeze,
+
+      # TODO: Write general description for MONTHLY
+      MONTHLY = 'monthly'.freeze,
+
+      # TODO: Write general description for QUARTERLY
+      QUARTERLY = 'quarterly'.freeze,
+
+      # TODO: Write general description for SEMI_ANNUAL
+      SEMI_ANNUAL = 'semi_annual'.freeze,
+
+      # TODO: Write general description for ANNUAL
+      ANNUAL = 'annual'.freeze,
+
+      # TODO: Write general description for CUSTOM
+      CUSTOM = 'custom'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = ONE_TIME)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'one_time' then ONE_TIME
+      when 'monthly' then MONTHLY
+      when 'quarterly' then QUARTERLY
+      when 'semi_annual' then SEMI_ANNUAL
+      when 'annual' then ANNUAL
+      when 'custom' then CUSTOM
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/api_reference/models/cadence34.rb

@@ -0,0 +1,48 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # The cadence at which to allocate the amount to the customer.
+  class Cadence34
+    CADENCE34 = [
+      # TODO: Write general description for ONE_TIME
+      ONE_TIME = 'one_time'.freeze,
+
+      # TODO: Write general description for MONTHLY
+      MONTHLY = 'monthly'.freeze,
+
+      # TODO: Write general description for QUARTERLY
+      QUARTERLY = 'quarterly'.freeze,
+
+      # TODO: Write general description for SEMI_ANNUAL
+      SEMI_ANNUAL = 'semi_annual'.freeze,
+
+      # TODO: Write general description for ANNUAL
+      ANNUAL = 'annual'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = ONE_TIME)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'one_time' then ONE_TIME
+      when 'monthly' then MONTHLY
+      when 'quarterly' then QUARTERLY
+      when 'semi_annual' then SEMI_ANNUAL
+      when 'annual' then ANNUAL
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/api_reference/models/cancel_option.rb

@@ -0,0 +1,40 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # Determines the timing of subscription cancellation
+  class CancelOption
+    CANCEL_OPTION = [
+      # TODO: Write general description for END_OF_SUBSCRIPTION_TERM
+      END_OF_SUBSCRIPTION_TERM = 'end_of_subscription_term'.freeze,
+
+      # TODO: Write general description for IMMEDIATE
+      IMMEDIATE = 'immediate'.freeze,
+
+      # TODO: Write general description for REQUESTED_DATE
+      REQUESTED_DATE = 'requested_date'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = END_OF_SUBSCRIPTION_TERM)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'end_of_subscription_term' then END_OF_SUBSCRIPTION_TERM
+      when 'immediate' then IMMEDIATE
+      when 'requested_date' then REQUESTED_DATE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/api_reference/models/cancel_subscription_params.rb

@@ -0,0 +1,102 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module ApiReference
+  # CancelSubscriptionParams Model.
+  class CancelSubscriptionParams < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Determines the timing of subscription cancellation
+    # @return [CancelOption]
+    attr_accessor :cancel_option
+
+    # The date that the cancellation should take effect. This parameter can only
+    # be passed if the `cancel_option` is `requested_date`.
+    # @return [DateTime]
+    attr_accessor :cancellation_date
+
+    # If false, this request will fail if it would void an issued invoice or
+    # create a credit note. Consider using this as a safety mechanism if you do
+    # not expect existing invoices to be changed.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :allow_invoice_credit_or_void
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['cancel_option'] = 'cancel_option'
+      @_hash['cancellation_date'] = 'cancellation_date'
+      @_hash['allow_invoice_credit_or_void'] = 'allow_invoice_credit_or_void'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        cancellation_date
+        allow_invoice_credit_or_void
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        cancellation_date
+        allow_invoice_credit_or_void
+      ]
+    end
+
+    def initialize(cancel_option:, cancellation_date: SKIP,
+                   allow_invoice_credit_or_void: true)
+      @cancel_option = cancel_option
+      @cancellation_date = cancellation_date unless cancellation_date == SKIP
+      unless allow_invoice_credit_or_void == SKIP
+        @allow_invoice_credit_or_void =
+          allow_invoice_credit_or_void
+      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.
+      cancel_option = hash.key?('cancel_option') ? hash['cancel_option'] : nil
+      cancellation_date = if hash.key?('cancellation_date')
+                            (DateTimeHelper.from_rfc3339(hash['cancellation_date']) if hash['cancellation_date'])
+                          else
+                            SKIP
+                          end
+      allow_invoice_credit_or_void =
+        hash['allow_invoice_credit_or_void'] ||= true
+
+      # Create object from extracted values.
+      CancelSubscriptionParams.new(cancel_option: cancel_option,
+                                   cancellation_date: cancellation_date,
+                                   allow_invoice_credit_or_void: allow_invoice_credit_or_void)
+    end
+
+    def to_custom_cancellation_date
+      DateTimeHelper.to_rfc3339(cancellation_date)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} cancel_option: #{@cancel_option}, cancellation_date: #{@cancellation_date},"\
+      " allow_invoice_credit_or_void: #{@allow_invoice_credit_or_void}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} cancel_option: #{@cancel_option.inspect}, cancellation_date:"\
+      " #{@cancellation_date.inspect}, allow_invoice_credit_or_void:"\
+      " #{@allow_invoice_credit_or_void.inspect}>"
+    end
+  end
+end

data/lib/api_reference/models/change_option.rb

@@ -0,0 +1,42 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # Determines when the change takes effect. Note that if `effective_date` is
+  # specified, this defaults to `effective_date`. Otherwise, this defaults to
+  # `immediate` unless it's explicitly set to `upcoming_invoice`.
+  class ChangeOption
+    CHANGE_OPTION = [
+      # TODO: Write general description for IMMEDIATE
+      IMMEDIATE = 'immediate'.freeze,
+
+      # TODO: Write general description for UPCOMING_INVOICE
+      UPCOMING_INVOICE = 'upcoming_invoice'.freeze,
+
+      # TODO: Write general description for EFFECTIVE_DATE
+      EFFECTIVE_DATE = 'effective_date'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = IMMEDIATE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'immediate' then IMMEDIATE
+      when 'upcoming_invoice' then UPCOMING_INVOICE
+      when 'effective_date' then EFFECTIVE_DATE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/api_reference/models/change_option1.rb

@@ -0,0 +1,40 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # Change Option1.
+  class ChangeOption1
+    CHANGE_OPTION1 = [
+      # TODO: Write general description for REQUESTED_DATE
+      REQUESTED_DATE = 'requested_date'.freeze,
+
+      # TODO: Write general description for END_OF_SUBSCRIPTION_TERM
+      END_OF_SUBSCRIPTION_TERM = 'end_of_subscription_term'.freeze,
+
+      # TODO: Write general description for IMMEDIATE
+      IMMEDIATE = 'immediate'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = REQUESTED_DATE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'requested_date' then REQUESTED_DATE
+      when 'end_of_subscription_term' then END_OF_SUBSCRIPTION_TERM
+      when 'immediate' then IMMEDIATE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/api_reference/models/changed_subscription_resources.rb

@@ -0,0 +1,185 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # ChangedSubscriptionResources Model.
+  class ChangedSubscriptionResources < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The credit notes that were created as part of this operation.
+    # @return [Array[CreditNote]]
+    attr_accessor :created_credit_notes
+
+    # The credit notes that were voided as part of this operation.
+    # @return [Array[CreditNote]]
+    attr_accessor :voided_credit_notes
+
+    # The invoices that were created as part of this operation.
+    # @return [Array[CreatedInvoice]]
+    attr_accessor :created_invoices
+
+    # The invoices that were voided as part of this operation.
+    # @return [Array[Invoice]]
+    attr_accessor :voided_invoices
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['created_credit_notes'] = 'created_credit_notes'
+      @_hash['voided_credit_notes'] = 'voided_credit_notes'
+      @_hash['created_invoices'] = 'created_invoices'
+      @_hash['voided_invoices'] = 'voided_invoices'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(created_credit_notes:, voided_credit_notes:,
+                   created_invoices:, voided_invoices:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @created_credit_notes = created_credit_notes
+      @voided_credit_notes = voided_credit_notes
+      @created_invoices = created_invoices
+      @voided_invoices = voided_invoices
+      @additional_properties = additional_properties
+    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
+      created_credit_notes = nil
+      unless hash['created_credit_notes'].nil?
+        created_credit_notes = []
+        hash['created_credit_notes'].each do |structure|
+          created_credit_notes << (CreditNote.from_hash(structure) if structure)
+        end
+      end
+
+      created_credit_notes = nil unless hash.key?('created_credit_notes')
+      # Parameter is an array, so we need to iterate through it
+      voided_credit_notes = nil
+      unless hash['voided_credit_notes'].nil?
+        voided_credit_notes = []
+        hash['voided_credit_notes'].each do |structure|
+          voided_credit_notes << (CreditNote.from_hash(structure) if structure)
+        end
+      end
+
+      voided_credit_notes = nil unless hash.key?('voided_credit_notes')
+      # Parameter is an array, so we need to iterate through it
+      created_invoices = nil
+      unless hash['created_invoices'].nil?
+        created_invoices = []
+        hash['created_invoices'].each do |structure|
+          created_invoices << (CreatedInvoice.from_hash(structure) if structure)
+        end
+      end
+
+      created_invoices = nil unless hash.key?('created_invoices')
+      # Parameter is an array, so we need to iterate through it
+      voided_invoices = nil
+      unless hash['voided_invoices'].nil?
+        voided_invoices = []
+        hash['voided_invoices'].each do |structure|
+          voided_invoices << (Invoice.from_hash(structure) if structure)
+        end
+      end
+
+      voided_invoices = nil unless hash.key?('voided_invoices')
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      ChangedSubscriptionResources.new(created_credit_notes: created_credit_notes,
+                                       voided_credit_notes: voided_credit_notes,
+                                       created_invoices: created_invoices,
+                                       voided_invoices: voided_invoices,
+                                       additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [ChangedSubscriptionResources | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.created_credit_notes,
+                                ->(val) { CreditNote.validate(val) },
+                                is_model_hash: true,
+                                is_inner_model_hash: true) and
+            APIHelper.valid_type?(value.voided_credit_notes,
+                                  ->(val) { CreditNote.validate(val) },
+                                  is_model_hash: true,
+                                  is_inner_model_hash: true) and
+            APIHelper.valid_type?(value.created_invoices,
+                                  ->(val) { CreatedInvoice.validate(val) },
+                                  is_model_hash: true,
+                                  is_inner_model_hash: true) and
+            APIHelper.valid_type?(value.voided_invoices,
+                                  ->(val) { Invoice.validate(val) },
+                                  is_model_hash: true,
+                                  is_inner_model_hash: true)
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['created_credit_notes'],
+                              ->(val) { CreditNote.validate(val) },
+                              is_model_hash: true,
+                              is_inner_model_hash: true) and
+          APIHelper.valid_type?(value['voided_credit_notes'],
+                                ->(val) { CreditNote.validate(val) },
+                                is_model_hash: true,
+                                is_inner_model_hash: true) and
+          APIHelper.valid_type?(value['created_invoices'],
+                                ->(val) { CreatedInvoice.validate(val) },
+                                is_model_hash: true,
+                                is_inner_model_hash: true) and
+          APIHelper.valid_type?(value['voided_invoices'],
+                                ->(val) { Invoice.validate(val) },
+                                is_model_hash: true,
+                                is_inner_model_hash: true)
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} created_credit_notes: #{@created_credit_notes}, voided_credit_notes:"\
+      " #{@voided_credit_notes}, created_invoices: #{@created_invoices}, voided_invoices:"\
+      " #{@voided_invoices}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} created_credit_notes: #{@created_credit_notes.inspect},"\
+      " voided_credit_notes: #{@voided_credit_notes.inspect}, created_invoices:"\
+      " #{@created_invoices.inspect}, voided_invoices: #{@voided_invoices.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/constraint_violation_error.rb

@@ -0,0 +1,101 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # ConstraintViolationError Model.
+  class ConstraintViolationError < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_reader :type
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_reader :status
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :detail
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :title
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['status'] = 'status'
+      @_hash['detail'] = 'detail'
+      @_hash['title'] = 'title'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        detail
+        title
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        detail
+        title
+      ]
+    end
+
+    def initialize(detail: SKIP, title: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @type = 'https://docs.withorb.com/reference/error-responses#400-constraint-violation'
+      @status = 400
+      @detail = detail unless detail == SKIP
+      @title = title unless title == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      detail = hash.key?('detail') ? hash['detail'] : SKIP
+      title = hash.key?('title') ? hash['title'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      ConstraintViolationError.new(detail: detail,
+                                   title: title,
+                                   additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} type: #{@type}, status: #{@status}, detail: #{@detail}, title: #{@title},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} type: #{@type.inspect}, status: #{@status.inspect}, detail:"\
+      " #{@detail.inspect}, title: #{@title.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/conversion_rate_tier.rb

@@ -0,0 +1,82 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # ConversionRateTier Model.
+  class ConversionRateTier < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Exclusive tier starting value
+    # @return [Float]
+    attr_accessor :first_unit
+
+    # Inclusive tier ending value. If null, this is treated as the last tier
+    # @return [Float]
+    attr_accessor :last_unit
+
+    # Amount per unit of overage
+    # @return [String]
+    attr_accessor :unit_amount
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['first_unit'] = 'first_unit'
+      @_hash['last_unit'] = 'last_unit'
+      @_hash['unit_amount'] = 'unit_amount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        last_unit
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        last_unit
+      ]
+    end
+
+    def initialize(first_unit:, unit_amount:, last_unit: SKIP)
+      @first_unit = first_unit
+      @last_unit = last_unit unless last_unit == SKIP
+      @unit_amount = unit_amount
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      first_unit = hash.key?('first_unit') ? hash['first_unit'] : nil
+      unit_amount = hash.key?('unit_amount') ? hash['unit_amount'] : nil
+      last_unit = hash.key?('last_unit') ? hash['last_unit'] : SKIP
+
+      # Create object from extracted values.
+      ConversionRateTier.new(first_unit: first_unit,
+                             unit_amount: unit_amount,
+                             last_unit: last_unit)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} first_unit: #{@first_unit}, last_unit: #{@last_unit}, unit_amount:"\
+      " #{@unit_amount}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} first_unit: #{@first_unit.inspect}, last_unit: #{@last_unit.inspect},"\
+      " unit_amount: #{@unit_amount.inspect}>"
+    end
+  end
+end