Class: AWSCDK::B2BI::CfnPartnership::X12InterchangeControlHeadersProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
b2_bi/cfn_partnership.rb

Overview

In X12, the Interchange Control Header is the first segment of an EDI document and is part of the Interchange Envelope.

It contains information about the sender and receiver, the date and time of transmission, and the X12 version being used. It also includes delivery information, such as the sender and receiver IDs.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(acknowledgment_requested_code: nil, receiver_id: nil, receiver_id_qualifier: nil, repetition_separator: nil, sender_id: nil, sender_id_qualifier: nil, usage_indicator_code: nil) ⇒ X12InterchangeControlHeadersProperty

Returns a new instance of X12InterchangeControlHeadersProperty.

Parameters:

  • acknowledgment_requested_code (String, nil) (defaults to: nil) —

    Located at position ISA-14 in the header.

  • receiver_id (String, nil) (defaults to: nil) —

    Located at position ISA-08 in the header.

  • receiver_id_qualifier (String, nil) (defaults to: nil) —

    Located at position ISA-07 in the header.

  • repetition_separator (String, nil) (defaults to: nil) —

    Located at position ISA-11 in the header.

  • sender_id (String, nil) (defaults to: nil) —

    Located at position ISA-06 in the header.

  • sender_id_qualifier (String, nil) (defaults to: nil) —

    Located at position ISA-05 in the header.

  • usage_indicator_code (String, nil) (defaults to: nil) —

    Located at position ISA-15 in the header. Specifies how this interchange is being used:.



1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
 
# File 'b2_bi/cfn_partnership.rb', line 1127

def initialize(acknowledgment_requested_code: nil, receiver_id: nil, receiver_id_qualifier: nil, repetition_separator: nil, sender_id: nil, sender_id_qualifier: nil, usage_indicator_code: nil)
  @acknowledgment_requested_code = acknowledgment_requested_code
  Jsii::Type.check_type(@acknowledgment_requested_code, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "acknowledgmentRequestedCode") unless @acknowledgment_requested_code.nil?
  @receiver_id = receiver_id
  Jsii::Type.check_type(@receiver_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "receiverId") unless @receiver_id.nil?
  @receiver_id_qualifier = receiver_id_qualifier
  Jsii::Type.check_type(@receiver_id_qualifier, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "receiverIdQualifier") unless @receiver_id_qualifier.nil?
  @repetition_separator = repetition_separator
  Jsii::Type.check_type(@repetition_separator, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "repetitionSeparator") unless @repetition_separator.nil?
  @sender_id = sender_id
  Jsii::Type.check_type(@sender_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "senderId") unless @sender_id.nil?
  @sender_id_qualifier = sender_id_qualifier
  Jsii::Type.check_type(@sender_id_qualifier, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "senderIdQualifier") unless @sender_id_qualifier.nil?
  @usage_indicator_code = usage_indicator_code
  Jsii::Type.check_type(@usage_indicator_code, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "usageIndicatorCode") unless @usage_indicator_code.nil?
end

Instance Attribute Details

#acknowledgment_requested_code ⇒ String? (readonly)

Located at position ISA-14 in the header.

The value "1" indicates that the sender is requesting an interchange acknowledgment at receipt of the interchange. The value "0" is used otherwise.

Returns:

  • (String, nil)

See Also:



1150
1151
1152
 
# File 'b2_bi/cfn_partnership.rb', line 1150

def acknowledgment_requested_code
  @acknowledgment_requested_code
end

#receiver_id ⇒ String? (readonly)

Located at position ISA-08 in the header.

This value (along with the receiver_id_qualifier ) identifies the intended recipient of the interchange.

Returns:

  • (String, nil)

See Also:



1157
1158
1159
 
# File 'b2_bi/cfn_partnership.rb', line 1157

def receiver_id
  @receiver_id
end

#receiver_id_qualifier ⇒ String? (readonly)

Located at position ISA-07 in the header.

Qualifier for the receiver ID. Together, the ID and qualifier uniquely identify the receiving trading partner.

Returns:

  • (String, nil)

See Also:



1164
1165
1166
 
# File 'b2_bi/cfn_partnership.rb', line 1164

def receiver_id_qualifier
  @receiver_id_qualifier
end

#repetition_separator ⇒ String? (readonly)

Located at position ISA-11 in the header.

This string makes it easier when you need to group similar adjacent element values together without using extra segments.

This parameter is only honored for version greater than 401 ( VERSION_4010 and higher).

For versions less than 401, this field is called StandardsId , in which case our service sets the value to U .

Returns:

  • (String, nil)

See Also:



1175
1176
1177
 
# File 'b2_bi/cfn_partnership.rb', line 1175

def repetition_separator
  @repetition_separator
end

#sender_id ⇒ String? (readonly)

Located at position ISA-06 in the header.

This value (along with the sender_id_qualifier ) identifies the sender of the interchange.

Returns:

  • (String, nil)

See Also:



1182
1183
1184
 
# File 'b2_bi/cfn_partnership.rb', line 1182

def sender_id
  @sender_id
end

#sender_id_qualifier ⇒ String? (readonly)

Located at position ISA-05 in the header.

Qualifier for the sender ID. Together, the ID and qualifier uniquely identify the sending trading partner.

Returns:

  • (String, nil)

See Also:



1189
1190
1191
 
# File 'b2_bi/cfn_partnership.rb', line 1189

def sender_id_qualifier
  @sender_id_qualifier
end

#usage_indicator_code ⇒ String? (readonly)

Located at position ISA-15 in the header. Specifies how this interchange is being used:.

  • T indicates this interchange is for testing.
  • P indicates this interchange is for production.
  • I indicates this interchange is informational.

Returns:

  • (String, nil)

See Also:



1198
1199
1200
 
# File 'b2_bi/cfn_partnership.rb', line 1198

def usage_indicator_code
  @usage_indicator_code
end

Class Method Details

.jsii_properties ⇒ Object 



1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
 
# File 'b2_bi/cfn_partnership.rb', line 1200

def self.jsii_properties
  {
    :acknowledgment_requested_code => "acknowledgmentRequestedCode",
    :receiver_id => "receiverId",
    :receiver_id_qualifier => "receiverIdQualifier",
    :repetition_separator => "repetitionSeparator",
    :sender_id => "senderId",
    :sender_id_qualifier => "senderIdQualifier",
    :usage_indicator_code => "usageIndicatorCode",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
 
# File 'b2_bi/cfn_partnership.rb', line 1212

def to_jsii
  result = {}
  result.merge!({
    "acknowledgmentRequestedCode" => @acknowledgment_requested_code,
    "receiverId" => @receiver_id,
    "receiverIdQualifier" => @receiver_id_qualifier,
    "repetitionSeparator" => @repetition_separator,
    "senderId" => @sender_id,
    "senderIdQualifier" => @sender_id_qualifier,
    "usageIndicatorCode" => @usage_indicator_code,
  })
  result.compact
end