eddy 0.1.0 → 0.3.0

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

@@ -0,0 +1,158 @@
+module Eddy
+  module Segments
+    # ### Segment Summary:
+    #
+    # - Id: TD1
+    # - Name: Carrier Details (Quantity and Weight)
+    # - Purpose: To specify the transportation details relative to commodity, weight, and quantity.
+    class TD1 < Eddy::Segment
+
+      # @param store [Eddy::Data::Store]
+      # @return [void]
+      def initialize(store)
+        @id = "TD1"
+        @name = "Carrier Details (Quantity and Weight)"
+        @td101 = Eddy::Elements::E103.new(ref: "TD101", req: "O")
+        @td102 = Eddy::Elements::E80.new(ref: "TD102", req: "X")
+        @td103 = Eddy::Elements::E23.new(ref: "TD103", req: "O")
+        @td104 = Eddy::Elements::E22.new(ref: "TD104", req: "X")
+        @td105 = Eddy::Elements::E79.new(ref: "TD105", req: "O")
+        @td106 = Eddy::Elements::E187.new(ref: "TD106", req: "O")
+        @td107 = Eddy::Elements::E81.new(ref: "TD107", req: "X")
+        @td108 = Eddy::Elements::E355.new(ref: "TD108", req: "X")
+        super(
+          store,
+          @td101,
+          @td102,
+          @td103,
+          @td104,
+          @td105,
+          @td106,
+          @td107,
+          @td108,
+        )
+      end
+
+      # ### TD101
+      #
+      # - Id: 103
+      # - Name: Packaging Code
+      # - Type: AN
+      # - Min/Max: 3/5
+      # - Description: Code identifying the type of packaging; Part 1: Packaging Form, Part 2: Packaging Material; if the Data Element is used, then Part 1 is always required
+      #
+      # @param arg [String]
+      # @return [void]
+      def TD101=(arg)
+        @td101.value = arg
+      end
+      alias PackagingCode= TD101=
+
+      # ### TD102
+      #
+      # - Id: 80
+      # - Name: Lading Quantity
+      # - Type: N0
+      # - Min/Max: 1/7
+      # - Description: Number of units (pieces) of the lading commodity
+      #
+      # @param arg [Integer]
+      # @return [void]
+      def TD102=(arg)
+        @td102.value = arg
+      end
+      alias LadingQuantity= TD102=
+
+      # ### TD103
+      #
+      # - Id: 23
+      # - Name: Commodity Code Qualifier
+      # - Type: ID
+      # - Min/Max: 1/1
+      # - Description: Code identifying the commodity coding system used for Commodity Code
+      #
+      # @param arg [String]
+      # @return [void]
+      def TD103=(arg)
+        @td103.value = arg
+      end
+      alias CommodityCodeQualifier= TD103=
+
+      # ### TD104
+      #
+      # - Id: 22
+      # - Name: Commodity Code
+      # - Type: AN
+      # - Min/Max: 1/30
+      # - Description: Code describing a commodity or group of commodities
+      #
+      # @param arg [String]
+      # @return [void]
+      def TD104=(arg)
+        @td104.value = arg
+      end
+      alias CommodityCode= TD104=
+
+      # ### TD105
+      #
+      # - Id: 79
+      # - Name: Lading Description
+      # - Type: AN
+      # - Min/Max: 1/50
+      # - Description: Description of an item as required for rating and billing purposes
+      #
+      # @param arg [String]
+      # @return [void]
+      def TD105=(arg)
+        @td105.value = arg
+      end
+      alias LadingDescription= TD105=
+
+      # ### TD106
+      #
+      # - Id: 187
+      # - Name: Weight Qualifier
+      # - Type: ID
+      # - Min/Max: 1/2
+      # - Description: Code defining the type of weight
+      #
+      # @param arg [String]
+      # @return [void]
+      def TD106=(arg)
+        @td106.value = arg
+      end
+      alias WeightQualifier= TD106=
+
+      # ### TD107
+      #
+      # - Id: 81
+      # - Name: Weight
+      # - Type: R
+      # - Min/Max: 1/10
+      # - Description: Numeric value of weight
+      #
+      # @param arg [Float]
+      # @return [void]
+      def TD107=(arg)
+        @td107.value = arg
+      end
+      alias Weight= TD107=
+
+      # ### TD108
+      #
+      # - 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 TD108=(arg)
+        @td108.value = arg
+      end
+      alias UnitOrBasisForMeasurementCode= TD108=
+
+    end
+  end
+end

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

@@ -0,0 +1,107 @@
+module Eddy
+  module Segments
+    # ### Segment Summary:
+    #
+    # - Id: TD5
+    # - Name: Carrier Details (Routing Sequence/Transit Time)
+    # - Purpose: To specify the carrier and sequence of routing and provide transit time information.
+    class TD5 < Eddy::Segment
+
+      # @param store [Eddy::Data::Store]
+      # @return [void]
+      def initialize(store)
+        @id = "TD5"
+        @name = "Carrier Details (Routing Sequence/Transit Time)"
+        @td501 = Eddy::Elements::E133.new(ref: "TD501", req: "M")
+        @td502 = Eddy::Elements::E66.new(ref: "TD502", req: "X")
+        @td503 = Eddy::Elements::E67.new(ref: "TD503", req: "X")
+        @td504 = Eddy::Elements::E91.new(ref: "TD504", req: "M")
+        @td505 = Eddy::Elements::E387.new(ref: "TD505", req: "X")
+        super(
+          store,
+          @td501,
+          @td502,
+          @td503,
+          @td504,
+          @td505,
+        )
+      end
+
+      # ### TD501
+      #
+      # - Id: 133
+      # - Name: Routing Sequence Code
+      # - Type: ID
+      # - Min/Max: 1/2
+      # - Description: Code describing the relationship of a carrier to a specific shipment movement
+      #
+      # @param arg [String]
+      # @return [void]
+      def TD501=(arg)
+        @td501.value = arg
+      end
+      alias RoutingSequenceCode= TD501=
+
+      # ### TD502
+      #
+      # - Id: 66
+      # - Name: Identification Code Qualifier
+      # - Type: ID
+      # - Min/Max: 1/2
+      # - Description: Code designating the system/method of code structure used for Identification Code (67)
+      #
+      # @param arg [String]
+      # @return [void]
+      def TD502=(arg)
+        @td502.value = arg
+      end
+      alias IdentificationCodeQualifier= TD502=
+
+      # ### TD503
+      #
+      # - Id: 67
+      # - Name: Identification Code
+      # - Type: AN
+      # - Min/Max: 2/80
+      # - Description: Code identifying a party or other code
+      #
+      # @param arg [String]
+      # @return [void]
+      def TD503=(arg)
+        @td503.value = arg
+      end
+      alias IdentificationCode= TD503=
+
+      # ### TD504
+      #
+      # - Id: 91
+      # - Name: Transportation Method/Type Code
+      # - Type: ID
+      # - Min/Max: 1/2
+      # - Description: Code specifying the method or type of transportation for the shipment
+      #
+      # @param arg [String]
+      # @return [void]
+      def TD504=(arg)
+        @td504.value = arg
+      end
+      alias TransportationMethodTypeCode= TD504=
+
+      # ### TD505
+      #
+      # - Id: 387
+      # - Name: Routing
+      # - Type: AN
+      # - Min/Max: 1/35
+      # - Description: Free-form description of the routing or requested routing for shipment, or the originating carrier's identity
+      #
+      # @param arg [String]
+      # @return [void]
+      def TD505=(arg)
+        @td505.value = arg
+      end
+      alias Routing= TD505=
+
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+module Eddy
+  module Segments
+    # ### Segment Summary:
+    #
+    # - Id: TDS
+    # - Name: Total Monetary Value Summary
+    # - Purpose: To specify the total invoice discounts and amounts.
+    class TDS < Eddy::Segment
+
+      # @param store [Eddy::Data::Store]
+      # @return [void]
+      def initialize(store)
+        @id = "TDS"
+        @name = "Total Monetary Value Summary"
+        @tds01 = Eddy::Elements::E610.new(ref: "TDS01", req: "M")
+        super(
+          store,
+          @tds01,
+        )
+      end
+
+      # ### TDS01
+      #
+      # - Id: 610
+      # - Name: Amount
+      # - Type: N2
+      # - Min/Max: 1/15
+      # - Description: Monetary amount
+      #
+      # @param arg [Integer]
+      # @return [void]
+      def TDS01=(arg)
+        @tds01.value = arg
+      end
+      alias Amount= TDS01=
+
+    end
+  end
+end

data/lib/definitions/segments/manual/envelopes/ge.rb

@@ -0,0 +1,53 @@
+module Eddy
+  module Segments
+    # ### Segment Summary:
+    #
+    # - Id: GE
+    # - Name: Functional Group Trailer
+    # - Purpose: To indicate the end of a functional group and to provide control information.
+    class GE < Eddy::Segment
+
+      # @param store [Eddy::Data::Store]
+      # @param group_control_number [Integer]
+      # @return [void]
+      def initialize(store, group_control_number)
+        @id = "GE"
+        @name = "Functional Group Trailer"
+        @ge01 = Eddy::Elements::E97.new(ref: "GE01", req: "M", val: store.number_of_transaction_sets_included)
+        @ge02 = Eddy::Elements::E28.new(ref: "GE02", req: "M", val: group_control_number)
+        super(store, @ge01, @ge02)
+      end
+
+      # ### GE01
+      #
+      # - Id: 97
+      # - Name: Number of Transaction Sets Included
+      # - Type: N0
+      # - Min/Max: 1/6
+      # - Description: Total number of transaction sets included in the functional group or interchange (transmission) group terminated by the trailer containing this data element
+      #
+      # @param arg [Integer]
+      # @return [void]
+      def GE01=(arg)
+        @ge01.value = arg
+      end
+      alias NumberOfTransactionSetsIncluded= GE01=
+
+      # ### GE02
+      #
+      # - Id: 28
+      # - Name: Group Control Number
+      # - Type: N0
+      # - Min/Max: 1/9
+      # - Description: Assigned number originated and maintained by the sender
+      #
+      # @param arg [Integer]
+      # @return [void]
+      def GE02=(arg)
+        @ge02.value = arg
+      end
+      alias GroupControlNumber= GE02=
+
+    end
+  end
+end

data/lib/definitions/segments/manual/envelopes/gs.rb

@@ -0,0 +1,163 @@
+module Eddy
+  module Segments
+    # ### Segment Summary:
+    #
+    # - Id: GS
+    # - Name: Functional Group Header
+    # - Purpose: To indicate the beginning of a functional group and to provide control information.
+    class GS < Eddy::Segment
+
+      # @param store [Eddy::Data::Store]
+      # @param group_control_number [Integer]
+      # @param transaction_set [Eddy::TransactionSet]
+      # @return [void]
+      def initialize(store, group_control_number, transaction_set)
+        @id = "GS"
+        @name = "Functional Group Header"
+        @gs01 = Eddy::Elements::E479.new(ref: "GS01", req: "M", val: transaction_set.functional_group)
+        @gs02 = Eddy::Elements::E142.new(ref: "GS02", req: "M", val: store.application_senders_code)
+        @gs03 = Eddy::Elements::E124.new(ref: "GS03", req: "M", val: store.application_receivers_code)
+        @gs04 = Eddy::Elements::E373.new(ref: "GS04", req: "M", val: store.time)
+        @gs05 = Eddy::Elements::E337.new(ref: "GS05", req: "M", val: store.time) # TODO: Define time fmt for this.
+        @gs06 = Eddy::Elements::E28.new(ref:  "GS06", req: "M", val: group_control_number)
+        @gs07 = Eddy::Elements::E455.new(ref: "GS07", req: "M")
+        @gs08 = Eddy::Elements::E480.new(ref: "GS08", req: "M", val: store.version_release_industry_id_code)
+        super(
+          store,
+          @gs01,
+          @gs02,
+          @gs03,
+          @gs04,
+          @gs05,
+          @gs06,
+          @gs07,
+          @gs08,
+        )
+      end
+
+      # ### GS01
+      #
+      # - Id: 479
+      # - Name: Functional Identifier Code
+      # - Type: ID
+      # - Min/Max: 2/2
+      # - Description: Code identifying a group of application related transaction sets
+      #
+      # @param arg [String]
+      # @return [void]
+      def GS01=(arg)
+        @gs01.value = arg
+      end
+      alias FunctionalIdentifierCode= GS01=
+
+      # ### GS02
+      #
+      # - Id: 142
+      # - Name: Application Sender's Code
+      # - Type: AN
+      # - Min/Max: 2/15
+      # - Description: Code identifying party sending transmission; codes agreed to by trading partners
+      #
+      # @param arg [String]
+      # @return [void]
+      def GS02=(arg)
+        @gs02.value = arg
+      end
+      alias ApplicationSendersCode= GS02=
+
+      # ### GS03
+      #
+      # - Id: 124
+      # - Name: Application Receiver's Code
+      # - Type: AN
+      # - Min/Max: 2/15
+      # - Description: Code identifying party receiving transmission. Codes agreed to by trading partners
+      #
+      # @param arg [String]
+      # @return [void]
+      def GS03=(arg)
+        @gs03.value = arg
+      end
+      alias ApplicationReceiversCode= GS03=
+
+      # ### GS04
+      #
+      # - Id: 373
+      # - Name: Date
+      # - Type: DT
+      # - Min/Max: 8/8
+      # - Description: Date expressed as CCYYMMDD
+      #
+      # @param arg [Time]
+      # @return [void]
+      def GS04=(arg)
+        @gs04.value = arg
+      end
+      alias Date= GS04=
+
+      # ### GS05
+      #
+      # - Id: 337
+      # - Name: Time
+      # - Type: TM
+      # - Min/Max: 4/8
+      # - Description: Time expressed in 24-hour clock time as follows: HHMM, or HHMMSS, or HHMMSSD, or HHMMSSDD, where H = hours (00-23), M = minutes (00-59), S = integer seconds (00-59) and DD = decimal seconds; decimal seconds are expressed as follows: D = tenths (0-9) and DD = hundredths (00-99)
+      #
+      # @param arg [Time]
+      # @return [void]
+      def GS05=(arg)
+        @gs05.value = arg
+      end
+      alias Time= GS05=
+
+      # ### GS06
+      #
+      # - Id: 28
+      # - Name: Group Control Number
+      # - Type: N0
+      # - Min/Max: 1/9
+      # - Description: Assigned number originated and maintained by the sender
+      #
+      # @param arg [Integer]
+      # @return [void]
+      def GS06=(arg)
+        @gs06.value = arg
+      end
+      alias GroupControlNumber= GS06=
+
+      # ### GS07
+      #
+      # - Id: 455
+      # - Name: Responsible Agency Code
+      # - Type: ID
+      # - Min/Max: 1/2
+      # - Description: Code used in conjunction with Data Element 480 to identify the issuer of the standard
+      #
+      # ### Notes:
+      #
+      # - (Default value: `"X"`)
+      # @param arg [String]
+      # @return [void]
+      def GS07=(arg)
+        @gs07.value = arg
+      end
+      alias ResponsibleAgencyCode= GS07=
+
+      # ### GS08
+      #
+      # - Id: 480
+      # - Name: Version / Release / Industry Identifier Code
+      # - Type: AN
+      # - Min/Max: 1/12
+      # - Description: Code indicating the version, release, subrelease, and industry identifier of the EDI standard being used, including the GS and GE segments; if code in DE455 in GS segment is X, then in DE 480 positions 1-3 are the version number; positions 4-6 are the release and subrelease, level of the version; and positions 7-12 are the industry or trade association identifiers (optionally assigned by user); if code in DE455 in GS segment is T, then other formats are allowed
+      #
+      # @param arg [String]
+      # @return [void]
+      def GS08=(arg)
+        @gs08.value = arg
+      end
+      alias VersionReleaseIndustryIdentifierCode= GS08=
+
+    end
+  end
+end