eddy 0.1.0 → 0.3.0

data/lib/definitions/elements/manual/i/I11.interchange_control_version_number.rb

@@ -0,0 +1,55 @@
+module Eddy
+  module Elements
+    # ### Element Summary:
+    #
+    # - Id: I11
+    # - Name: Interchange Control Version Number
+    # - Type: ID
+    # - Min/Max: 5/5
+    # - Description: This version number covers the interchange control segments
+    #
+    # ### Notes:
+    #
+    # - Default value: `"00401"`
+    class I11 < Eddy::Element::ID
+
+      # @param val [String] ("00401")
+      # @param req [String] (nil)
+      # @param ref [String] (nil)
+      # @return [void]
+      def initialize(val: "00401", req: nil, ref: nil)
+        @id = "I11"
+        @name = "Interchange Control Version Number"
+        @description = "This version number covers the interchange control segments"
+        super(
+          min: 5,
+          max: 5,
+          req: req,
+          ref: ref,
+          val: val,
+        )
+      end
+
+      # @return [Array<String>]
+      def code_list()
+        return [
+          "00200", # Standard Issued as ANSI X12.5-1987
+          "00201", # Draft Standard for Trial Use Approved by ASC X12 Through August 1988
+          "00204", # Draft Standard for Trial Use Approved by ASC X12 Through May 1989
+          "00300", # Standard Issued as ANSI X12.5-1992
+          "00301", # Draft Standard for Trial Use Approved for Publication by ASC X12 Procedures Review Board Through October 1990
+          "00302", # Draft Standard for Trial Use Approved for Publication by ASC X12 Procedures Review Board Through October 1991
+          "00303", # Draft Standard for Trial Use Approved for Publication by ASC X12 Procedures Review Board Through October 1992
+          "00304", # Draft Standards for Trial Use Approved for Publication by ASC X12 Procedures Review Board through October 1993
+          "00305", # Draft Standards for Trial Use Approved for Publication by ASC X12 Procedures Review Board through October 1994
+          "00306", # Draft Standards for Trial Use Approved for Publication by ASC X12 Procedures Review Board through October 1995
+          "00307", # Draft Standards for Trial Use Approved for Publication by ASC X12 Procedures Review Board through October 1996
+          "00400", # Standard Issued as ANSI X12.5-1997
+          "00401", # Draft Standards for Trial Use Approved for Publication by ASC X12 Procedures Review Board through October 1997
+          "00402", # Draft Standards for Trial Use Approved for Publication by ASC X12 Procedures Review Board through October 1998
+        ]
+      end
+
+    end
+  end
+end

data/lib/definitions/elements/manual/i/I12.interchange_control_number.rb

@@ -0,0 +1,34 @@
+module Eddy
+  module Elements
+    # ### Element Summary:
+    #
+    # - Id: I12
+    # - Name: Interchange Control Number
+    # - Type: N0
+    # - Min/Max: 9/9
+    # - Description: A control number assigned by the interchange sender
+    #
+    # ### Notes:
+    #
+    # - Values for this element need to be generated and have their uniqueness ensured.
+    class I12 < Eddy::Element::N
+      # @param val [Integer] (nil)
+      # @param req [String] (nil)
+      # @param ref [String] (nil)
+      # @return [void]
+      def initialize(val: nil, req: nil, ref: nil)
+        @id = "I12"
+        @name = "Interchange Control Number"
+        @description = "A control number assigned by the interchange sender"
+        super(
+          min: 9,
+          max: 9,
+          req: req,
+          ref: ref,
+          val: val,
+          decimals: 0,
+        )
+      end
+    end
+  end
+end

data/lib/definitions/elements/manual/i/I13.acknowledgment_requested.rb

@@ -0,0 +1,43 @@
+module Eddy
+  module Elements
+    # ### Element Summary:
+    #
+    # - Id: I13
+    # - Name: Acknowledgment Requested
+    # - Type: ID
+    # - Min/Max: 1/1
+    # - Description: Code sent by the sender to request an interchange acknowledgment (`TA1`)
+    #
+    # ### Notes:
+    #
+    # - Default value: `"0"`
+    class I13 < Eddy::Element::ID
+
+      # @param val [String] ("0")
+      # @param req [String] (nil)
+      # @param ref [String] (nil)
+      # @return [void]
+      def initialize(val: "0", req: nil, ref: nil)
+        @id = "I13"
+        @name = "Acknowledgment Requested"
+        @description = "Code sent by the sender to request an interchange acknowledgment (`TA1`)"
+        super(
+          min: 1,
+          max: 1,
+          req: req,
+          ref: ref,
+          val: val,
+        )
+      end
+
+      # @return [Array<String>]
+      def code_list()
+        return [
+          "0", # No Acknowledgment Requested
+          "1", # Interchange Acknowledgment Requested
+        ]
+      end
+
+    end
+  end
+end

data/lib/definitions/elements/manual/i/I14.usage_indicator.rb

@@ -0,0 +1,40 @@
+module Eddy
+  module Elements
+    # ### Element Summary:
+    #
+    # - Id: I14
+    # - Name: Usage Indicator
+    # - Type: ID
+    # - Min/Max: 1/1
+    # - Description: Code to indicate whether data enclosed by this interchange envelope is test, production or information
+    class I14 < Eddy::Element::ID
+
+      # @param val [String] (nil)
+      # @param req [String] (nil)
+      # @param ref [String] (nil)
+      # @return [void]
+      def initialize(val: nil, req: nil, ref: nil)
+        @id = "I14"
+        @name = "Usage Indicator"
+        @description = "Code to indicate whether data enclosed by this interchange envelope is test, production or information"
+        super(
+          min: 1,
+          max: 1,
+          req: req,
+          ref: ref,
+          val: val,
+        )
+      end
+
+      # @return [Array<String>]
+      def code_list()
+        return [
+          "I", # Information
+          "P", # Production Data
+          "T", # Test Data
+        ]
+      end
+
+    end
+  end
+end

data/lib/definitions/elements/manual/i/I15.component_element_separator.rb

@@ -0,0 +1,36 @@
+module Eddy
+  module Elements
+    # ### Element Summary:
+    #
+    # - Id: I15
+    # - Name: Component Element Separator
+    # - Type: N/A (Type is not applicable (*but it's functionally AN*))
+    # - Min/Max: 1/1
+    # - Description:
+    #   - The component element separator is a delimiter and not a data element.
+    #   - This field provides the delimiter used to separate component data elements within a composite data structure.
+    #   - This value must be different than the data element separator and the segment terminator.
+    #
+    # ### Notes:
+    #
+    # - Default value: `">"`
+    class I15 < Eddy::Element::AN
+      # @param val [String] (">")
+      # @param req [String] (nil)
+      # @param ref [String] (nil)
+      # @return [void]
+      def initialize(val: ">", req: nil, ref: nil)
+        @id = "I15"
+        @name = "Component Element Separator"
+        @description = "The delimiter used to separate component data elements within a composite data structure."
+        super(
+          min: 1,
+          max: 1,
+          req: req,
+          ref: ref,
+          val: val,
+        )
+      end
+    end
+  end
+end

data/lib/definitions/elements/manual/i/I16.number_of_included_functional_groups.rb

@@ -0,0 +1,30 @@
+module Eddy
+  module Elements
+    # ### Element Summary:
+    #
+    # - Id: I16
+    # - Name: Number of Included Functional Groups
+    # - Type: N0
+    # - Min/Max: 1/5
+    # - Description: A count of the number of functional groups included in an interchange
+    class I16 < Eddy::Element::N
+      # @param val [Integer] (nil)
+      # @param req [String] (nil)
+      # @param ref [String] (nil)
+      # @return [void]
+      def initialize(val: nil, req: nil, ref: nil)
+        @id = "I16"
+        @name = "Number of Included Functional Groups"
+        @description = "A count of the number of functional groups included in an interchange"
+        super(
+          min: 1,
+          max: 5,
+          req: req,
+          ref: ref,
+          val: val,
+          decimals: 0,
+        )
+      end
+    end
+  end
+end

data/lib/definitions/elements/manual/misc/81.weight.rb

@@ -0,0 +1,29 @@
+module Eddy
+  module Elements
+    # ### Element Summary:
+    #
+    # - Id: 81
+    # - Name: Weight
+    # - Type: R
+    # - Min/Max: 1/10
+    # - Description: Numeric value of weight
+    class E81 < Eddy::Element::R
+      # @param val [Float] (nil)
+      # @param req [String] (nil)
+      # @param ref [String] (nil)
+      # @return [void]
+      def initialize(val: nil, req: nil, ref: nil)
+        @id = "81"
+        @name = "Weight"
+        @description = "Numeric value of weight"
+        super(
+          min: 1,
+          max: 10,
+          req: req,
+          ref: ref,
+          val: val,
+        )
+      end
+    end
+  end
+end

data/lib/definitions/elements/manual/misc/93.name.rb

@@ -0,0 +1,29 @@
+module Eddy
+  module Elements
+    # ### Element Summary:
+    #
+    # - Id: 93
+    # - Name: Name
+    # - Type: AN
+    # - Min/Max: 1/60
+    # - Description: Free-form name
+    class E93 < Eddy::Element::AN
+      # @param val [String] (nil)
+      # @param req [String] (nil)
+      # @param ref [String] (nil)
+      # @return [void]
+      def initialize(val: nil, req: nil, ref: nil)
+        @id = "93"
+        @name = "Name"
+        @desctiption = "Free-form name"
+        super(
+          min: 1,
+          max: 60,
+          req: req,
+          ref: ref,
+          val: val,
+        )
+      end
+    end
+  end
+end

data/lib/definitions/segments/generated/ack.rb

@@ -0,0 +1,192 @@
+module Eddy
+  module Segments
+    # ### Segment Summary:
+    #
+    # - Id: ACK
+    # - Name: Line Item Acknowledgement
+    # - Purpose: To acknowledge the ordered quantities and specify the ready date for a specific line item
+    class ACK < Eddy::Segment
+
+      # @param store [Eddy::Data::Store]
+      # @return [void]
+      def initialize(store)
+        @id = "ACK"
+        @name = "Line Item Acknowledgement"
+        @ack01 = Eddy::Elements::E668.new(ref: "ACK01", req: "M")
+        @ack02 = Eddy::Elements::E380.new(ref: "ACK02", req: "X")
+        @ack03 = Eddy::Elements::E355.new(ref: "ACK03", req: "X")
+        @ack04 = Eddy::Elements::E374.new(ref: "ACK04", req: "O")
+        @ack05 = Eddy::Elements::E373.new(ref: "ACK05", req: "X")
+        @ack06 = Eddy::Elements::E326.new(ref: "ACK06", req: "O")
+        @ack07 = Eddy::Elements::E235.new(ref: "ACK07", req: "X")
+        @ack08 = Eddy::Elements::E234.new(ref: "ACK08", req: "X")
+        @ack09 = Eddy::Elements::E235.new(ref: "ACK09", req: "X")
+        @ack10 = Eddy::Elements::E234.new(ref: "ACK10", req: "X")
+        super(
+          store,
+          @ack01,
+          @ack02,
+          @ack03,
+          @ack04,
+          @ack05,
+          @ack06,
+          @ack07,
+          @ack08,
+          @ack09,
+          @ack10,
+        )
+      end
+
+      # ### ACK01
+      #
+      # - Id: 668
+      # - Name: Line Item Status Code
+      # - Type: ID
+      # - Min/Max: 2/2
+      # - Description: Code specifying the action taken by the seller on a line item requested by the buyer
+      #
+      # @param arg [String]
+      # @return [void]
+      def ACK01=(arg)
+        @ack01.value = arg
+      end
+      alias LineItemStatusCode= ACK01=
+
+      # ### ACK02
+      #
+      # - Id: 380
+      # - Name: Quantity
+      # - Type: R
+      # - Min/Max: 1/15
+      # - Description: Numeric value of quantity
+      #
+      # @param arg [Float]
+      # @return [void]
+      def ACK02=(arg)
+        @ack02.value = arg
+      end
+      alias Quantity= ACK02=
+
+      # ### ACK03
+      #
+      # - Id: 355
+      # - Name: Unit or Basis for Measurement Code
+      # - Type: ID
+      # - Min/Max: 2/2
+      # - Description: Code specifying the units in which a value is being expressed, or manner in which a measurement has been taken
+      #
+      # @param arg [String]
+      # @return [void]
+      def ACK03=(arg)
+        @ack03.value = arg
+      end
+      alias UnitOrBasisForMeasurementCode= ACK03=
+
+      # ### ACK04
+      #
+      # - Id: 374
+      # - Name: Date/Time Qualifier
+      # - Type: ID
+      # - Min/Max: 3/3
+      # - Description: Code specifying type of date or time, or both date and time
+      #
+      # @param arg [String]
+      # @return [void]
+      def ACK04=(arg)
+        @ack04.value = arg
+      end
+      alias DateTimeQualifier= ACK04=
+
+      # ### ACK05
+      #
+      # - Id: 373
+      # - Name: Date
+      # - Type: DT
+      # - Min/Max: 8/8
+      # - Description: Date expressed as CCYYMMDD
+      #
+      # @param arg [Time]
+      # @return [void]
+      def ACK05=(arg)
+        @ack05.value = arg
+      end
+      alias Date= ACK05=
+
+      # ### ACK06
+      #
+      # - Id: 326
+      # - Name: Request Reference Number
+      # - Type: AN
+      # - Min/Max: 1/45
+      # - Description: Reference number or RFQ number to use to identify a particular transaction set and query (additional reference number or description which can be used with contract number)
+      #
+      # @param arg [String]
+      # @return [void]
+      def ACK06=(arg)
+        @ack06.value = arg
+      end
+      alias RequestReferenceNumber= ACK06=
+
+      # ### ACK07
+      #
+      # - Id: 235
+      # - Name: Product/Service ID Qualifier
+      # - Type: ID
+      # - Min/Max: 2/2
+      # - Description: Code identifying the type/source of the descriptive number used in Product/Service ID (234)
+      #
+      # @param arg [String]
+      # @return [void]
+      def ACK07=(arg)
+        @ack07.value = arg
+      end
+      alias ProductServiceIdQualifier1= ACK07=
+
+      # ### ACK08
+      #
+      # - Id: 234
+      # - Name: Product/Service ID
+      # - Type: AN
+      # - Min/Max: 1/48
+      # - Description: Identifying number for a product or service
+      #
+      # @param arg [String]
+      # @return [void]
+      def ACK08=(arg)
+        @ack08.value = arg
+      end
+      alias ProductServiceId1= ACK08=
+
+      # ### ACK09
+      #
+      # - Id: 235
+      # - Name: Product/Service ID Qualifier
+      # - Type: ID
+      # - Min/Max: 2/2
+      # - Description: Code identifying the type/source of the descriptive number used in Product/Service ID (234)
+      #
+      # @param arg [String]
+      # @return [void]
+      def ACK09=(arg)
+        @ack09.value = arg
+      end
+      alias ProductServiceIdQualifier2= ACK09=
+
+      # ### ACK10
+      #
+      # - Id: 234
+      # - Name: Product/Service ID
+      # - Type: AN
+      # - Min/Max: 1/48
+      # - Description: Identifying number for a product or service
+      #
+      # @param arg [String]
+      # @return [void]
+      def ACK10=(arg)
+        @ack10.value = arg
+      end
+      alias ProductServiceId2= ACK10=
+
+    end
+  end
+end