orb-apiamtic-sdk 0.0.1

data/lib/api_reference/models/subscription_change_list_response.rb

@@ -0,0 +1,152 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module ApiReference
+  # SubscriptionChangeListResponse Model.
+  class SubscriptionChangeListResponse < 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 [Status12]
+    attr_accessor :status
+
+    # When this change was applied.
+    # @return [DateTime]
+    attr_accessor :applied_at
+
+    # When this change was cancelled.
+    # @return [DateTime]
+    attr_accessor :cancelled_at
+
+    # Subscription change will be cancelled at this time and can no longer be
+    # applied.
+    # @return [DateTime]
+    attr_accessor :expiration_time
+
+    # Subscription change will be cancelled at this time and can no longer be
+    # applied.
+    # @return [String]
+    attr_accessor :subscription_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['status'] = 'status'
+      @_hash['applied_at'] = 'applied_at'
+      @_hash['cancelled_at'] = 'cancelled_at'
+      @_hash['expiration_time'] = 'expiration_time'
+      @_hash['subscription_id'] = 'subscription_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        applied_at
+        cancelled_at
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        applied_at
+        cancelled_at
+        subscription_id
+      ]
+    end
+
+    def initialize(id:, status:, expiration_time:, subscription_id:,
+                   applied_at: SKIP, cancelled_at: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id
+      @status = status
+      @applied_at = applied_at unless applied_at == SKIP
+      @cancelled_at = cancelled_at unless cancelled_at == SKIP
+      @expiration_time = expiration_time
+      @subscription_id = subscription_id
+      @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
+      status = hash.key?('status') ? hash['status'] : nil
+      expiration_time = if hash.key?('expiration_time')
+                          (DateTimeHelper.from_rfc3339(hash['expiration_time']) if hash['expiration_time'])
+                        end
+      subscription_id =
+        hash.key?('subscription_id') ? hash['subscription_id'] : nil
+      applied_at = if hash.key?('applied_at')
+                     (DateTimeHelper.from_rfc3339(hash['applied_at']) if hash['applied_at'])
+                   else
+                     SKIP
+                   end
+      cancelled_at = if hash.key?('cancelled_at')
+                       (DateTimeHelper.from_rfc3339(hash['cancelled_at']) if hash['cancelled_at'])
+                     else
+                       SKIP
+                     end
+
+      # 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.
+      SubscriptionChangeListResponse.new(id: id,
+                                         status: status,
+                                         expiration_time: expiration_time,
+                                         subscription_id: subscription_id,
+                                         applied_at: applied_at,
+                                         cancelled_at: cancelled_at,
+                                         additional_properties: additional_properties)
+    end
+
+    def to_custom_applied_at
+      DateTimeHelper.to_rfc3339(applied_at)
+    end
+
+    def to_custom_cancelled_at
+      DateTimeHelper.to_rfc3339(cancelled_at)
+    end
+
+    def to_custom_expiration_time
+      DateTimeHelper.to_rfc3339(expiration_time)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, status: #{@status}, applied_at: #{@applied_at}, cancelled_at:"\
+      " #{@cancelled_at}, expiration_time: #{@expiration_time}, subscription_id:"\
+      " #{@subscription_id}, 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}, status: #{@status.inspect}, applied_at:"\
+      " #{@applied_at.inspect}, cancelled_at: #{@cancelled_at.inspect}, expiration_time:"\
+      " #{@expiration_time.inspect}, subscription_id: #{@subscription_id.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/subscription_change_list_responses.rb

@@ -0,0 +1,92 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # SubscriptionChangeListResponses Model.
+  class SubscriptionChangeListResponses < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[SubscriptionChangeListResponse]]
+    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 << (SubscriptionChangeListResponse.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.
+      SubscriptionChangeListResponses.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/subscription_change_minified.rb

@@ -0,0 +1,86 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # SubscriptionChangeMinified Model.
+  class SubscriptionChangeMinified < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id
+      @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
+
+      # 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.
+      SubscriptionChangeMinified.new(id: id,
+                                     additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [SubscriptionChangeMinified | 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 })
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['id'],
+                            ->(val) { val.instance_of? String })
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, 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}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/subscription_change_response.rb

@@ -0,0 +1,217 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module ApiReference
+  # A subscription change represents a desired new subscription / pending change
+  # to an existing subscription. It is a way to first preview the effects on the
+  # subscription as well as any changes/creation of invoices (see
+  # `subscription.changed_resources`).
+  class SubscriptionChangeResponse < 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 [Status12]
+    attr_accessor :status
+
+    # When this change was applied.
+    # @return [DateTime]
+    attr_accessor :applied_at
+
+    # When this change was cancelled.
+    # @return [DateTime]
+    attr_accessor :cancelled_at
+
+    # Subscription change will be cancelled at this time and can no longer be
+    # applied.
+    # @return [DateTime]
+    attr_accessor :expiration_time
+
+    # Subscription change will be cancelled at this time and can no longer be
+    # applied.
+    # @return [MutatedSubscription]
+    attr_accessor :subscription
+
+    # The type of change (e.g., 'schedule_plan_change', 'create_subscription').
+    # @return [String]
+    attr_accessor :change_type
+
+    # When this change will take effect.
+    # @return [DateTime]
+    attr_accessor :effective_date
+
+    # How the change is scheduled (e.g., 'immediate',
+    # 'end_of_subscription_term', 'requested_date').
+    # @return [String]
+    attr_accessor :change_option
+
+    # The target plan ID for plan changes.
+    # @return [String]
+    attr_accessor :plan_id
+
+    # Billing cycle alignment for plan changes.
+    # @return [String]
+    attr_accessor :billing_cycle_alignment
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['status'] = 'status'
+      @_hash['applied_at'] = 'applied_at'
+      @_hash['cancelled_at'] = 'cancelled_at'
+      @_hash['expiration_time'] = 'expiration_time'
+      @_hash['subscription'] = 'subscription'
+      @_hash['change_type'] = 'change_type'
+      @_hash['effective_date'] = 'effective_date'
+      @_hash['change_option'] = 'change_option'
+      @_hash['plan_id'] = 'plan_id'
+      @_hash['billing_cycle_alignment'] = 'billing_cycle_alignment'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        applied_at
+        cancelled_at
+        effective_date
+        change_option
+        plan_id
+        billing_cycle_alignment
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        applied_at
+        cancelled_at
+        subscription
+        effective_date
+        change_option
+        plan_id
+        billing_cycle_alignment
+      ]
+    end
+
+    def initialize(id:, status:, expiration_time:, subscription:, change_type:,
+                   applied_at: SKIP, cancelled_at: SKIP, effective_date: SKIP,
+                   change_option: SKIP, plan_id: SKIP,
+                   billing_cycle_alignment: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id
+      @status = status
+      @applied_at = applied_at unless applied_at == SKIP
+      @cancelled_at = cancelled_at unless cancelled_at == SKIP
+      @expiration_time = expiration_time
+      @subscription = subscription
+      @change_type = change_type
+      @effective_date = effective_date unless effective_date == SKIP
+      @change_option = change_option unless change_option == SKIP
+      @plan_id = plan_id unless plan_id == SKIP
+      @billing_cycle_alignment = billing_cycle_alignment unless billing_cycle_alignment == 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.
+      id = hash.key?('id') ? hash['id'] : nil
+      status = hash.key?('status') ? hash['status'] : nil
+      expiration_time = if hash.key?('expiration_time')
+                          (DateTimeHelper.from_rfc3339(hash['expiration_time']) if hash['expiration_time'])
+                        end
+      subscription = MutatedSubscription.from_hash(hash['subscription']) if hash['subscription']
+      change_type = hash.key?('change_type') ? hash['change_type'] : nil
+      applied_at = if hash.key?('applied_at')
+                     (DateTimeHelper.from_rfc3339(hash['applied_at']) if hash['applied_at'])
+                   else
+                     SKIP
+                   end
+      cancelled_at = if hash.key?('cancelled_at')
+                       (DateTimeHelper.from_rfc3339(hash['cancelled_at']) if hash['cancelled_at'])
+                     else
+                       SKIP
+                     end
+      effective_date = if hash.key?('effective_date')
+                         (DateTimeHelper.from_rfc3339(hash['effective_date']) if hash['effective_date'])
+                       else
+                         SKIP
+                       end
+      change_option = hash.key?('change_option') ? hash['change_option'] : SKIP
+      plan_id = hash.key?('plan_id') ? hash['plan_id'] : SKIP
+      billing_cycle_alignment =
+        hash.key?('billing_cycle_alignment') ? hash['billing_cycle_alignment'] : 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.
+      SubscriptionChangeResponse.new(id: id,
+                                     status: status,
+                                     expiration_time: expiration_time,
+                                     subscription: subscription,
+                                     change_type: change_type,
+                                     applied_at: applied_at,
+                                     cancelled_at: cancelled_at,
+                                     effective_date: effective_date,
+                                     change_option: change_option,
+                                     plan_id: plan_id,
+                                     billing_cycle_alignment: billing_cycle_alignment,
+                                     additional_properties: additional_properties)
+    end
+
+    def to_custom_applied_at
+      DateTimeHelper.to_rfc3339(applied_at)
+    end
+
+    def to_custom_cancelled_at
+      DateTimeHelper.to_rfc3339(cancelled_at)
+    end
+
+    def to_custom_expiration_time
+      DateTimeHelper.to_rfc3339(expiration_time)
+    end
+
+    def to_custom_effective_date
+      DateTimeHelper.to_rfc3339(effective_date)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, status: #{@status}, applied_at: #{@applied_at}, cancelled_at:"\
+      " #{@cancelled_at}, expiration_time: #{@expiration_time}, subscription: #{@subscription},"\
+      " change_type: #{@change_type}, effective_date: #{@effective_date}, change_option:"\
+      " #{@change_option}, plan_id: #{@plan_id}, billing_cycle_alignment:"\
+      " #{@billing_cycle_alignment}, 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}, status: #{@status.inspect}, applied_at:"\
+      " #{@applied_at.inspect}, cancelled_at: #{@cancelled_at.inspect}, expiration_time:"\
+      " #{@expiration_time.inspect}, subscription: #{@subscription.inspect}, change_type:"\
+      " #{@change_type.inspect}, effective_date: #{@effective_date.inspect}, change_option:"\
+      " #{@change_option.inspect}, plan_id: #{@plan_id.inspect}, billing_cycle_alignment:"\
+      " #{@billing_cycle_alignment.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/subscription_costs.rb

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