apimatic-tql-sdk 0.0.1 → 0.0.2

data/lib/freight_financials_webhook_ingestion_api/models/assignment_request.rb

@@ -0,0 +1,94 @@
+# freight_financials_webhook_ingestion_api
+#
+# This file was automatically
+# generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module FreightFinancialsWebhookIngestionApi
+  # AssignmentRequest Model.
+  class AssignmentRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Carrier]
+    attr_accessor :carrier
+
+    # TODO: Write general description for this method
+    # @return [UploadRequest]
+    attr_accessor :document
+
+    # TODO: Write general description for this method
+    # @return [Date]
+    attr_accessor :effective_date
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :status
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['carrier'] = 'carrier'
+      @_hash['document'] = 'document'
+      @_hash['effective_date'] = 'effectiveDate'
+      @_hash['status'] = 'status'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        carrier
+        document
+        effective_date
+        status
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        document
+      ]
+    end
+
+    def initialize(carrier: SKIP, document: SKIP, effective_date: SKIP,
+                   status: SKIP)
+      @carrier = carrier unless carrier == SKIP
+      @document = document unless document == SKIP
+      @effective_date = effective_date unless effective_date == SKIP
+      @status = status unless status == 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.
+      carrier = Carrier.from_hash(hash['carrier']) if hash['carrier']
+      document = UploadRequest.from_hash(hash['document']) if hash['document']
+      effective_date = hash.key?('effectiveDate') ? hash['effectiveDate'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+
+      # Create object from extracted values.
+      AssignmentRequest.new(carrier: carrier,
+                            document: document,
+                            effective_date: effective_date,
+                            status: status)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} carrier: #{@carrier}, document: #{@document}, effective_date:"\
+      " #{@effective_date}, status: #{@status}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} carrier: #{@carrier.inspect}, document: #{@document.inspect},"\
+      " effective_date: #{@effective_date.inspect}, status: #{@status.inspect}>"
+    end
+  end
+end

data/lib/freight_financials_webhook_ingestion_api/models/assignment_response.rb

@@ -0,0 +1,83 @@
+# freight_financials_webhook_ingestion_api
+#
+# This file was automatically
+# generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module FreightFinancialsWebhookIngestionApi
+  # AssignmentResponse Model.
+  class AssignmentResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [AssignmentResponseData]
+    attr_accessor :data
+
+    # TODO: Write general description for this method
+    # @return [Array[String]]
+    attr_accessor :errors
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_success
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['data'] = 'data'
+      @_hash['errors'] = 'errors'
+      @_hash['is_success'] = 'isSuccess'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        data
+        errors
+        is_success
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        data
+      ]
+    end
+
+    def initialize(data: SKIP, errors: SKIP, is_success: SKIP)
+      @data = data unless data == SKIP
+      @errors = errors unless errors == SKIP
+      @is_success = is_success unless is_success == 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.
+      data = AssignmentResponseData.from_hash(hash['data']) if hash['data']
+      errors = hash.key?('errors') ? hash['errors'] : SKIP
+      is_success = hash.key?('isSuccess') ? hash['isSuccess'] : SKIP
+
+      # Create object from extracted values.
+      AssignmentResponse.new(data: data,
+                             errors: errors,
+                             is_success: is_success)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} data: #{@data}, errors: #{@errors}, is_success: #{@is_success}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} data: #{@data.inspect}, errors: #{@errors.inspect}, is_success:"\
+      " #{@is_success.inspect}>"
+    end
+  end
+end

data/lib/{tql_otr_factoring_data_exchange/models/assignment_response.rb → freight_financials_webhook_ingestion_api/models/assignment_response_data.rb}

@@ -1,126 +1,124 @@
-# tql_otr_factoring_data_exchange
-#
-# This file was automatically generated by
-# APIMATIC v3.0 ( https://www.apimatic.io ).
-
-require 'date'
-module TqlOtrFactoringDataExchange
-  # Acknowledgement that the assignment was recorded.
-  class AssignmentResponse < BaseModel
-    SKIP = Object.new
-    private_constant :SKIP
-
-    # System-generated unique identifier for this assignment record.
-    # @return [UUID | String]
-    attr_accessor :assignment_id
-
-    # Carrier that was assigned/unassigned.
-    # @return [Carrier1]
-    attr_accessor :carrier
-
-    # Whether the factoring company is assigned to or unassigned from the
-    # carrier.
-    # @return [AssignmentStatus]
-    attr_accessor :status
-
-    # The effective date that was recorded.
-    # @return [Date]
-    attr_accessor :effective_date
-
-    # UTC timestamp when TQL recorded this assignment.
-    # @return [DateTime]
-    attr_accessor :recorded_at
-
-    # A mapping from model property names to API property names.
-    def self.names
-      @_hash = {} if @_hash.nil?
-      @_hash['assignment_id'] = 'assignmentId'
-      @_hash['carrier'] = 'carrier'
-      @_hash['status'] = 'status'
-      @_hash['effective_date'] = 'effectiveDate'
-      @_hash['recorded_at'] = 'recordedAt'
-      @_hash
-    end
-
-    # An array for optional fields
-    def self.optionals
-      %w[
-        assignment_id
-        carrier
-        status
-        effective_date
-        recorded_at
-      ]
-    end
-
-    # An array for nullable fields
-    def self.nullables
-      []
-    end
-
-    def initialize(assignment_id: SKIP, carrier: SKIP, status: SKIP,
-                   effective_date: SKIP, recorded_at: SKIP,
-                   additional_properties: nil)
-      # Add additional model properties to the instance
-      additional_properties = {} if additional_properties.nil?
-
-      @assignment_id = assignment_id unless assignment_id == SKIP
-      @carrier = carrier unless carrier == SKIP
-      @status = status unless status == SKIP
-      @effective_date = effective_date unless effective_date == SKIP
-      @recorded_at = recorded_at unless recorded_at == 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.
-      assignment_id = hash.key?('assignmentId') ? hash['assignmentId'] : SKIP
-      carrier = Carrier1.from_hash(hash['carrier']) if hash['carrier']
-      status = hash.key?('status') ? hash['status'] : SKIP
-      effective_date = hash.key?('effectiveDate') ? hash['effectiveDate'] : SKIP
-      recorded_at = if hash.key?('recordedAt')
-                      (DateTimeHelper.from_rfc3339(hash['recordedAt']) if hash['recordedAt'])
-                    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.
-      AssignmentResponse.new(assignment_id: assignment_id,
-                             carrier: carrier,
-                             status: status,
-                             effective_date: effective_date,
-                             recorded_at: recorded_at,
-                             additional_properties: additional_properties)
-    end
-
-    def to_custom_recorded_at
-      DateTimeHelper.to_rfc3339(recorded_at)
-    end
-
-    # Provides a human-readable string representation of the object.
-    def to_s
-      class_name = self.class.name.split('::').last
-      "<#{class_name} assignment_id: #{@assignment_id}, carrier: #{@carrier}, status: #{@status},"\
-      " effective_date: #{@effective_date}, recorded_at: #{@recorded_at}, 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} assignment_id: #{@assignment_id.inspect}, carrier: #{@carrier.inspect},"\
-      " status: #{@status.inspect}, effective_date: #{@effective_date.inspect}, recorded_at:"\
-      " #{@recorded_at.inspect}, additional_properties: #{@additional_properties}>"
-    end
-  end
-end
+# freight_financials_webhook_ingestion_api
+#
+# This file was automatically
+# generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module FreightFinancialsWebhookIngestionApi
+  # AssignmentResponseData Model.
+  class AssignmentResponseData < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [UUID | String]
+    attr_accessor :assignment_id
+
+    # TODO: Write general description for this method
+    # @return [Carrier]
+    attr_accessor :carrier
+
+    # TODO: Write general description for this method
+    # @return [Date]
+    attr_accessor :effective_date
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :recorded_at
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :status
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['assignment_id'] = 'assignmentId'
+      @_hash['carrier'] = 'carrier'
+      @_hash['effective_date'] = 'effectiveDate'
+      @_hash['recorded_at'] = 'recordedAt'
+      @_hash['status'] = 'status'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        assignment_id
+        carrier
+        effective_date
+        recorded_at
+        status
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(assignment_id: SKIP, carrier: SKIP, effective_date: SKIP,
+                   recorded_at: SKIP, status: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @assignment_id = assignment_id unless assignment_id == SKIP
+      @carrier = carrier unless carrier == SKIP
+      @effective_date = effective_date unless effective_date == SKIP
+      @recorded_at = recorded_at unless recorded_at == SKIP
+      @status = status unless status == 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.
+      assignment_id = hash.key?('assignmentId') ? hash['assignmentId'] : SKIP
+      carrier = Carrier.from_hash(hash['carrier']) if hash['carrier']
+      effective_date = hash.key?('effectiveDate') ? hash['effectiveDate'] : SKIP
+      recorded_at = if hash.key?('recordedAt')
+                      (DateTimeHelper.from_rfc3339(hash['recordedAt']) if hash['recordedAt'])
+                    else
+                      SKIP
+                    end
+      status = hash.key?('status') ? hash['status'] : 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.
+      AssignmentResponseData.new(assignment_id: assignment_id,
+                                 carrier: carrier,
+                                 effective_date: effective_date,
+                                 recorded_at: recorded_at,
+                                 status: status,
+                                 additional_properties: additional_properties)
+    end
+
+    def to_custom_recorded_at
+      DateTimeHelper.to_rfc3339(recorded_at)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} assignment_id: #{@assignment_id}, carrier: #{@carrier}, effective_date:"\
+      " #{@effective_date}, recorded_at: #{@recorded_at}, 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} assignment_id: #{@assignment_id.inspect}, carrier: #{@carrier.inspect},"\
+      " effective_date: #{@effective_date.inspect}, recorded_at: #{@recorded_at.inspect}, status:"\
+      " #{@status.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/{tql_otr_factoring_data_exchange → freight_financials_webhook_ingestion_api}/models/base_model.rb

@@ -1,110 +1,110 @@
-# tql_otr_factoring_data_exchange
-#
-# This file was automatically generated by
-# APIMATIC v3.0 ( https://www.apimatic.io ).
-
-module TqlOtrFactoringDataExchange
-  # Base model.
-  # rubocop:disable all
-  class BaseModel < CoreLibrary::BaseModel
-    # Returns a Hash representation of the current object.
-    def to_hash
-      # validating the model being serialized
-      self.class.validate(self) if self.class.respond_to?(:validate)
-
-      hash = {}
-      instance_variables.each do |name|
-        value = instance_variable_get(name)
-        name = name[1..]
-        if name == 'additional_properties'
-          additional_properties = process_additional_properties(value, self.class.names)
-          hash.merge!(additional_properties)
-        else
-          key = self.class.names.key?(name) ? self.class.names[name] : name
-          optional_fields = self.class.optionals
-          nullable_fields = self.class.nullables
-          if value.nil?
-            next unless nullable_fields.include?(name)
-
-            if !optional_fields.include?(name) && !nullable_fields.include?(name)
-              raise ArgumentError,
-                    "`#{name}` cannot be nil in `#{self.class}`. Please specify a valid value."
-            end
-          end
-
-          hash[key] = nil
-          unless value.nil?
-            if respond_to?("to_custom_#{name}")
-              if (value.instance_of? Array) || (value.instance_of? Hash)
-                params = [hash, key]
-                hash[key] = send("to_custom_#{name}", *params)
-              else
-                hash[key] = send("to_custom_#{name}")
-              end
-            elsif respond_to?("to_union_type_#{name}")
-              hash[key] = send("to_union_type_#{name}")
-            elsif value.instance_of? Array
-              hash[key] = value.map { |v| v.is_a?(BaseModel) ? v.to_hash : v }
-            elsif value.instance_of? Hash
-              hash[key] = {}
-              value.each do |k, v|
-                hash[key][k] = v.is_a?(BaseModel) ? v.to_hash : v
-              end
-            else
-              hash[key] = value.is_a?(BaseModel) ? value.to_hash : value
-            end
-          end
-        end
-      end
-      hash
-    end
-
-    # Processes additional properties, ensuring no conflicts with existing properties.
-    def process_additional_properties(additional_properties, existing_prop_names)
-      hash = {}
-      additional_properties.each do |name, value|
-        check_for_conflict(name, existing_prop_names)
-
-        hash[name] = if value.is_a?(Array)
-                       process_array(value)
-                     elsif value.is_a?(Hash)
-                       process_hash(value)
-                     else
-                       process_basic_value(value)
-                     end
-      end
-      hash
-    end
-
-    # Checks if an additional property conflicts with a model's existing property.
-    def check_for_conflict(name, existing_prop_names)
-      return unless existing_prop_names.key?(name)
-
-      raise ArgumentError, "An additional property key, '#{name}' conflicts with one of the model's properties"
-    end
-
-    # Processes an array of values, recursively calling `to_hash` on BaseModel objects.
-    def process_array(value)
-      value.map { |v| v.is_a?(BaseModel) ? v.to_hash : v }
-    end
-
-    # Processes a hash of values, recursively calling `to_hash` on BaseModel objects.
-    def process_hash(value)
-      value.transform_values do |v|
-        v.is_a?(BaseModel) ? v.to_hash : v
-      end
-    end
-
-    # Processes a basic value (non-array, non-hash).
-    def process_basic_value(value)
-      value.is_a?(BaseModel) ? value.to_hash : value
-    end
-
-    # Returns a JSON representation of the curent object.
-    def to_json(options = {})
-      hash = to_hash
-      hash.to_json(options)
-    end
-  end
-  # rubocop:enable all
-end
+# freight_financials_webhook_ingestion_api
+#
+# This file was automatically
+# generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module FreightFinancialsWebhookIngestionApi
+  # Base model.
+  # rubocop:disable all
+  class BaseModel < CoreLibrary::BaseModel
+    # Returns a Hash representation of the current object.
+    def to_hash
+      # validating the model being serialized
+      self.class.validate(self) if self.class.respond_to?(:validate)
+
+      hash = {}
+      instance_variables.each do |name|
+        value = instance_variable_get(name)
+        name = name[1..]
+        if name == 'additional_properties'
+          additional_properties = process_additional_properties(value, self.class.names)
+          hash.merge!(additional_properties)
+        else
+          key = self.class.names.key?(name) ? self.class.names[name] : name
+          optional_fields = self.class.optionals
+          nullable_fields = self.class.nullables
+          if value.nil?
+            next unless nullable_fields.include?(name)
+
+            if !optional_fields.include?(name) && !nullable_fields.include?(name)
+              raise ArgumentError,
+                    "`#{name}` cannot be nil in `#{self.class}`. Please specify a valid value."
+            end
+          end
+
+          hash[key] = nil
+          unless value.nil?
+            if respond_to?("to_custom_#{name}")
+              if (value.instance_of? Array) || (value.instance_of? Hash)
+                params = [hash, key]
+                hash[key] = send("to_custom_#{name}", *params)
+              else
+                hash[key] = send("to_custom_#{name}")
+              end
+            elsif respond_to?("to_union_type_#{name}")
+              hash[key] = send("to_union_type_#{name}")
+            elsif value.instance_of? Array
+              hash[key] = value.map { |v| v.is_a?(BaseModel) ? v.to_hash : v }
+            elsif value.instance_of? Hash
+              hash[key] = {}
+              value.each do |k, v|
+                hash[key][k] = v.is_a?(BaseModel) ? v.to_hash : v
+              end
+            else
+              hash[key] = value.is_a?(BaseModel) ? value.to_hash : value
+            end
+          end
+        end
+      end
+      hash
+    end
+
+    # Processes additional properties, ensuring no conflicts with existing properties.
+    def process_additional_properties(additional_properties, existing_prop_names)
+      hash = {}
+      additional_properties.each do |name, value|
+        check_for_conflict(name, existing_prop_names)
+
+        hash[name] = if value.is_a?(Array)
+                       process_array(value)
+                     elsif value.is_a?(Hash)
+                       process_hash(value)
+                     else
+                       process_basic_value(value)
+                     end
+      end
+      hash
+    end
+
+    # Checks if an additional property conflicts with a model's existing property.
+    def check_for_conflict(name, existing_prop_names)
+      return unless existing_prop_names.key?(name)
+
+      raise ArgumentError, "An additional property key, '#{name}' conflicts with one of the model's properties"
+    end
+
+    # Processes an array of values, recursively calling `to_hash` on BaseModel objects.
+    def process_array(value)
+      value.map { |v| v.is_a?(BaseModel) ? v.to_hash : v }
+    end
+
+    # Processes a hash of values, recursively calling `to_hash` on BaseModel objects.
+    def process_hash(value)
+      value.transform_values do |v|
+        v.is_a?(BaseModel) ? v.to_hash : v
+      end
+    end
+
+    # Processes a basic value (non-array, non-hash).
+    def process_basic_value(value)
+      value.is_a?(BaseModel) ? value.to_hash : value
+    end
+
+    # Returns a JSON representation of the curent object.
+    def to_json(options = {})
+      hash = to_hash
+      hash.to_json(options)
+    end
+  end
+  # rubocop:enable all
+end