orb-apiamtic-sdk 0.0.1

data/lib/api_reference/models/plan_version_change.rb

@@ -0,0 +1,143 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # PlanVersionChange Model.
+  class PlanVersionChange < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique identifier for this plan version change.
+    # @return [String]
+    attr_accessor :id
+
+    # The ID of the plan being migrated.
+    # @return [String]
+    attr_accessor :plan_id
+
+    # When the migration takes effect. Can be a specific date/time, or
+    # 'end_of_term' when scheduled to be at the end of the current billing
+    # period.
+    # @return [Object]
+    attr_accessor :effective_time
+
+    # Current status of the migration: 'not_started', 'in_progress',
+    # 'completed', 'action_needed', or 'canceled'.
+    # @return [Status18]
+    attr_accessor :status
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['plan_id'] = 'plan_id'
+      @_hash['effective_time'] = 'effective_time'
+      @_hash['status'] = 'status'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        effective_time
+      ]
+    end
+
+    def initialize(id:, plan_id:, effective_time:, status:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id
+      @plan_id = plan_id
+      @effective_time = effective_time
+      @status = status
+      @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.
+      id = hash.key?('id') ? hash['id'] : nil
+      plan_id = hash.key?('plan_id') ? hash['plan_id'] : nil
+      effective_time = hash.key?('effective_time') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:PlanVersionChangeEffectiveTime), hash['effective_time']
+      ) : nil
+      status = hash.key?('status') ? hash['status'] : nil
+
+      # 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.
+      PlanVersionChange.new(id: id,
+                            plan_id: plan_id,
+                            effective_time: effective_time,
+                            status: status,
+                            additional_properties: additional_properties)
+    end
+
+    def to_union_type_effective_time
+      UnionTypeLookUp.get(:PlanVersionChangeEffectiveTime)
+                     .validate(effective_time)
+                     .serialize(effective_time)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [PlanVersionChange | 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? String }) and
+            APIHelper.valid_type?(value.plan_id,
+                                  ->(val) { val.instance_of? String }) and
+            UnionTypeLookUp.get(:PlanVersionChangeEffectiveTime)
+                           .validate(value.effective_time) and
+            APIHelper.valid_type?(value.status,
+                                  ->(val) { Status18.validate(val) })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['id'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['plan_id'],
+                                ->(val) { val.instance_of? String }) and
+          UnionTypeLookUp.get(:PlanVersionChangeEffectiveTime)
+                         .validate(value['effective_time']) and
+          APIHelper.valid_type?(value['status'],
+                                ->(val) { Status18.validate(val) })
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, plan_id: #{@plan_id}, effective_time: #{@effective_time},"\
+      " status: #{@status}, 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} id: #{@id.inspect}, plan_id: #{@plan_id.inspect}, effective_time:"\
+      " #{@effective_time.inspect}, status: #{@status.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/plan_version_changes.rb

@@ -0,0 +1,92 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # PlanVersionChanges Model.
+  class PlanVersionChanges < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[PlanVersionChange]]
+    attr_accessor :data
+
+    # TODO: Write general description for this method
+    # @return [PaginationMetadata]
+    attr_accessor :pagination_metadata
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['data'] = 'data'
+      @_hash['pagination_metadata'] = 'pagination_metadata'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(data:, pagination_metadata:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @data = data
+      @pagination_metadata = pagination_metadata
+      @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
+      data = nil
+      unless hash['data'].nil?
+        data = []
+        hash['data'].each do |structure|
+          data << (PlanVersionChange.from_hash(structure) if structure)
+        end
+      end
+
+      data = nil unless hash.key?('data')
+      pagination_metadata = PaginationMetadata.from_hash(hash['pagination_metadata']) if
+        hash['pagination_metadata']
+
+      # 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.
+      PlanVersionChanges.new(data: data,
+                             pagination_metadata: pagination_metadata,
+                             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} data: #{@data}, pagination_metadata: #{@pagination_metadata},"\
+      " 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} data: #{@data.inspect}, pagination_metadata:"\
+      " #{@pagination_metadata.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/plan_version_phase.rb

@@ -0,0 +1,163 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # PlanVersionPhase Model.
+  class PlanVersionPhase < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :description
+
+    # How many terms of length `duration_unit` this phase is active for. If
+    # null, this phase is evergreen and active indefinitely
+    # @return [Integer]
+    attr_accessor :duration
+
+    # How many terms of length `duration_unit` this phase is active for. If
+    # null, this phase is evergreen and active indefinitely
+    # @return [DurationUnit3]
+    attr_accessor :duration_unit
+
+    # How many terms of length `duration_unit` this phase is active for. If
+    # null, this phase is evergreen and active indefinitely
+    # @return [String]
+    attr_accessor :name
+
+    # Determines the ordering of the phase in a plan's lifecycle. 1 = first
+    # phase.
+    # @return [Integer]
+    attr_accessor :order
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['description'] = 'description'
+      @_hash['duration'] = 'duration'
+      @_hash['duration_unit'] = 'duration_unit'
+      @_hash['name'] = 'name'
+      @_hash['order'] = 'order'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        description
+        duration
+        duration_unit
+      ]
+    end
+
+    def initialize(id:, description:, duration:, duration_unit:, name:, order:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id
+      @description = description
+      @duration = duration
+      @duration_unit = duration_unit
+      @name = name
+      @order = order
+      @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.
+      id = hash.key?('id') ? hash['id'] : nil
+      description = hash.key?('description') ? hash['description'] : nil
+      duration = hash.key?('duration') ? hash['duration'] : nil
+      duration_unit = hash.key?('duration_unit') ? hash['duration_unit'] : nil
+      name = hash.key?('name') ? hash['name'] : nil
+      order = hash.key?('order') ? hash['order'] : nil
+
+      # 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.
+      PlanVersionPhase.new(id: id,
+                           description: description,
+                           duration: duration,
+                           duration_unit: duration_unit,
+                           name: name,
+                           order: order,
+                           additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [PlanVersionPhase | 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? String }) and
+            APIHelper.valid_type?(value.description,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.duration,
+                                  ->(val) { val.instance_of? Integer }) and
+            APIHelper.valid_type?(value.duration_unit,
+                                  ->(val) { DurationUnit3.validate(val) }) and
+            APIHelper.valid_type?(value.name,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.order,
+                                  ->(val) { val.instance_of? Integer })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['id'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['description'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['duration'],
+                                ->(val) { val.instance_of? Integer }) and
+          APIHelper.valid_type?(value['duration_unit'],
+                                ->(val) { DurationUnit3.validate(val) }) and
+          APIHelper.valid_type?(value['name'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['order'],
+                                ->(val) { val.instance_of? Integer })
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, description: #{@description}, duration: #{@duration},"\
+      " duration_unit: #{@duration_unit}, name: #{@name}, order: #{@order}, 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} id: #{@id.inspect}, description: #{@description.inspect}, duration:"\
+      " #{@duration.inspect}, duration_unit: #{@duration_unit.inspect}, name: #{@name.inspect},"\
+      " order: #{@order.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/plans.rb

@@ -0,0 +1,92 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # Plans Model.
+  class Plans < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[Plan]]
+    attr_accessor :data
+
+    # TODO: Write general description for this method
+    # @return [PaginationMetadata]
+    attr_accessor :pagination_metadata
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['data'] = 'data'
+      @_hash['pagination_metadata'] = 'pagination_metadata'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(data:, pagination_metadata:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @data = data
+      @pagination_metadata = pagination_metadata
+      @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
+      data = nil
+      unless hash['data'].nil?
+        data = []
+        hash['data'].each do |structure|
+          data << (Plan.from_hash(structure) if structure)
+        end
+      end
+
+      data = nil unless hash.key?('data')
+      pagination_metadata = PaginationMetadata.from_hash(hash['pagination_metadata']) if
+        hash['pagination_metadata']
+
+      # 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.
+      Plans.new(data: data,
+                pagination_metadata: pagination_metadata,
+                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} data: #{@data}, pagination_metadata: #{@pagination_metadata},"\
+      " 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} data: #{@data.inspect}, pagination_metadata:"\
+      " #{@pagination_metadata.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/portal_session.rb

@@ -0,0 +1,124 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module ApiReference
+  # PortalSession Model.
+  class PortalSession < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :customer_id
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :created_at
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :expires_at
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :url
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['customer_id'] = 'customer_id'
+      @_hash['created_at'] = 'created_at'
+      @_hash['expires_at'] = 'expires_at'
+      @_hash['url'] = 'url'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        expires_at
+      ]
+    end
+
+    def initialize(id:, customer_id:, created_at:, expires_at:, url:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id
+      @customer_id = customer_id
+      @created_at = created_at
+      @expires_at = expires_at
+      @url = url
+      @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.
+      id = hash.key?('id') ? hash['id'] : nil
+      customer_id = hash.key?('customer_id') ? hash['customer_id'] : nil
+      created_at = if hash.key?('created_at')
+                     (DateTimeHelper.from_rfc3339(hash['created_at']) if hash['created_at'])
+                   end
+      expires_at = if hash.key?('expires_at')
+                     (DateTimeHelper.from_rfc3339(hash['expires_at']) if hash['expires_at'])
+                   end
+      url = hash.key?('url') ? hash['url'] : nil
+
+      # 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.
+      PortalSession.new(id: id,
+                        customer_id: customer_id,
+                        created_at: created_at,
+                        expires_at: expires_at,
+                        url: url,
+                        additional_properties: additional_properties)
+    end
+
+    def to_custom_created_at
+      DateTimeHelper.to_rfc3339(created_at)
+    end
+
+    def to_custom_expires_at
+      DateTimeHelper.to_rfc3339(expires_at)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, customer_id: #{@customer_id}, created_at: #{@created_at},"\
+      " expires_at: #{@expires_at}, url: #{@url}, 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} id: #{@id.inspect}, customer_id: #{@customer_id.inspect}, created_at:"\
+      " #{@created_at.inspect}, expires_at: #{@expires_at.inspect}, url: #{@url.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end