orb-apiamtic-sdk 0.0.1

data/lib/api_reference/models/edit_adjustment_interval_params.rb

@@ -0,0 +1,130 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # EditAdjustmentIntervalParams Model.
+  class EditAdjustmentIntervalParams < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The id of the adjustment interval to edit.
+    # @return [String]
+    attr_accessor :adjustment_interval_id
+
+    # The updated start date of this adjustment interval. If not specified, the
+    # start date will not be updated.
+    # @return [Object]
+    attr_accessor :start_date
+
+    # The updated end date of this adjustment interval. If not specified, the
+    # end date will not be updated.
+    # @return [Object]
+    attr_accessor :end_date
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['adjustment_interval_id'] = 'adjustment_interval_id'
+      @_hash['start_date'] = 'start_date'
+      @_hash['end_date'] = 'end_date'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        start_date
+        end_date
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        end_date
+      ]
+    end
+
+    def initialize(adjustment_interval_id:, start_date: SKIP, end_date: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @adjustment_interval_id = adjustment_interval_id
+      @start_date = start_date unless start_date == SKIP
+      @end_date = end_date unless end_date == 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.
+      adjustment_interval_id =
+        hash.key?('adjustment_interval_id') ? hash['adjustment_interval_id'] : nil
+      start_date = hash.key?('start_date') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:EditAdjustmentIntervalParamsStartDate), hash['start_date']
+      ) : SKIP
+      end_date = hash.key?('end_date') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:EditAdjustmentIntervalParamsEndDate), hash['end_date']
+      ) : 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.
+      EditAdjustmentIntervalParams.new(adjustment_interval_id: adjustment_interval_id,
+                                       start_date: start_date,
+                                       end_date: end_date,
+                                       additional_properties: additional_properties)
+    end
+
+    def to_union_type_start_date
+      UnionTypeLookUp.get(:EditAdjustmentIntervalParamsStartDate)
+                     .validate(start_date)
+                     .serialize(start_date)
+    end
+
+    def to_union_type_end_date
+      UnionTypeLookUp.get(:EditAdjustmentIntervalParamsEndDate)
+                     .validate(end_date)
+                     .serialize(end_date)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [EditAdjustmentIntervalParams | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.adjustment_interval_id,
+                                     ->(val) { val.instance_of? String })
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['adjustment_interval_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} adjustment_interval_id: #{@adjustment_interval_id}, start_date:"\
+      " #{@start_date}, end_date: #{@end_date}, 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} adjustment_interval_id: #{@adjustment_interval_id.inspect}, start_date:"\
+      " #{@start_date.inspect}, end_date: #{@end_date.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/edit_customer.rb

@@ -0,0 +1,351 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # EditCustomer Model.
+  class EditCustomer < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # User-specified key/value pairs for the resource. Individual keys can be
+    # removed by setting the value to `null`, and the entire metadata mapping
+    # can be cleared by setting `metadata` to `null`.
+    # @return [Hash[String, String]]
+    attr_accessor :metadata
+
+    # The full name of the customer
+    # @return [String]
+    attr_accessor :name
+
+    # A valid customer email, to be used for invoicing and notifications.
+    # @return [String]
+    attr_accessor :email
+
+    # The ID of this customer in an external payments solution, such as Stripe.
+    # This is used for creating charges or invoices in the external system via
+    # Orb.
+    # @return [String]
+    attr_accessor :payment_provider_id
+
+    # This is used for creating charges or invoices in an external system via
+    # Orb. When not in test mode:
+    # - the connection must first be configured in the Orb webapp. 
+    # - if the provider is an invoicing provider (`stripe_invoice`,
+    # `quickbooks`, `bill.com`, `netsuite`), any product mappings must first be
+    # configured with the Orb team.
+    # @return [PaymentProvider1]
+    attr_accessor :payment_provider
+
+    # This is used for creating charges or invoices in an external system via
+    # Orb. When not in test mode:
+    # - the connection must first be configured in the Orb webapp. 
+    # - if the provider is an invoicing provider (`stripe_invoice`,
+    # `quickbooks`, `bill.com`, `netsuite`), any product mappings must first be
+    # configured with the Orb team.
+    # @return [AddressInput]
+    attr_accessor :shipping_address
+
+    # This is used for creating charges or invoices in an external system via
+    # Orb. When not in test mode:
+    # - the connection must first be configured in the Orb webapp. 
+    # - if the provider is an invoicing provider (`stripe_invoice`,
+    # `quickbooks`, `bill.com`, `netsuite`), any product mappings must first be
+    # configured with the Orb team.
+    # @return [AddressInput]
+    attr_accessor :billing_address
+
+    # An ISO 4217 currency string used for the customer's invoices and balance.
+    # This can only be set if the customer does not already have a currency
+    # configured. If not set at creation or update time, it will be set at
+    # subscription creation time.
+    # @return [String]
+    attr_accessor :currency
+
+    # An ISO 4217 currency string used for the customer's invoices and balance.
+    # This can only be set if the customer does not already have a currency
+    # configured. If not set at creation or update time, it will be set at
+    # subscription creation time.
+    # @return [CustomerTaxId]
+    attr_accessor :tax_id
+
+    # Used to determine if invoices for this customer will automatically attempt
+    # to charge a saved payment method, if available. This parameter defaults to
+    # `True` when a payment provider is provided on customer creation.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :auto_collection
+
+    # Used to determine if invoices for this customer will be automatically
+    # issued. If true, invoices will be automatically issued. If false, invoices
+    # will require manual approval.If `null` is specified, the customer's auto
+    # issuance setting will be inherited from the account-level setting.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :auto_issuance
+
+    # Additional email addresses for this customer. If populated, these email
+    # addresses will be CC'd for customer communications. The total number of
+    # email addresses (including the primary email) cannot exceed 50.
+    # @return [Array[String]]
+    attr_accessor :additional_emails
+
+    # Additional email addresses for this customer. If populated, these email
+    # addresses will be CC'd for customer communications. The total number of
+    # email addresses (including the primary email) cannot exceed 50.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :email_delivery
+
+    # Additional email addresses for this customer. If populated, these email
+    # addresses will be CC'd for customer communications. The total number of
+    # email addresses (including the primary email) cannot exceed 50.
+    # @return [Object]
+    attr_accessor :tax_configuration
+
+    # Additional email addresses for this customer. If populated, these email
+    # addresses will be CC'd for customer communications. The total number of
+    # email addresses (including the primary email) cannot exceed 50.
+    # @return [NewReportingConfiguration]
+    attr_accessor :reporting_configuration
+
+    # Additional email addresses for this customer. If populated, these email
+    # addresses will be CC'd for customer communications. The total number of
+    # email addresses (including the primary email) cannot exceed 50.
+    # @return [NewAccountingSyncConfiguration]
+    attr_accessor :accounting_sync_configuration
+
+    # The external customer ID. This can only be set if the customer has no
+    # existing external customer ID. Since this action may change usage
+    # quantities for all existing subscriptions, it is disallowed if the
+    # customer has issued invoices with usage line items and subject to the same
+    # restrictions as backdated subscription creation.
+    # @return [String]
+    attr_accessor :external_customer_id
+
+    # The hierarchical relationships for this customer.
+    # @return [CustomerHierarchyConfig]
+    attr_accessor :hierarchy
+
+    # Payment configuration for the customer, applicable when using Orb
+    # Invoicing with a supported payment provider such as Stripe.
+    # @return [PaymentConfiguration]
+    attr_accessor :payment_configuration
+
+    # The Orb ID of the payment method to set as this customer's default. Pass
+    # `null` to clear the customer's default payment method.
+    # @return [String]
+    attr_accessor :default_payment_method_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['metadata'] = 'metadata'
+      @_hash['name'] = 'name'
+      @_hash['email'] = 'email'
+      @_hash['payment_provider_id'] = 'payment_provider_id'
+      @_hash['payment_provider'] = 'payment_provider'
+      @_hash['shipping_address'] = 'shipping_address'
+      @_hash['billing_address'] = 'billing_address'
+      @_hash['currency'] = 'currency'
+      @_hash['tax_id'] = 'tax_id'
+      @_hash['auto_collection'] = 'auto_collection'
+      @_hash['auto_issuance'] = 'auto_issuance'
+      @_hash['additional_emails'] = 'additional_emails'
+      @_hash['email_delivery'] = 'email_delivery'
+      @_hash['tax_configuration'] = 'tax_configuration'
+      @_hash['reporting_configuration'] = 'reporting_configuration'
+      @_hash['accounting_sync_configuration'] =
+        'accounting_sync_configuration'
+      @_hash['external_customer_id'] = 'external_customer_id'
+      @_hash['hierarchy'] = 'hierarchy'
+      @_hash['payment_configuration'] = 'payment_configuration'
+      @_hash['default_payment_method_id'] = 'default_payment_method_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        metadata
+        name
+        email
+        payment_provider_id
+        payment_provider
+        shipping_address
+        billing_address
+        currency
+        tax_id
+        auto_collection
+        auto_issuance
+        additional_emails
+        email_delivery
+        tax_configuration
+        reporting_configuration
+        accounting_sync_configuration
+        external_customer_id
+        hierarchy
+        payment_configuration
+        default_payment_method_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        metadata
+        name
+        email
+        payment_provider_id
+        payment_provider
+        shipping_address
+        billing_address
+        currency
+        tax_id
+        auto_collection
+        auto_issuance
+        additional_emails
+        email_delivery
+        tax_configuration
+        reporting_configuration
+        accounting_sync_configuration
+        external_customer_id
+        hierarchy
+        payment_configuration
+        default_payment_method_id
+      ]
+    end
+
+    def initialize(metadata: SKIP, name: SKIP, email: SKIP,
+                   payment_provider_id: SKIP, payment_provider: SKIP,
+                   shipping_address: SKIP, billing_address: SKIP,
+                   currency: SKIP, tax_id: SKIP, auto_collection: SKIP,
+                   auto_issuance: SKIP, additional_emails: SKIP,
+                   email_delivery: SKIP, tax_configuration: SKIP,
+                   reporting_configuration: SKIP,
+                   accounting_sync_configuration: SKIP,
+                   external_customer_id: SKIP, hierarchy: SKIP,
+                   payment_configuration: SKIP, default_payment_method_id: SKIP)
+      @metadata = metadata unless metadata == SKIP
+      @name = name unless name == SKIP
+      @email = email unless email == SKIP
+      @payment_provider_id = payment_provider_id unless payment_provider_id == SKIP
+      @payment_provider = payment_provider unless payment_provider == SKIP
+      @shipping_address = shipping_address unless shipping_address == SKIP
+      @billing_address = billing_address unless billing_address == SKIP
+      @currency = currency unless currency == SKIP
+      @tax_id = tax_id unless tax_id == SKIP
+      @auto_collection = auto_collection unless auto_collection == SKIP
+      @auto_issuance = auto_issuance unless auto_issuance == SKIP
+      @additional_emails = additional_emails unless additional_emails == SKIP
+      @email_delivery = email_delivery unless email_delivery == SKIP
+      @tax_configuration = tax_configuration unless tax_configuration == SKIP
+      @reporting_configuration = reporting_configuration unless reporting_configuration == SKIP
+      unless accounting_sync_configuration == SKIP
+        @accounting_sync_configuration =
+          accounting_sync_configuration
+      end
+      @external_customer_id = external_customer_id unless external_customer_id == SKIP
+      @hierarchy = hierarchy unless hierarchy == SKIP
+      @payment_configuration = payment_configuration unless payment_configuration == SKIP
+      unless default_payment_method_id == SKIP
+        @default_payment_method_id =
+          default_payment_method_id
+      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.
+      metadata = hash.key?('metadata') ? hash['metadata'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+      email = hash.key?('email') ? hash['email'] : SKIP
+      payment_provider_id =
+        hash.key?('payment_provider_id') ? hash['payment_provider_id'] : SKIP
+      payment_provider =
+        hash.key?('payment_provider') ? hash['payment_provider'] : SKIP
+      shipping_address = AddressInput.from_hash(hash['shipping_address']) if
+        hash['shipping_address']
+      billing_address = AddressInput.from_hash(hash['billing_address']) if hash['billing_address']
+      currency = hash.key?('currency') ? hash['currency'] : SKIP
+      tax_id = CustomerTaxId.from_hash(hash['tax_id']) if hash['tax_id']
+      auto_collection =
+        hash.key?('auto_collection') ? hash['auto_collection'] : SKIP
+      auto_issuance = hash.key?('auto_issuance') ? hash['auto_issuance'] : SKIP
+      additional_emails =
+        hash.key?('additional_emails') ? hash['additional_emails'] : SKIP
+      email_delivery =
+        hash.key?('email_delivery') ? hash['email_delivery'] : SKIP
+      tax_configuration =
+        hash.key?('tax_configuration') ? hash['tax_configuration'] : SKIP
+      if hash['reporting_configuration']
+        reporting_configuration = NewReportingConfiguration.from_hash(hash['reporting_configuration'])
+      end
+      if hash['accounting_sync_configuration']
+        accounting_sync_configuration = NewAccountingSyncConfiguration.from_hash(hash['accounting_sync_configuration'])
+      end
+      external_customer_id =
+        hash.key?('external_customer_id') ? hash['external_customer_id'] : SKIP
+      hierarchy = CustomerHierarchyConfig.from_hash(hash['hierarchy']) if hash['hierarchy']
+      payment_configuration = PaymentConfiguration.from_hash(hash['payment_configuration']) if
+        hash['payment_configuration']
+      default_payment_method_id =
+        hash.key?('default_payment_method_id') ? hash['default_payment_method_id'] : SKIP
+
+      # Create object from extracted values.
+      EditCustomer.new(metadata: metadata,
+                       name: name,
+                       email: email,
+                       payment_provider_id: payment_provider_id,
+                       payment_provider: payment_provider,
+                       shipping_address: shipping_address,
+                       billing_address: billing_address,
+                       currency: currency,
+                       tax_id: tax_id,
+                       auto_collection: auto_collection,
+                       auto_issuance: auto_issuance,
+                       additional_emails: additional_emails,
+                       email_delivery: email_delivery,
+                       tax_configuration: tax_configuration,
+                       reporting_configuration: reporting_configuration,
+                       accounting_sync_configuration: accounting_sync_configuration,
+                       external_customer_id: external_customer_id,
+                       hierarchy: hierarchy,
+                       payment_configuration: payment_configuration,
+                       default_payment_method_id: default_payment_method_id)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} metadata: #{@metadata}, name: #{@name}, email: #{@email},"\
+      " payment_provider_id: #{@payment_provider_id}, payment_provider: #{@payment_provider},"\
+      " shipping_address: #{@shipping_address}, billing_address: #{@billing_address}, currency:"\
+      " #{@currency}, tax_id: #{@tax_id}, auto_collection: #{@auto_collection}, auto_issuance:"\
+      " #{@auto_issuance}, additional_emails: #{@additional_emails}, email_delivery:"\
+      " #{@email_delivery}, tax_configuration: #{@tax_configuration}, reporting_configuration:"\
+      " #{@reporting_configuration}, accounting_sync_configuration:"\
+      " #{@accounting_sync_configuration}, external_customer_id: #{@external_customer_id},"\
+      " hierarchy: #{@hierarchy}, payment_configuration: #{@payment_configuration},"\
+      " default_payment_method_id: #{@default_payment_method_id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} metadata: #{@metadata.inspect}, name: #{@name.inspect}, email:"\
+      " #{@email.inspect}, payment_provider_id: #{@payment_provider_id.inspect}, payment_provider:"\
+      " #{@payment_provider.inspect}, shipping_address: #{@shipping_address.inspect},"\
+      " billing_address: #{@billing_address.inspect}, currency: #{@currency.inspect}, tax_id:"\
+      " #{@tax_id.inspect}, auto_collection: #{@auto_collection.inspect}, auto_issuance:"\
+      " #{@auto_issuance.inspect}, additional_emails: #{@additional_emails.inspect},"\
+      " email_delivery: #{@email_delivery.inspect}, tax_configuration:"\
+      " #{@tax_configuration.inspect}, reporting_configuration:"\
+      " #{@reporting_configuration.inspect}, accounting_sync_configuration:"\
+      " #{@accounting_sync_configuration.inspect}, external_customer_id:"\
+      " #{@external_customer_id.inspect}, hierarchy: #{@hierarchy.inspect}, payment_configuration:"\
+      " #{@payment_configuration.inspect}, default_payment_method_id:"\
+      " #{@default_payment_method_id.inspect}>"
+    end
+  end
+end

data/lib/api_reference/models/edit_dimensional_price_group.rb

@@ -0,0 +1,86 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # EditDimensionalPriceGroup Model.
+  class EditDimensionalPriceGroup < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # User-specified key/value pairs for the resource. Individual keys can be
+    # removed by setting the value to `null`, and the entire metadata mapping
+    # can be cleared by setting `metadata` to `null`.
+    # @return [Hash[String, String]]
+    attr_accessor :metadata
+
+    # An optional user-defined ID for this dimensional price group resource,
+    # used throughout the system as an alias for this dimensional price group.
+    # Use this field to identify a dimensional price group by an existing
+    # identifier in your system.
+    # @return [String]
+    attr_accessor :external_dimensional_price_group_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['metadata'] = 'metadata'
+      @_hash['external_dimensional_price_group_id'] =
+        'external_dimensional_price_group_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        metadata
+        external_dimensional_price_group_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        metadata
+        external_dimensional_price_group_id
+      ]
+    end
+
+    def initialize(metadata: SKIP, external_dimensional_price_group_id: SKIP)
+      @metadata = metadata unless metadata == SKIP
+      unless external_dimensional_price_group_id == SKIP
+        @external_dimensional_price_group_id =
+          external_dimensional_price_group_id
+      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.
+      metadata = hash.key?('metadata') ? hash['metadata'] : SKIP
+      external_dimensional_price_group_id =
+        hash.key?('external_dimensional_price_group_id') ? hash['external_dimensional_price_group_id'] : SKIP
+
+      # Create object from extracted values.
+      EditDimensionalPriceGroup.new(metadata: metadata,
+                                    external_dimensional_price_group_id: external_dimensional_price_group_id)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} metadata: #{@metadata}, external_dimensional_price_group_id:"\
+      " #{@external_dimensional_price_group_id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} metadata: #{@metadata.inspect}, external_dimensional_price_group_id:"\
+      " #{@external_dimensional_price_group_id.inspect}>"
+    end
+  end
+end

data/lib/api_reference/models/edit_plan.rb

@@ -0,0 +1,91 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # EditPlan Model.
+  class EditPlan < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # User-specified key/value pairs for the resource. Individual keys can be
+    # removed by setting the value to `null`, and the entire metadata mapping
+    # can be cleared by setting `metadata` to `null`.
+    # @return [Hash[String, String]]
+    attr_accessor :metadata
+
+    # An optional user-defined ID for this plan resource, used throughout the
+    # system as an alias for this Plan. Use this field to identify a plan by an
+    # existing identifier in your system.
+    # @return [String]
+    attr_accessor :external_plan_id
+
+    # An optional user-defined description of the plan.
+    # @return [String]
+    attr_accessor :description
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['metadata'] = 'metadata'
+      @_hash['external_plan_id'] = 'external_plan_id'
+      @_hash['description'] = 'description'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        metadata
+        external_plan_id
+        description
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        metadata
+        external_plan_id
+        description
+      ]
+    end
+
+    def initialize(metadata: SKIP, external_plan_id: SKIP, description: SKIP)
+      @metadata = metadata unless metadata == SKIP
+      @external_plan_id = external_plan_id unless external_plan_id == SKIP
+      @description = description unless description == 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.
+      metadata = hash.key?('metadata') ? hash['metadata'] : SKIP
+      external_plan_id =
+        hash.key?('external_plan_id') ? hash['external_plan_id'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+
+      # Create object from extracted values.
+      EditPlan.new(metadata: metadata,
+                   external_plan_id: external_plan_id,
+                   description: description)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} metadata: #{@metadata}, external_plan_id: #{@external_plan_id},"\
+      " description: #{@description}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} metadata: #{@metadata.inspect}, external_plan_id:"\
+      " #{@external_plan_id.inspect}, description: #{@description.inspect}>"
+    end
+  end
+end