Class: UspsApi::PackageTransactionDetails

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/usps_api/models/package_transaction_details.rb

Overview

Details on package transaction details that will be or have been issued to a customer account. Fields will only be provided if they differed from the original manifested data.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#check_for_conflict, #process_additional_properties, #process_array, #process_basic_value, #process_hash, #to_hash, #to_json

Constructor Details

#initialize(transmission_date: SKIP, mailing_date: SKIP, master_mid: SKIP, manifest_transaction_id: SKIP, efn: SKIP, i_mpb: SKIP, pic: SKIP, mailer_id: SKIP, service_type_code: SKIP, processing_category: SKIP, processing_category_name: SKIP, capt_wt: SKIP, usps_dimensional_weight: SKIP, capt_dim_len: SKIP, capt_dim_wd: SKIP, capt_dim_ht: SKIP, entry_facility_zipcode: SKIP, destination_zip_code: SKIP, destntn_rate_ind: SKIP, rate_indicator: SKIP, sku: SKIP, base_postage: SKIP, published_price: SKIP, manifest_nonstndrd_length_fee1: SKIP, manifest_nonstndrd_length_fee2: SKIP, manifest_nonstndrd_volume_fee: SKIP, man_nonstndrd_char_fee: SKIP, extra_service_code1: SKIP, extra_service_code2: SKIP, extra_service_code3: SKIP, extra_service_code4: SKIP, extra_service_code5: SKIP, extra_service1_amount: SKIP, extra_service2_amount: SKIP, extra_service3_amount: SKIP, extra_service4_amount: SKIP, extra_service5_amount: SKIP, extra_service1_sku: SKIP, extra_service2_sku: SKIP, extra_service3_sku: SKIP, extra_service4_sku: SKIP, extra_service5_sku: SKIP, srch_sku: SKIP, warnings: SKIP, manifest_package_id: SKIP, manifest_dimensional_weight: SKIP, manifest_dri: SKIP, manifest_rate_indicator: SKIP, is_tpb: SKIP, tpb_shipper_crid: SKIP, tpb_shipper_name: SKIP, destination_country_code: SKIP, foreign_postal_code: SKIP, price_group: SKIP, cust_ref_num1: SKIP, cust_ref_num2: SKIP, permit_finance_no: SKIP, permit_type: SKIP, permit_no: SKIP, price_type: SKIP, claimed_postage: SKIP, assessed_postage: SKIP, payment_method: SKIP, eps_tran_type: SKIP, transaction_description: SKIP, ship_tran_amt: SKIP, piece_count: SKIP, eps_account_nickname: SKIP, eps_acc_num: SKIP, ship_tran_dt: SKIP, display_tran_id: SKIP, ach_withdrawal_id: SKIP, weight: SKIP, dim_length: SKIP, dim_width: SKIP, dim_height: SKIP, total_variance: SKIP, manifest_zone: SKIP, census_reason: SKIP, assessment_type: SKIP, admin_fee_type: SKIP, dispute_id: SKIP, dts_first: SKIP, assd_mc_code: SKIP, assessed_length: SKIP, assessed_weight: SKIP, assessed_height: SKIP, assessed_width: SKIP, assessed_zone: SKIP, packaging: SKIP, upc_code: SKIP, scan_nonstndrd_length_fee1: SKIP, scan_nonstndrd_length_fee2: SKIP, scan_nonstndrd_volume_fee: SKIP, scan_nonstndrd_char_fee: SKIP, noncompliance_fee: SKIP, assessment_year: SKIP, assessed_mail_class: SKIP, merchant_rate_charged: SKIP, gross_commission: SKIP, platform_rate: SKIP, cc_withdrawal_id: SKIP, mid_owner_name: SKIP, mid_user_name: SKIP, invoice_id: SKIP, assessment_details: SKIP, assessment_month: SKIP, ach_withdrawal_date: SKIP, cc_withdrawal_date: SKIP, invoice_date: SKIP, crid: SKIP, platform_user_id: SKIP, external_ref_id: SKIP, pkg_grp_id: SKIP) ⇒ PackageTransactionDetails

Returns a new instance of PackageTransactionDetails.



735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 735

def initialize(transmission_date: SKIP, mailing_date: SKIP,
               master_mid: SKIP, manifest_transaction_id: SKIP, efn: SKIP,
               i_mpb: SKIP, pic: SKIP, mailer_id: SKIP,
               service_type_code: SKIP, processing_category: SKIP,
               processing_category_name: SKIP, capt_wt: SKIP,
               usps_dimensional_weight: SKIP, capt_dim_len: SKIP,
               capt_dim_wd: SKIP, capt_dim_ht: SKIP,
               entry_facility_zipcode: SKIP, destination_zip_code: SKIP,
               destntn_rate_ind: SKIP, rate_indicator: SKIP, sku: SKIP,
               base_postage: SKIP, published_price: SKIP,
               manifest_nonstndrd_length_fee1: SKIP,
               manifest_nonstndrd_length_fee2: SKIP,
               manifest_nonstndrd_volume_fee: SKIP,
               man_nonstndrd_char_fee: SKIP, extra_service_code1: SKIP,
               extra_service_code2: SKIP, extra_service_code3: SKIP,
               extra_service_code4: SKIP, extra_service_code5: SKIP,
               extra_service1_amount: SKIP, extra_service2_amount: SKIP,
               extra_service3_amount: SKIP, extra_service4_amount: SKIP,
               extra_service5_amount: SKIP, extra_service1_sku: SKIP,
               extra_service2_sku: SKIP, extra_service3_sku: SKIP,
               extra_service4_sku: SKIP, extra_service5_sku: SKIP,
               srch_sku: SKIP, warnings: SKIP, manifest_package_id: SKIP,
               manifest_dimensional_weight: SKIP, manifest_dri: SKIP,
               manifest_rate_indicator: SKIP, is_tpb: SKIP,
               tpb_shipper_crid: SKIP, tpb_shipper_name: SKIP,
               destination_country_code: SKIP, foreign_postal_code: SKIP,
               price_group: SKIP, cust_ref_num1: SKIP, cust_ref_num2: SKIP,
               permit_finance_no: SKIP, permit_type: SKIP, permit_no: SKIP,
               price_type: SKIP, claimed_postage: SKIP,
               assessed_postage: SKIP, payment_method: SKIP,
               eps_tran_type: SKIP, transaction_description: SKIP,
               ship_tran_amt: SKIP, piece_count: SKIP,
               eps_account_nickname: SKIP, eps_acc_num: SKIP,
               ship_tran_dt: SKIP, display_tran_id: SKIP,
               ach_withdrawal_id: SKIP, weight: SKIP, dim_length: SKIP,
               dim_width: SKIP, dim_height: SKIP, total_variance: SKIP,
               manifest_zone: SKIP, census_reason: SKIP,
               assessment_type: SKIP, admin_fee_type: SKIP,
               dispute_id: SKIP, dts_first: SKIP, assd_mc_code: SKIP,
               assessed_length: SKIP, assessed_weight: SKIP,
               assessed_height: SKIP, assessed_width: SKIP,
               assessed_zone: SKIP, packaging: SKIP, upc_code: SKIP,
               scan_nonstndrd_length_fee1: SKIP,
               scan_nonstndrd_length_fee2: SKIP,
               scan_nonstndrd_volume_fee: SKIP,
               scan_nonstndrd_char_fee: SKIP, noncompliance_fee: SKIP,
               assessment_year: SKIP, assessed_mail_class: SKIP,
               merchant_rate_charged: SKIP, gross_commission: SKIP,
               platform_rate: SKIP, cc_withdrawal_id: SKIP,
               mid_owner_name: SKIP, mid_user_name: SKIP, invoice_id: SKIP,
               assessment_details: SKIP, assessment_month: SKIP,
               ach_withdrawal_date: SKIP, cc_withdrawal_date: SKIP,
               invoice_date: SKIP, crid: SKIP, platform_user_id: SKIP,
               external_ref_id: SKIP, pkg_grp_id: SKIP)
  @transmission_date = transmission_date unless transmission_date == SKIP
  @mailing_date = mailing_date unless mailing_date == SKIP
  @master_mid = master_mid unless master_mid == SKIP
  @manifest_transaction_id = manifest_transaction_id unless manifest_transaction_id == SKIP
  @efn = efn unless efn == SKIP
  @i_mpb = i_mpb unless i_mpb == SKIP
  @pic = pic unless pic == SKIP
  @mailer_id = mailer_id unless mailer_id == SKIP
  @service_type_code = service_type_code unless service_type_code == SKIP
  @processing_category = processing_category unless processing_category == SKIP
  @processing_category_name = processing_category_name unless processing_category_name == SKIP
  @capt_wt = capt_wt unless capt_wt == SKIP
  @usps_dimensional_weight = usps_dimensional_weight unless usps_dimensional_weight == SKIP
  @capt_dim_len = capt_dim_len unless capt_dim_len == SKIP
  @capt_dim_wd = capt_dim_wd unless capt_dim_wd == SKIP
  @capt_dim_ht = capt_dim_ht unless capt_dim_ht == SKIP
  @entry_facility_zipcode = entry_facility_zipcode unless entry_facility_zipcode == SKIP
  @destination_zip_code = destination_zip_code unless destination_zip_code == SKIP
  @destntn_rate_ind = destntn_rate_ind unless destntn_rate_ind == SKIP
  @rate_indicator = rate_indicator unless rate_indicator == SKIP
  @sku = sku unless sku == SKIP
  @base_postage = base_postage unless base_postage == SKIP
  @published_price = published_price unless published_price == SKIP
  unless manifest_nonstndrd_length_fee1 == SKIP
    @manifest_nonstndrd_length_fee1 =
      manifest_nonstndrd_length_fee1
  end
  unless manifest_nonstndrd_length_fee2 == SKIP
    @manifest_nonstndrd_length_fee2 =
      manifest_nonstndrd_length_fee2
  end
  unless manifest_nonstndrd_volume_fee == SKIP
    @manifest_nonstndrd_volume_fee =
      manifest_nonstndrd_volume_fee
  end
  @man_nonstndrd_char_fee = man_nonstndrd_char_fee unless man_nonstndrd_char_fee == SKIP
  @extra_service_code1 = extra_service_code1 unless extra_service_code1 == SKIP
  @extra_service_code2 = extra_service_code2 unless extra_service_code2 == SKIP
  @extra_service_code3 = extra_service_code3 unless extra_service_code3 == SKIP
  @extra_service_code4 = extra_service_code4 unless extra_service_code4 == SKIP
  @extra_service_code5 = extra_service_code5 unless extra_service_code5 == SKIP
  @extra_service1_amount = extra_service1_amount unless extra_service1_amount == SKIP
  @extra_service2_amount = extra_service2_amount unless extra_service2_amount == SKIP
  @extra_service3_amount = extra_service3_amount unless extra_service3_amount == SKIP
  @extra_service4_amount = extra_service4_amount unless extra_service4_amount == SKIP
  @extra_service5_amount = extra_service5_amount unless extra_service5_amount == SKIP
  @extra_service1_sku = extra_service1_sku unless extra_service1_sku == SKIP
  @extra_service2_sku = extra_service2_sku unless extra_service2_sku == SKIP
  @extra_service3_sku = extra_service3_sku unless extra_service3_sku == SKIP
  @extra_service4_sku = extra_service4_sku unless extra_service4_sku == SKIP
  @extra_service5_sku = extra_service5_sku unless extra_service5_sku == SKIP
  @srch_sku = srch_sku unless srch_sku == SKIP
  @warnings = warnings unless warnings == SKIP
  @manifest_package_id = manifest_package_id unless manifest_package_id == SKIP
  unless manifest_dimensional_weight == SKIP
    @manifest_dimensional_weight =
      manifest_dimensional_weight
  end
  @manifest_dri = manifest_dri unless manifest_dri == SKIP
  @manifest_rate_indicator = manifest_rate_indicator unless manifest_rate_indicator == SKIP
  @is_tpb = is_tpb unless is_tpb == SKIP
  @tpb_shipper_crid = tpb_shipper_crid unless tpb_shipper_crid == SKIP
  @tpb_shipper_name = tpb_shipper_name unless tpb_shipper_name == SKIP
  @destination_country_code = destination_country_code unless destination_country_code == SKIP
  @foreign_postal_code = foreign_postal_code unless foreign_postal_code == SKIP
  @price_group = price_group unless price_group == SKIP
  @cust_ref_num1 = cust_ref_num1 unless cust_ref_num1 == SKIP
  @cust_ref_num2 = cust_ref_num2 unless cust_ref_num2 == SKIP
  @permit_finance_no = permit_finance_no unless permit_finance_no == SKIP
  @permit_type = permit_type unless permit_type == SKIP
  @permit_no = permit_no unless permit_no == SKIP
  @price_type = price_type unless price_type == SKIP
  @claimed_postage = claimed_postage unless claimed_postage == SKIP
  @assessed_postage = assessed_postage unless assessed_postage == SKIP
  @payment_method = payment_method unless payment_method == SKIP
  @eps_tran_type = eps_tran_type unless eps_tran_type == SKIP
  @transaction_description = transaction_description unless transaction_description == SKIP
  @ship_tran_amt = ship_tran_amt unless ship_tran_amt == SKIP
  @piece_count = piece_count unless piece_count == SKIP
  @eps_account_nickname =  unless  == SKIP
  @eps_acc_num = eps_acc_num unless eps_acc_num == SKIP
  @ship_tran_dt = ship_tran_dt unless ship_tran_dt == SKIP
  @display_tran_id = display_tran_id unless display_tran_id == SKIP
  @ach_withdrawal_id = ach_withdrawal_id unless ach_withdrawal_id == SKIP
  @weight = weight unless weight == SKIP
  @dim_length = dim_length unless dim_length == SKIP
  @dim_width = dim_width unless dim_width == SKIP
  @dim_height = dim_height unless dim_height == SKIP
  @total_variance = total_variance unless total_variance == SKIP
  @manifest_zone = manifest_zone unless manifest_zone == SKIP
  @census_reason = census_reason unless census_reason == SKIP
  @assessment_type = assessment_type unless assessment_type == SKIP
  @admin_fee_type = admin_fee_type unless admin_fee_type == SKIP
  @dispute_id = dispute_id unless dispute_id == SKIP
  @dts_first = dts_first unless dts_first == SKIP
  @assd_mc_code = assd_mc_code unless assd_mc_code == SKIP
  @assessed_length = assessed_length unless assessed_length == SKIP
  @assessed_weight = assessed_weight unless assessed_weight == SKIP
  @assessed_height = assessed_height unless assessed_height == SKIP
  @assessed_width = assessed_width unless assessed_width == SKIP
  @assessed_zone = assessed_zone unless assessed_zone == SKIP
  @packaging = packaging unless packaging == SKIP
  @upc_code = upc_code unless upc_code == SKIP
  unless scan_nonstndrd_length_fee1 == SKIP
    @scan_nonstndrd_length_fee1 =
      scan_nonstndrd_length_fee1
  end
  unless scan_nonstndrd_length_fee2 == SKIP
    @scan_nonstndrd_length_fee2 =
      scan_nonstndrd_length_fee2
  end
  unless scan_nonstndrd_volume_fee == SKIP
    @scan_nonstndrd_volume_fee =
      scan_nonstndrd_volume_fee
  end
  @scan_nonstndrd_char_fee = scan_nonstndrd_char_fee unless scan_nonstndrd_char_fee == SKIP
  @noncompliance_fee = noncompliance_fee unless noncompliance_fee == SKIP
  @assessment_year = assessment_year unless assessment_year == SKIP
  @assessed_mail_class = assessed_mail_class unless assessed_mail_class == SKIP
  @merchant_rate_charged = merchant_rate_charged unless merchant_rate_charged == SKIP
  @gross_commission = gross_commission unless gross_commission == SKIP
  @platform_rate = platform_rate unless platform_rate == SKIP
  @cc_withdrawal_id = cc_withdrawal_id unless cc_withdrawal_id == SKIP
  @mid_owner_name = mid_owner_name unless mid_owner_name == SKIP
  @mid_user_name = mid_user_name unless mid_user_name == SKIP
  @invoice_id = invoice_id unless invoice_id == SKIP
  @assessment_details = assessment_details unless assessment_details == SKIP
  @assessment_month = assessment_month unless assessment_month == SKIP
  @ach_withdrawal_date = ach_withdrawal_date unless ach_withdrawal_date == SKIP
  @cc_withdrawal_date = cc_withdrawal_date unless cc_withdrawal_date == SKIP
  @invoice_date = invoice_date unless invoice_date == SKIP
  @crid = crid unless crid == SKIP
  @platform_user_id = platform_user_id unless platform_user_id == SKIP
  @external_ref_id = external_ref_id unless external_ref_id == SKIP
  @pkg_grp_id = pkg_grp_id unless pkg_grp_id == SKIP
end

Instance Attribute Details

#ach_withdrawal_date ⇒ DateTime

ACH Withdrawal Date

Returns:

  • (DateTime) 


463
464
465
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 463

def ach_withdrawal_date
  @ach_withdrawal_date
end

#ach_withdrawal_id ⇒ String

ACH Debit Aggregate Transaction ID.

Returns:

  • (String) 


317
318
319
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 317

def ach_withdrawal_id
  @ach_withdrawal_id
end

#admin_fee_type ⇒ String

Admin Fee Type used to determine if there are any administrative fees associated with this package.

Returns:

  • (String) 


355
356
357
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 355

def admin_fee_type
  @admin_fee_type
end

#assd_mc_code ⇒ String

Scan Mail Class

Returns:

  • (String) 


367
368
369
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 367

def assd_mc_code
  @assd_mc_code
end

#assessed_height ⇒ Float

Scan Height

Returns:

  • (Float) 


379
380
381
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 379

def assessed_height
  @assessed_height
end

#assessed_length ⇒ Float

Scan Length

Returns:

  • (Float) 


371
372
373
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 371

def assessed_length
  @assessed_length
end

#assessed_mail_class ⇒ String

Assessed Mail Class

Returns:

  • (String) 


423
424
425
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 423

def assessed_mail_class
  @assessed_mail_class
end

#assessed_postage ⇒ Float

The postage charged for this package.

Returns:

  • (Float) 


275
276
277
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 275

def assessed_postage
  @assessed_postage
end

#assessed_weight ⇒ Float

Scan Weight

Returns:

  • (Float) 


375
376
377
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 375

def assessed_weight
  @assessed_weight
end

#assessed_width ⇒ Float

Scan Width

Returns:

  • (Float) 


383
384
385
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 383

def assessed_width
  @assessed_width
end

#assessed_zone ⇒ String

Scan zone for this package.

Returns:

  • (String) 


387
388
389
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 387

def assessed_zone
  @assessed_zone
end

#assessment_details ⇒ String

Assessment Details

Returns:

  • (String) 


455
456
457
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 455

def assessment_details
  @assessment_details
end

#assessment_month ⇒ String

Assessment Month

Returns:

  • (String) 


459
460
461
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 459

def assessment_month
  @assessment_month
end

#assessment_type ⇒ String

Assessment Type received from the Verification Service, appended with root causes

Returns:

  • (String) 


350
351
352
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 350

def assessment_type
  @assessment_type
end

#assessment_year ⇒ String

Assessment year for this package transaction.

Returns:

  • (String) 


419
420
421
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 419

def assessment_year
  @assessment_year
end

#base_postage ⇒ Float

The postage amount for this package.

Returns:

  • (Float) 


108
109
110
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 108

def base_postage
  @base_postage
end

#capt_dim_ht ⇒ Float

The captured height dimension of the package.

Returns:

  • (Float) 


82
83
84
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 82

def capt_dim_ht
  @capt_dim_ht
end

#capt_dim_len ⇒ Float

The captured length dimension of the package.

Returns:

  • (Float) 


74
75
76
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 74

def capt_dim_len
  @capt_dim_len
end

#capt_dim_wd ⇒ Float

The captured width dimension of the package.

Returns:

  • (Float) 


78
79
80
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 78

def capt_dim_wd
  @capt_dim_wd
end

#capt_wt ⇒ Float

The captured weight of the package.

Returns:

  • (Float) 


66
67
68
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 66

def capt_wt
  @capt_wt
end

#cc_withdrawal_date ⇒ DateTime

Credit Card Withdrawal Date

Returns:

  • (DateTime) 


467
468
469
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 467

def cc_withdrawal_date
  @cc_withdrawal_date
end

#cc_withdrawal_id ⇒ Float

Credit Card Aggregate Transaction ID.

Returns:

  • (Float) 


439
440
441
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 439

def cc_withdrawal_id
  @cc_withdrawal_id
end

#census_reason ⇒ String

Reason for Census, if applicable.

Returns:

  • (String) 


345
346
347
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 345

def census_reason
  @census_reason
end

#claimed_postage ⇒ Float

The postage claimed in manifest for this package.

Returns:

  • (Float) 


271
272
273
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 271

def claimed_postage
  @claimed_postage
end

#crid ⇒ String

Customer Registration ID used to identify the business location associated to a shipment.

Returns:

  • (String) 


476
477
478
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 476

def crid
  @crid
end

#cust_ref_num1 ⇒ String

Customs reference number 1

Returns:

  • (String) 


247
248
249
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 247

def cust_ref_num1
  @cust_ref_num1
end

#cust_ref_num2 ⇒ String

Customs reference number 2

Returns:

  • (String) 


251
252
253
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 251

def cust_ref_num2
  @cust_ref_num2
end

#destination_country_code ⇒ String

Destination country code

Returns:

  • (String) 


234
235
236
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 234

def destination_country_code
  @destination_country_code
end

#destination_zip_code ⇒ String

Destination zipcode associated to a shipment.

Returns:

  • (String) 


90
91
92
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 90

def destination_zip_code
  @destination_zip_code
end

#destntn_rate_ind ⇒ String

Original destinationRateIndicator submitted in manifest before autocorrection.

Returns:

  • (String) 


95
96
97
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 95

def destntn_rate_ind
  @destntn_rate_ind
end

#dim_height ⇒ Float

Dimensional Height reported in manifest for this package.

Returns:

  • (Float) 


333
334
335
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 333

def dim_height
  @dim_height
end

#dim_length ⇒ Float

Dimensional Length reported in manifest for this package.

Returns:

  • (Float) 


325
326
327
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 325

def dim_length
  @dim_length
end

#dim_width ⇒ Float

Dimensional Width reported in manifest for this package.

Returns:

  • (Float) 


329
330
331
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 329

def dim_width
  @dim_width
end

#display_tran_id ⇒ String

The Display Transaction ID

Returns:

  • (String) 


313
314
315
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 313

def display_tran_id
  @display_tran_id
end

#dispute_id ⇒ Float

Dispute ID associated with this package transaction, if applicable.

Returns:

  • (Float) 


359
360
361
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 359

def dispute_id
  @dispute_id
end

#dts_first ⇒ DateTime

First Scan Date

Returns:

  • (DateTime) 


363
364
365
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 363

def dts_first
  @dts_first
end

#efn ⇒ String

The electronic file number/EFN (or manifest number) of the package.

Returns:

  • (String) 


35
36
37
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 35

def efn
  @efn
end

#entry_facility_zipcode ⇒ String

The origin entry facility zipcode of the package.

Returns:

  • (String) 


86
87
88
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 86

def entry_facility_zipcode
  @entry_facility_zipcode
end

#eps_acc_num ⇒ String

The Enterprise Payment Account the package was charged to.

Returns:

  • (String) 


305
306
307
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 305

def eps_acc_num
  @eps_acc_num
end

#eps_account_nickname ⇒ String

Another name that refers to Enterprise Payment Account the package was charged to.

Returns:

  • (String) 


301
302
303
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 301

def 
  @eps_account_nickname
end

#eps_tran_type ⇒ String

SHIP Transaction Type. Only populated for OMAS, such as ME, M0, M1, M2, M3 etc.

Returns:

  • (String) 


284
285
286
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 284

def eps_tran_type
  @eps_tran_type
end

#external_ref_id ⇒ String

External Reference ID

Returns:

  • (String) 


484
485
486
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 484

def external_ref_id
  @external_ref_id
end

#extra_service1_amount ⇒ Float

Extra Service Amount 1.

Returns:

  • (Float) 


155
156
157
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 155

def extra_service1_amount
  @extra_service1_amount
end

#extra_service1_sku ⇒ String

Extra Service Sku 1.

Returns:

  • (String) 


175
176
177
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 175

def extra_service1_sku
  @extra_service1_sku
end

#extra_service2_amount ⇒ Float

Extra Service Amount 2.

Returns:

  • (Float) 


159
160
161
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 159

def extra_service2_amount
  @extra_service2_amount
end

#extra_service2_sku ⇒ String

Extra Service Sku 2.

Returns:

  • (String) 


179
180
181
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 179

def extra_service2_sku
  @extra_service2_sku
end

#extra_service3_amount ⇒ Float

Extra Service Amount 3.

Returns:

  • (Float) 


163
164
165
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 163

def extra_service3_amount
  @extra_service3_amount
end

#extra_service3_sku ⇒ String

Extra Service Sku 3.

Returns:

  • (String) 


183
184
185
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 183

def extra_service3_sku
  @extra_service3_sku
end

#extra_service4_amount ⇒ Float

Extra Service Amount 4.

Returns:

  • (Float) 


167
168
169
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 167

def extra_service4_amount
  @extra_service4_amount
end

#extra_service4_sku ⇒ String

Extra Service Sku 4.

Returns:

  • (String) 


187
188
189
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 187

def extra_service4_sku
  @extra_service4_sku
end

#extra_service5_amount ⇒ Float

Extra Service Amount 5.

Returns:

  • (Float) 


171
172
173
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 171

def extra_service5_amount
  @extra_service5_amount
end

#extra_service5_sku ⇒ String

Extra Service Sku 5.

Returns:

  • (String) 


191
192
193
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 191

def extra_service5_sku
  @extra_service5_sku
end

#extra_service_code1 ⇒ String

Extra Service Code 1.

Returns:

  • (String) 


135
136
137
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 135

def extra_service_code1
  @extra_service_code1
end

#extra_service_code2 ⇒ String

Extra Service Code 2.

Returns:

  • (String) 


139
140
141
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 139

def extra_service_code2
  @extra_service_code2
end

#extra_service_code3 ⇒ String

Extra Service Code 3.

Returns:

  • (String) 


143
144
145
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 143

def extra_service_code3
  @extra_service_code3
end

#extra_service_code4 ⇒ String

Extra Service Code 4.

Returns:

  • (String) 


147
148
149
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 147

def extra_service_code4
  @extra_service_code4
end

#extra_service_code5 ⇒ String

Extra Service Code 5.

Returns:

  • (String) 


151
152
153
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 151

def extra_service_code5
  @extra_service_code5
end

#foreign_postal_code ⇒ String

Foreign postal code

Returns:

  • (String) 


238
239
240
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 238

def foreign_postal_code
  @foreign_postal_code
end

#gross_commission ⇒ Float

Gross Commission for this package transaction.

Returns:

  • (Float) 


431
432
433
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 431

def gross_commission
  @gross_commission
end

#i_mpb ⇒ String

The Intelligent Mail Package Barcode of the package.

Returns:

  • (String) 


39
40
41
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 39

def i_mpb
  @i_mpb
end

#invoice_date ⇒ DateTime

Invoice Date

Returns:

  • (DateTime) 


471
472
473
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 471

def invoice_date
  @invoice_date
end

#invoice_id ⇒ Float

Invoice ID

Returns:

  • (Float) 


451
452
453
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 451

def invoice_id
  @invoice_id
end

#is_tpb ⇒ String

Flag to indicate if shipper is using third-party CRID/EPA

Returns:

  • (String) 


220
221
222
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 220

def is_tpb
  @is_tpb
end

#mailer_id ⇒ String

Mailer ID used in the barcode to identify the Mail Owner associated to a shipment.

Returns:

  • (String) 


48
49
50
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 48

def mailer_id
  @mailer_id
end

#mailing_date ⇒ DateTime

Combination of Date Of Mailing and Time Of Mailing YYYYMMDD + HHMMSS

Returns:

  • (DateTime) 


21
22
23
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 21

def mailing_date
  @mailing_date
end

#man_nonstndrd_char_fee ⇒ Float

Type of Fee Nonstandard Characteristic Fee reported in manifest for this package.

Returns:

  • (Float) 


131
132
133
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 131

def man_nonstndrd_char_fee
  @man_nonstndrd_char_fee
end

#manifest_dimensional_weight ⇒ Float

Dimensional Weight reported in manifest for this package.

Returns:

  • (Float) 


208
209
210
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 208

def manifest_dimensional_weight
  @manifest_dimensional_weight
end

#manifest_dri ⇒ String

Destination rate indicator reported in manifest for this package.

Returns:

  • (String) 


212
213
214
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 212

def manifest_dri
  @manifest_dri
end

#manifest_nonstndrd_length_fee1 ⇒ Float

Type of Fee Nonstandard Length Fee 1 reported in manifest for this package.

Returns:

  • (Float) 


117
118
119
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 117

def manifest_nonstndrd_length_fee1
  @manifest_nonstndrd_length_fee1
end

#manifest_nonstndrd_length_fee2 ⇒ Float

Type of Fee Nonstandard Length Fee 2 reported in manifest for this package.

Returns:

  • (Float) 


122
123
124
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 122

def manifest_nonstndrd_length_fee2
  @manifest_nonstndrd_length_fee2
end

#manifest_nonstndrd_volume_fee ⇒ Float

Type of Fee Nonstandard Volume Fee reported in manifest for this package.

Returns:

  • (Float) 


126
127
128
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 126

def manifest_nonstndrd_volume_fee
  @manifest_nonstndrd_volume_fee
end

#manifest_package_id ⇒ String

Unique Identifier for Manifest Package

Returns:

  • (String) 


204
205
206
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 204

def manifest_package_id
  @manifest_package_id
end

#manifest_rate_indicator ⇒ String

Rate indicator reported in manifest for this package.

Returns:

  • (String) 


216
217
218
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 216

def manifest_rate_indicator
  @manifest_rate_indicator
end

#manifest_transaction_id ⇒ String

The Enterprise Payment System Transaction ID the adjustment was charged to.

Returns:

  • (String) 


31
32
33
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 31

def manifest_transaction_id
  @manifest_transaction_id
end

#manifest_zone ⇒ String

Zone in manifest for this package.

Returns:

  • (String) 


341
342
343
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 341

def manifest_zone
  @manifest_zone
end

#master_mid ⇒ String

Mailer ID used in the barcode to identify the Mail Owner associated to a shipment.

Returns:

  • (String) 


26
27
28
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 26

def master_mid
  @master_mid
end

#merchant_rate_charged ⇒ Float

Scan Rate Charged to Merchant

Returns:

  • (Float) 


427
428
429
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 427

def merchant_rate_charged
  @merchant_rate_charged
end

#mid_owner_name ⇒ String

MID Owner Name

Returns:

  • (String) 


443
444
445
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 443

def mid_owner_name
  @mid_owner_name
end

#mid_user_name ⇒ String

MID User Name

Returns:

  • (String) 


447
448
449
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 447

def mid_user_name
  @mid_user_name
end

#noncompliance_fee ⇒ Float

Noncompliance fee

Returns:

  • (Float) 


415
416
417
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 415

def noncompliance_fee
  @noncompliance_fee
end

#packaging ⇒ String

Packaging

Returns:

  • (String) 


391
392
393
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 391

def packaging
  @packaging
end

#payment_method ⇒ String

Payment Method

Returns:

  • (String) 


279
280
281
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 279

def payment_method
  @payment_method
end

#permit_finance_no ⇒ String

Permit Finance Number for OMAS mailer – Will be populated if OMAS package

Returns:

  • (String) 


255
256
257
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 255

def permit_finance_no
  @permit_finance_no
end

#permit_no ⇒ String

Permit Number for OMAS Mailer – Will be populated if OMAS package

Returns:

  • (String) 


263
264
265
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 263

def permit_no
  @permit_no
end

#permit_type ⇒ String

Permit Type for OMAS mailer – Will be populated if OMAS package

Returns:

  • (String) 


259
260
261
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 259

def permit_type
  @permit_type
end

#pic ⇒ String

The Package Identification Code (PIC) of the package.

Returns:

  • (String) 


43
44
45
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 43

def pic
  @pic
end

#piece_count ⇒ Float

Number of packages included in the transaction

Returns:

  • (Float) 


296
297
298
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 296

def piece_count
  @piece_count
end

#pkg_grp_id ⇒ String

Unique ID used to group scans for a package

Returns:

  • (String) 


488
489
490
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 488

def pkg_grp_id
  @pkg_grp_id
end

#platform_rate ⇒ Float

Platform Rate for this package transaction.

Returns:

  • (Float) 


435
436
437
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 435

def platform_rate
  @platform_rate
end

#platform_user_id ⇒ String

Platform User ID

Returns:

  • (String) 


480
481
482
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 480

def platform_user_id
  @platform_user_id
end

#price_group ⇒ String

Price Group uses to assess International packages. Will be blank for domestic or Canada

Returns:

  • (String) 


243
244
245
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 243

def price_group
  @price_group
end

#price_type ⇒ String

Mailing Standards SKU Service Price Type Code

Returns:

  • (String) 


267
268
269
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 267

def price_type
  @price_type
end

#processing_category ⇒ String

A unique ID representing the processing category associated to a shipment.

Returns:

  • (String) 


58
59
60
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 58

def processing_category
  @processing_category
end

#processing_category_name ⇒ ProcessingCategoryName

A name representing the processing category associated to a shipment.

Returns:



62
63
64
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 62

def processing_category_name
  @processing_category_name
end

#published_price ⇒ Float

Published base price for piece for use in calculating monthly averages

Returns:

  • (Float) 


112
113
114
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 112

def published_price
  @published_price
end

#rate_indicator ⇒ String

Original rateIndicator submitted in manifest before autocorrection.

Returns:

  • (String) 


99
100
101
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 99

def rate_indicator
  @rate_indicator
end

#scan_nonstndrd_char_fee ⇒ Float

Scan non standard character fee

Returns:

  • (Float) 


411
412
413
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 411

def scan_nonstndrd_char_fee
  @scan_nonstndrd_char_fee
end

#scan_nonstndrd_length_fee1 ⇒ Float

Scan non standard length fee 1

Returns:

  • (Float) 


399
400
401
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 399

def scan_nonstndrd_length_fee1
  @scan_nonstndrd_length_fee1
end

#scan_nonstndrd_length_fee2 ⇒ Float

Scan non standard length fee 2

Returns:

  • (Float) 


403
404
405
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 403

def scan_nonstndrd_length_fee2
  @scan_nonstndrd_length_fee2
end

#scan_nonstndrd_volume_fee ⇒ Float

Scan non standard volume fee

Returns:

  • (Float) 


407
408
409
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 407

def scan_nonstndrd_volume_fee
  @scan_nonstndrd_volume_fee
end

#service_type_code ⇒ String

The service type code of the item. Refer to USPS® [Pub 199](postalpro.usps.com/pub199) Appendix I Intelligent Mail Package Barcode Service Type Codes for all possible published values.

Returns:

  • (String) 


54
55
56
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 54

def service_type_code
  @service_type_code
end

#ship_tran_amt ⇒ Float

The amount of the transaction

Returns:

  • (Float) 


292
293
294
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 292

def ship_tran_amt
  @ship_tran_amt
end

#ship_tran_dt ⇒ DateTime

The Ship transaction date

Returns:

  • (DateTime) 


309
310
311
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 309

def ship_tran_dt
  @ship_tran_dt
end

#sku ⇒ String

SKU or product identifier used by downstream applications to determine understand the type of parcel service, it like a VIP code.

Returns:

  • (String) 


104
105
106
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 104

def sku
  @sku
end

#srch_sku ⇒ String

Surcharge SKU or product identifier used by downstream applications to determine understand the type of parcel service, it like a VIP code.

Returns:

  • (String) 


196
197
198
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 196

def srch_sku
  @srch_sku
end

#total_variance ⇒ Float

Short paid or overpaid amount for this package.

Returns:

  • (Float) 


337
338
339
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 337

def total_variance
  @total_variance
end

#tpb_shipper_crid ⇒ String

Populated with Third-Party CRID in event of Third-Party scenarios. Populated with Shipper CRID in non-Third-Party scenarios

Returns:

  • (String) 


225
226
227
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 225

def tpb_shipper_crid
  @tpb_shipper_crid
end

#tpb_shipper_name ⇒ String

Populated with Third-Party Shipper name in event of Third-Party scenarios. Populated with Shipper name in non-Third-Party scenarios

Returns:

  • (String) 


230
231
232
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 230

def tpb_shipper_name
  @tpb_shipper_name
end

#transaction_description ⇒ String

Transaction Description provides more details on the transaction type

Returns:

  • (String) 


288
289
290
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 288

def transaction_description
  @transaction_description
end

#transmission_date ⇒ DateTime

Earliest Datetime USPS scanned the package.

Returns:

  • (DateTime) 


17
18
19
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 17

def transmission_date
  @transmission_date
end

#upc_code ⇒ String

UPC Code

Returns:

  • (String) 


395
396
397
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 395

def upc_code
  @upc_code
end

#usps_dimensional_weight ⇒ Float

The captured dimensional weight of the package.

Returns:

  • (Float) 


70
71
72
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 70

def usps_dimensional_weight
  @usps_dimensional_weight
end

#warnings ⇒ String

Warning messages related to the package transaction.

Returns:

  • (String) 


200
201
202
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 200

def warnings
  @warnings
end

#weight ⇒ Float

Mailing Standards SKU Service Weight Code

Returns:

  • (Float) 


321
322
323
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 321

def weight
  @weight
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 927

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  transmission_date = if hash.key?('transmissionDate')
                        (DateTimeHelper.from_rfc3339(hash['transmissionDate']) if hash['transmissionDate'])
                      else
                        SKIP
                      end
  mailing_date = if hash.key?('mailingDate')
                   (DateTimeHelper.from_rfc3339(hash['mailingDate']) if hash['mailingDate'])
                 else
                   SKIP
                 end
  master_mid = hash.key?('masterMID') ? hash['masterMID'] : SKIP
  manifest_transaction_id =
    hash.key?('manifestTransactionID') ? hash['manifestTransactionID'] : SKIP
  efn = hash.key?('EFN') ? hash['EFN'] : SKIP
  i_mpb = hash.key?('IMpb') ? hash['IMpb'] : SKIP
  pic = hash.key?('PIC') ? hash['PIC'] : SKIP
  mailer_id = hash.key?('mailerID') ? hash['mailerID'] : SKIP
  service_type_code =
    hash.key?('serviceTypeCode') ? hash['serviceTypeCode'] : SKIP
  processing_category =
    hash.key?('processingCategory') ? hash['processingCategory'] : SKIP
  processing_category_name =
    hash.key?('processingCategoryName') ? hash['processingCategoryName'] : SKIP
  capt_wt = hash.key?('captWt') ? hash['captWt'] : SKIP
  usps_dimensional_weight =
    hash.key?('uspsDimensionalWeight') ? hash['uspsDimensionalWeight'] : SKIP
  capt_dim_len = hash.key?('captDimLen') ? hash['captDimLen'] : SKIP
  capt_dim_wd = hash.key?('captDimWd') ? hash['captDimWd'] : SKIP
  capt_dim_ht = hash.key?('captDimHt') ? hash['captDimHt'] : SKIP
  entry_facility_zipcode =
    hash.key?('entryFacilityZipcode') ? hash['entryFacilityZipcode'] : SKIP
  destination_zip_code =
    hash.key?('destinationZipCode') ? hash['destinationZipCode'] : SKIP
  destntn_rate_ind =
    hash.key?('destntnRateInd') ? hash['destntnRateInd'] : SKIP
  rate_indicator = hash.key?('rateIndicator') ? hash['rateIndicator'] : SKIP
  sku = hash.key?('sku') ? hash['sku'] : SKIP
  base_postage = hash.key?('basePostage') ? hash['basePostage'] : SKIP
  published_price =
    hash.key?('publishedPrice') ? hash['publishedPrice'] : SKIP
  manifest_nonstndrd_length_fee1 =
    hash.key?('manifestNonstndrdLengthFee1') ? hash['manifestNonstndrdLengthFee1'] : SKIP
  manifest_nonstndrd_length_fee2 =
    hash.key?('manifestNonstndrdLengthFee2') ? hash['manifestNonstndrdLengthFee2'] : SKIP
  manifest_nonstndrd_volume_fee =
    hash.key?('manifestNonstndrdVolumeFee') ? hash['manifestNonstndrdVolumeFee'] : SKIP
  man_nonstndrd_char_fee =
    hash.key?('manNonstndrdCharFee') ? hash['manNonstndrdCharFee'] : SKIP
  extra_service_code1 =
    hash.key?('extraServiceCode1') ? hash['extraServiceCode1'] : SKIP
  extra_service_code2 =
    hash.key?('extraServiceCode2') ? hash['extraServiceCode2'] : SKIP
  extra_service_code3 =
    hash.key?('extraServiceCode3') ? hash['extraServiceCode3'] : SKIP
  extra_service_code4 =
    hash.key?('extraServiceCode4') ? hash['extraServiceCode4'] : SKIP
  extra_service_code5 =
    hash.key?('extraServiceCode5') ? hash['extraServiceCode5'] : SKIP
  extra_service1_amount =
    hash.key?('extraService1Amount') ? hash['extraService1Amount'] : SKIP
  extra_service2_amount =
    hash.key?('extraService2Amount') ? hash['extraService2Amount'] : SKIP
  extra_service3_amount =
    hash.key?('extraService3Amount') ? hash['extraService3Amount'] : SKIP
  extra_service4_amount =
    hash.key?('extraService4Amount') ? hash['extraService4Amount'] : SKIP
  extra_service5_amount =
    hash.key?('extraService5Amount') ? hash['extraService5Amount'] : SKIP
  extra_service1_sku =
    hash.key?('extraService1Sku') ? hash['extraService1Sku'] : SKIP
  extra_service2_sku =
    hash.key?('extraService2Sku') ? hash['extraService2Sku'] : SKIP
  extra_service3_sku =
    hash.key?('extraService3Sku') ? hash['extraService3Sku'] : SKIP
  extra_service4_sku =
    hash.key?('extraService4Sku') ? hash['extraService4Sku'] : SKIP
  extra_service5_sku =
    hash.key?('extraService5Sku') ? hash['extraService5Sku'] : SKIP
  srch_sku = hash.key?('srchSku') ? hash['srchSku'] : SKIP
  warnings = hash.key?('warnings') ? hash['warnings'] : SKIP
  manifest_package_id =
    hash.key?('manifestPackageId') ? hash['manifestPackageId'] : SKIP
  manifest_dimensional_weight =
    hash.key?('manifestDimensionalWeight') ? hash['manifestDimensionalWeight'] : SKIP
  manifest_dri = hash.key?('manifestDri') ? hash['manifestDri'] : SKIP
  manifest_rate_indicator =
    hash.key?('manifestRateIndicator') ? hash['manifestRateIndicator'] : SKIP
  is_tpb = hash.key?('isTpb') ? hash['isTpb'] : SKIP
  tpb_shipper_crid =
    hash.key?('tpbShipperCrid') ? hash['tpbShipperCrid'] : SKIP
  tpb_shipper_name =
    hash.key?('tpbShipperName') ? hash['tpbShipperName'] : SKIP
  destination_country_code =
    hash.key?('destinationCountryCode') ? hash['destinationCountryCode'] : SKIP
  foreign_postal_code =
    hash.key?('foreignPostalCode') ? hash['foreignPostalCode'] : SKIP
  price_group = hash.key?('priceGroup') ? hash['priceGroup'] : SKIP
  cust_ref_num1 = hash.key?('custRefNum1') ? hash['custRefNum1'] : SKIP
  cust_ref_num2 = hash.key?('custRefNum2') ? hash['custRefNum2'] : SKIP
  permit_finance_no =
    hash.key?('permitFinanceNo') ? hash['permitFinanceNo'] : SKIP
  permit_type = hash.key?('permitType') ? hash['permitType'] : SKIP
  permit_no = hash.key?('permitNo') ? hash['permitNo'] : SKIP
  price_type = hash.key?('priceType') ? hash['priceType'] : SKIP
  claimed_postage =
    hash.key?('claimedPostage') ? hash['claimedPostage'] : SKIP
  assessed_postage =
    hash.key?('assessedPostage') ? hash['assessedPostage'] : SKIP
  payment_method = hash.key?('paymentMethod') ? hash['paymentMethod'] : SKIP
  eps_tran_type = hash.key?('epsTranType') ? hash['epsTranType'] : SKIP
  transaction_description =
    hash.key?('transactionDescription') ? hash['transactionDescription'] : SKIP
  ship_tran_amt = hash.key?('shipTranAmt') ? hash['shipTranAmt'] : SKIP
  piece_count = hash.key?('pieceCount') ? hash['pieceCount'] : SKIP
   =
    hash.key?('epsAccountNickname') ? hash['epsAccountNickname'] : SKIP
  eps_acc_num = hash.key?('epsAccNum') ? hash['epsAccNum'] : SKIP
  ship_tran_dt = if hash.key?('shipTranDt')
                   (DateTimeHelper.from_rfc3339(hash['shipTranDt']) if hash['shipTranDt'])
                 else
                   SKIP
                 end
  display_tran_id =
    hash.key?('displayTranId') ? hash['displayTranId'] : SKIP
  ach_withdrawal_id =
    hash.key?('achWithdrawalId') ? hash['achWithdrawalId'] : SKIP
  weight = hash.key?('weight') ? hash['weight'] : SKIP
  dim_length = hash.key?('dimLength') ? hash['dimLength'] : SKIP
  dim_width = hash.key?('dimWidth') ? hash['dimWidth'] : SKIP
  dim_height = hash.key?('dimHeight') ? hash['dimHeight'] : SKIP
  total_variance = hash.key?('totalVariance') ? hash['totalVariance'] : SKIP
  manifest_zone = hash.key?('manifestZone') ? hash['manifestZone'] : SKIP
  census_reason = hash.key?('censusReason') ? hash['censusReason'] : SKIP
  assessment_type =
    hash.key?('assessmentType') ? hash['assessmentType'] : SKIP
  admin_fee_type = hash.key?('adminFeeType') ? hash['adminFeeType'] : SKIP
  dispute_id = hash.key?('disputeId') ? hash['disputeId'] : SKIP
  dts_first = if hash.key?('dtsFirst')
                (DateTimeHelper.from_rfc3339(hash['dtsFirst']) if hash['dtsFirst'])
              else
                SKIP
              end
  assd_mc_code = hash.key?('assdMcCode') ? hash['assdMcCode'] : SKIP
  assessed_length =
    hash.key?('assessedLength') ? hash['assessedLength'] : SKIP
  assessed_weight =
    hash.key?('assessedWeight') ? hash['assessedWeight'] : SKIP
  assessed_height =
    hash.key?('assessedHeight') ? hash['assessedHeight'] : SKIP
  assessed_width = hash.key?('assessedWidth') ? hash['assessedWidth'] : SKIP
  assessed_zone = hash.key?('assessedZone') ? hash['assessedZone'] : SKIP
  packaging = hash.key?('packaging') ? hash['packaging'] : SKIP
  upc_code = hash.key?('upcCode') ? hash['upcCode'] : SKIP
  scan_nonstndrd_length_fee1 =
    hash.key?('scanNonstndrdLengthFee1') ? hash['scanNonstndrdLengthFee1'] : SKIP
  scan_nonstndrd_length_fee2 =
    hash.key?('scanNonstndrdLengthFee2') ? hash['scanNonstndrdLengthFee2'] : SKIP
  scan_nonstndrd_volume_fee =
    hash.key?('scanNonstndrdVolumeFee') ? hash['scanNonstndrdVolumeFee'] : SKIP
  scan_nonstndrd_char_fee =
    hash.key?('scanNonstndrdCharFee') ? hash['scanNonstndrdCharFee'] : SKIP
  noncompliance_fee =
    hash.key?('noncomplianceFee') ? hash['noncomplianceFee'] : SKIP
  assessment_year =
    hash.key?('assessmentYear') ? hash['assessmentYear'] : SKIP
  assessed_mail_class =
    hash.key?('assessedMailClass') ? hash['assessedMailClass'] : SKIP
  merchant_rate_charged =
    hash.key?('merchantRateCharged') ? hash['merchantRateCharged'] : SKIP
  gross_commission =
    hash.key?('grossCommission') ? hash['grossCommission'] : SKIP
  platform_rate = hash.key?('platformRate') ? hash['platformRate'] : SKIP
  cc_withdrawal_id =
    hash.key?('ccWithdrawalId') ? hash['ccWithdrawalId'] : SKIP
  mid_owner_name = hash.key?('midOwnerName') ? hash['midOwnerName'] : SKIP
  mid_user_name = hash.key?('midUserName') ? hash['midUserName'] : SKIP
  invoice_id = hash.key?('invoiceId') ? hash['invoiceId'] : SKIP
  assessment_details =
    hash.key?('assessmentDetails') ? hash['assessmentDetails'] : SKIP
  assessment_month =
    hash.key?('assessmentMonth') ? hash['assessmentMonth'] : SKIP
  ach_withdrawal_date = if hash.key?('achWithdrawalDate')
                          (DateTimeHelper.from_rfc3339(hash['achWithdrawalDate']) if hash['achWithdrawalDate'])
                        else
                          SKIP
                        end
  cc_withdrawal_date = if hash.key?('ccWithdrawalDate')
                         (DateTimeHelper.from_rfc3339(hash['ccWithdrawalDate']) if hash['ccWithdrawalDate'])
                       else
                         SKIP
                       end
  invoice_date = if hash.key?('invoiceDate')
                   (DateTimeHelper.from_rfc3339(hash['invoiceDate']) if hash['invoiceDate'])
                 else
                   SKIP
                 end
  crid = hash.key?('CRID') ? hash['CRID'] : SKIP
  platform_user_id =
    hash.key?('platformUserId') ? hash['platformUserId'] : SKIP
  external_ref_id =
    hash.key?('externalRefId') ? hash['externalRefId'] : SKIP
  pkg_grp_id = hash.key?('pkgGrpId') ? hash['pkgGrpId'] : SKIP

  # Create object from extracted values.
  PackageTransactionDetails.new(transmission_date: transmission_date,
                                mailing_date: mailing_date,
                                master_mid: master_mid,
                                manifest_transaction_id: manifest_transaction_id,
                                efn: efn,
                                i_mpb: i_mpb,
                                pic: pic,
                                mailer_id: mailer_id,
                                service_type_code: service_type_code,
                                processing_category: processing_category,
                                processing_category_name: processing_category_name,
                                capt_wt: capt_wt,
                                usps_dimensional_weight: usps_dimensional_weight,
                                capt_dim_len: capt_dim_len,
                                capt_dim_wd: capt_dim_wd,
                                capt_dim_ht: capt_dim_ht,
                                entry_facility_zipcode: entry_facility_zipcode,
                                destination_zip_code: destination_zip_code,
                                destntn_rate_ind: destntn_rate_ind,
                                rate_indicator: rate_indicator,
                                sku: sku,
                                base_postage: base_postage,
                                published_price: published_price,
                                manifest_nonstndrd_length_fee1: manifest_nonstndrd_length_fee1,
                                manifest_nonstndrd_length_fee2: manifest_nonstndrd_length_fee2,
                                manifest_nonstndrd_volume_fee: manifest_nonstndrd_volume_fee,
                                man_nonstndrd_char_fee: man_nonstndrd_char_fee,
                                extra_service_code1: extra_service_code1,
                                extra_service_code2: extra_service_code2,
                                extra_service_code3: extra_service_code3,
                                extra_service_code4: extra_service_code4,
                                extra_service_code5: extra_service_code5,
                                extra_service1_amount: extra_service1_amount,
                                extra_service2_amount: extra_service2_amount,
                                extra_service3_amount: extra_service3_amount,
                                extra_service4_amount: extra_service4_amount,
                                extra_service5_amount: extra_service5_amount,
                                extra_service1_sku: extra_service1_sku,
                                extra_service2_sku: extra_service2_sku,
                                extra_service3_sku: extra_service3_sku,
                                extra_service4_sku: extra_service4_sku,
                                extra_service5_sku: extra_service5_sku,
                                srch_sku: srch_sku,
                                warnings: warnings,
                                manifest_package_id: manifest_package_id,
                                manifest_dimensional_weight: manifest_dimensional_weight,
                                manifest_dri: manifest_dri,
                                manifest_rate_indicator: manifest_rate_indicator,
                                is_tpb: is_tpb,
                                tpb_shipper_crid: tpb_shipper_crid,
                                tpb_shipper_name: tpb_shipper_name,
                                destination_country_code: destination_country_code,
                                foreign_postal_code: foreign_postal_code,
                                price_group: price_group,
                                cust_ref_num1: cust_ref_num1,
                                cust_ref_num2: cust_ref_num2,
                                permit_finance_no: permit_finance_no,
                                permit_type: permit_type,
                                permit_no: permit_no,
                                price_type: price_type,
                                claimed_postage: claimed_postage,
                                assessed_postage: assessed_postage,
                                payment_method: payment_method,
                                eps_tran_type: eps_tran_type,
                                transaction_description: transaction_description,
                                ship_tran_amt: ship_tran_amt,
                                piece_count: piece_count,
                                eps_account_nickname: ,
                                eps_acc_num: eps_acc_num,
                                ship_tran_dt: ship_tran_dt,
                                display_tran_id: display_tran_id,
                                ach_withdrawal_id: ach_withdrawal_id,
                                weight: weight,
                                dim_length: dim_length,
                                dim_width: dim_width,
                                dim_height: dim_height,
                                total_variance: total_variance,
                                manifest_zone: manifest_zone,
                                census_reason: census_reason,
                                assessment_type: assessment_type,
                                admin_fee_type: admin_fee_type,
                                dispute_id: dispute_id,
                                dts_first: dts_first,
                                assd_mc_code: assd_mc_code,
                                assessed_length: assessed_length,
                                assessed_weight: assessed_weight,
                                assessed_height: assessed_height,
                                assessed_width: assessed_width,
                                assessed_zone: assessed_zone,
                                packaging: packaging,
                                upc_code: upc_code,
                                scan_nonstndrd_length_fee1: scan_nonstndrd_length_fee1,
                                scan_nonstndrd_length_fee2: scan_nonstndrd_length_fee2,
                                scan_nonstndrd_volume_fee: scan_nonstndrd_volume_fee,
                                scan_nonstndrd_char_fee: scan_nonstndrd_char_fee,
                                noncompliance_fee: noncompliance_fee,
                                assessment_year: assessment_year,
                                assessed_mail_class: assessed_mail_class,
                                merchant_rate_charged: merchant_rate_charged,
                                gross_commission: gross_commission,
                                platform_rate: platform_rate,
                                cc_withdrawal_id: cc_withdrawal_id,
                                mid_owner_name: mid_owner_name,
                                mid_user_name: mid_user_name,
                                invoice_id: invoice_id,
                                assessment_details: assessment_details,
                                assessment_month: assessment_month,
                                ach_withdrawal_date: ach_withdrawal_date,
                                cc_withdrawal_date: cc_withdrawal_date,
                                invoice_date: invoice_date,
                                crid: crid,
                                platform_user_id: platform_user_id,
                                external_ref_id: external_ref_id,
                                pkg_grp_id: pkg_grp_id)
end

.names ⇒ Object

A mapping from model property names to API property names.



491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 491

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['transmission_date'] = 'transmissionDate'
  @_hash['mailing_date'] = 'mailingDate'
  @_hash['master_mid'] = 'masterMID'
  @_hash['manifest_transaction_id'] = 'manifestTransactionID'
  @_hash['efn'] = 'EFN'
  @_hash['i_mpb'] = 'IMpb'
  @_hash['pic'] = 'PIC'
  @_hash['mailer_id'] = 'mailerID'
  @_hash['service_type_code'] = 'serviceTypeCode'
  @_hash['processing_category'] = 'processingCategory'
  @_hash['processing_category_name'] = 'processingCategoryName'
  @_hash['capt_wt'] = 'captWt'
  @_hash['usps_dimensional_weight'] = 'uspsDimensionalWeight'
  @_hash['capt_dim_len'] = 'captDimLen'
  @_hash['capt_dim_wd'] = 'captDimWd'
  @_hash['capt_dim_ht'] = 'captDimHt'
  @_hash['entry_facility_zipcode'] = 'entryFacilityZipcode'
  @_hash['destination_zip_code'] = 'destinationZipCode'
  @_hash['destntn_rate_ind'] = 'destntnRateInd'
  @_hash['rate_indicator'] = 'rateIndicator'
  @_hash['sku'] = 'sku'
  @_hash['base_postage'] = 'basePostage'
  @_hash['published_price'] = 'publishedPrice'
  @_hash['manifest_nonstndrd_length_fee1'] = 'manifestNonstndrdLengthFee1'
  @_hash['manifest_nonstndrd_length_fee2'] = 'manifestNonstndrdLengthFee2'
  @_hash['manifest_nonstndrd_volume_fee'] = 'manifestNonstndrdVolumeFee'
  @_hash['man_nonstndrd_char_fee'] = 'manNonstndrdCharFee'
  @_hash['extra_service_code1'] = 'extraServiceCode1'
  @_hash['extra_service_code2'] = 'extraServiceCode2'
  @_hash['extra_service_code3'] = 'extraServiceCode3'
  @_hash['extra_service_code4'] = 'extraServiceCode4'
  @_hash['extra_service_code5'] = 'extraServiceCode5'
  @_hash['extra_service1_amount'] = 'extraService1Amount'
  @_hash['extra_service2_amount'] = 'extraService2Amount'
  @_hash['extra_service3_amount'] = 'extraService3Amount'
  @_hash['extra_service4_amount'] = 'extraService4Amount'
  @_hash['extra_service5_amount'] = 'extraService5Amount'
  @_hash['extra_service1_sku'] = 'extraService1Sku'
  @_hash['extra_service2_sku'] = 'extraService2Sku'
  @_hash['extra_service3_sku'] = 'extraService3Sku'
  @_hash['extra_service4_sku'] = 'extraService4Sku'
  @_hash['extra_service5_sku'] = 'extraService5Sku'
  @_hash['srch_sku'] = 'srchSku'
  @_hash['warnings'] = 'warnings'
  @_hash['manifest_package_id'] = 'manifestPackageId'
  @_hash['manifest_dimensional_weight'] = 'manifestDimensionalWeight'
  @_hash['manifest_dri'] = 'manifestDri'
  @_hash['manifest_rate_indicator'] = 'manifestRateIndicator'
  @_hash['is_tpb'] = 'isTpb'
  @_hash['tpb_shipper_crid'] = 'tpbShipperCrid'
  @_hash['tpb_shipper_name'] = 'tpbShipperName'
  @_hash['destination_country_code'] = 'destinationCountryCode'
  @_hash['foreign_postal_code'] = 'foreignPostalCode'
  @_hash['price_group'] = 'priceGroup'
  @_hash['cust_ref_num1'] = 'custRefNum1'
  @_hash['cust_ref_num2'] = 'custRefNum2'
  @_hash['permit_finance_no'] = 'permitFinanceNo'
  @_hash['permit_type'] = 'permitType'
  @_hash['permit_no'] = 'permitNo'
  @_hash['price_type'] = 'priceType'
  @_hash['claimed_postage'] = 'claimedPostage'
  @_hash['assessed_postage'] = 'assessedPostage'
  @_hash['payment_method'] = 'paymentMethod'
  @_hash['eps_tran_type'] = 'epsTranType'
  @_hash['transaction_description'] = 'transactionDescription'
  @_hash['ship_tran_amt'] = 'shipTranAmt'
  @_hash['piece_count'] = 'pieceCount'
  @_hash['eps_account_nickname'] = 'epsAccountNickname'
  @_hash['eps_acc_num'] = 'epsAccNum'
  @_hash['ship_tran_dt'] = 'shipTranDt'
  @_hash['display_tran_id'] = 'displayTranId'
  @_hash['ach_withdrawal_id'] = 'achWithdrawalId'
  @_hash['weight'] = 'weight'
  @_hash['dim_length'] = 'dimLength'
  @_hash['dim_width'] = 'dimWidth'
  @_hash['dim_height'] = 'dimHeight'
  @_hash['total_variance'] = 'totalVariance'
  @_hash['manifest_zone'] = 'manifestZone'
  @_hash['census_reason'] = 'censusReason'
  @_hash['assessment_type'] = 'assessmentType'
  @_hash['admin_fee_type'] = 'adminFeeType'
  @_hash['dispute_id'] = 'disputeId'
  @_hash['dts_first'] = 'dtsFirst'
  @_hash['assd_mc_code'] = 'assdMcCode'
  @_hash['assessed_length'] = 'assessedLength'
  @_hash['assessed_weight'] = 'assessedWeight'
  @_hash['assessed_height'] = 'assessedHeight'
  @_hash['assessed_width'] = 'assessedWidth'
  @_hash['assessed_zone'] = 'assessedZone'
  @_hash['packaging'] = 'packaging'
  @_hash['upc_code'] = 'upcCode'
  @_hash['scan_nonstndrd_length_fee1'] = 'scanNonstndrdLengthFee1'
  @_hash['scan_nonstndrd_length_fee2'] = 'scanNonstndrdLengthFee2'
  @_hash['scan_nonstndrd_volume_fee'] = 'scanNonstndrdVolumeFee'
  @_hash['scan_nonstndrd_char_fee'] = 'scanNonstndrdCharFee'
  @_hash['noncompliance_fee'] = 'noncomplianceFee'
  @_hash['assessment_year'] = 'assessmentYear'
  @_hash['assessed_mail_class'] = 'assessedMailClass'
  @_hash['merchant_rate_charged'] = 'merchantRateCharged'
  @_hash['gross_commission'] = 'grossCommission'
  @_hash['platform_rate'] = 'platformRate'
  @_hash['cc_withdrawal_id'] = 'ccWithdrawalId'
  @_hash['mid_owner_name'] = 'midOwnerName'
  @_hash['mid_user_name'] = 'midUserName'
  @_hash['invoice_id'] = 'invoiceId'
  @_hash['assessment_details'] = 'assessmentDetails'
  @_hash['assessment_month'] = 'assessmentMonth'
  @_hash['ach_withdrawal_date'] = 'achWithdrawalDate'
  @_hash['cc_withdrawal_date'] = 'ccWithdrawalDate'
  @_hash['invoice_date'] = 'invoiceDate'
  @_hash['crid'] = 'CRID'
  @_hash['platform_user_id'] = 'platformUserId'
  @_hash['external_ref_id'] = 'externalRefId'
  @_hash['pkg_grp_id'] = 'pkgGrpId'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



731
732
733
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 731

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 611

def self.optionals
  %w[
    transmission_date
    mailing_date
    master_mid
    manifest_transaction_id
    efn
    i_mpb
    pic
    mailer_id
    service_type_code
    processing_category
    processing_category_name
    capt_wt
    usps_dimensional_weight
    capt_dim_len
    capt_dim_wd
    capt_dim_ht
    entry_facility_zipcode
    destination_zip_code
    destntn_rate_ind
    rate_indicator
    sku
    base_postage
    published_price
    manifest_nonstndrd_length_fee1
    manifest_nonstndrd_length_fee2
    manifest_nonstndrd_volume_fee
    man_nonstndrd_char_fee
    extra_service_code1
    extra_service_code2
    extra_service_code3
    extra_service_code4
    extra_service_code5
    extra_service1_amount
    extra_service2_amount
    extra_service3_amount
    extra_service4_amount
    extra_service5_amount
    extra_service1_sku
    extra_service2_sku
    extra_service3_sku
    extra_service4_sku
    extra_service5_sku
    srch_sku
    warnings
    manifest_package_id
    manifest_dimensional_weight
    manifest_dri
    manifest_rate_indicator
    is_tpb
    tpb_shipper_crid
    tpb_shipper_name
    destination_country_code
    foreign_postal_code
    price_group
    cust_ref_num1
    cust_ref_num2
    permit_finance_no
    permit_type
    permit_no
    price_type
    claimed_postage
    assessed_postage
    payment_method
    eps_tran_type
    transaction_description
    ship_tran_amt
    piece_count
    eps_account_nickname
    eps_acc_num
    ship_tran_dt
    display_tran_id
    ach_withdrawal_id
    weight
    dim_length
    dim_width
    dim_height
    total_variance
    manifest_zone
    census_reason
    assessment_type
    admin_fee_type
    dispute_id
    dts_first
    assd_mc_code
    assessed_length
    assessed_weight
    assessed_height
    assessed_width
    assessed_zone
    packaging
    upc_code
    scan_nonstndrd_length_fee1
    scan_nonstndrd_length_fee2
    scan_nonstndrd_volume_fee
    scan_nonstndrd_char_fee
    noncompliance_fee
    assessment_year
    assessed_mail_class
    merchant_rate_charged
    gross_commission
    platform_rate
    cc_withdrawal_id
    mid_owner_name
    mid_user_name
    invoice_id
    assessment_details
    assessment_month
    ach_withdrawal_date
    cc_withdrawal_date
    invoice_date
    crid
    platform_user_id
    external_ref_id
    pkg_grp_id
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 1340

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} transmission_date: #{@transmission_date.inspect}, mailing_date:"\
  " #{@mailing_date.inspect}, master_mid: #{@master_mid.inspect}, manifest_transaction_id:"\
  " #{@manifest_transaction_id.inspect}, efn: #{@efn.inspect}, i_mpb: #{@i_mpb.inspect}, pic:"\
  " #{@pic.inspect}, mailer_id: #{@mailer_id.inspect}, service_type_code:"\
  " #{@service_type_code.inspect}, processing_category: #{@processing_category.inspect},"\
  " processing_category_name: #{@processing_category_name.inspect}, capt_wt:"\
  " #{@capt_wt.inspect}, usps_dimensional_weight: #{@usps_dimensional_weight.inspect},"\
  " capt_dim_len: #{@capt_dim_len.inspect}, capt_dim_wd: #{@capt_dim_wd.inspect}, capt_dim_ht:"\
  " #{@capt_dim_ht.inspect}, entry_facility_zipcode: #{@entry_facility_zipcode.inspect},"\
  " destination_zip_code: #{@destination_zip_code.inspect}, destntn_rate_ind:"\
  " #{@destntn_rate_ind.inspect}, rate_indicator: #{@rate_indicator.inspect}, sku:"\
  " #{@sku.inspect}, base_postage: #{@base_postage.inspect}, published_price:"\
  " #{@published_price.inspect}, manifest_nonstndrd_length_fee1:"\
  " #{@manifest_nonstndrd_length_fee1.inspect}, manifest_nonstndrd_length_fee2:"\
  " #{@manifest_nonstndrd_length_fee2.inspect}, manifest_nonstndrd_volume_fee:"\
  " #{@manifest_nonstndrd_volume_fee.inspect}, man_nonstndrd_char_fee:"\
  " #{@man_nonstndrd_char_fee.inspect}, extra_service_code1: #{@extra_service_code1.inspect},"\
  " extra_service_code2: #{@extra_service_code2.inspect}, extra_service_code3:"\
  " #{@extra_service_code3.inspect}, extra_service_code4: #{@extra_service_code4.inspect},"\
  " extra_service_code5: #{@extra_service_code5.inspect}, extra_service1_amount:"\
  " #{@extra_service1_amount.inspect}, extra_service2_amount:"\
  " #{@extra_service2_amount.inspect}, extra_service3_amount:"\
  " #{@extra_service3_amount.inspect}, extra_service4_amount:"\
  " #{@extra_service4_amount.inspect}, extra_service5_amount:"\
  " #{@extra_service5_amount.inspect}, extra_service1_sku: #{@extra_service1_sku.inspect},"\
  " extra_service2_sku: #{@extra_service2_sku.inspect}, extra_service3_sku:"\
  " #{@extra_service3_sku.inspect}, extra_service4_sku: #{@extra_service4_sku.inspect},"\
  " extra_service5_sku: #{@extra_service5_sku.inspect}, srch_sku: #{@srch_sku.inspect},"\
  " warnings: #{@warnings.inspect}, manifest_package_id: #{@manifest_package_id.inspect},"\
  " manifest_dimensional_weight: #{@manifest_dimensional_weight.inspect}, manifest_dri:"\
  " #{@manifest_dri.inspect}, manifest_rate_indicator: #{@manifest_rate_indicator.inspect},"\
  " is_tpb: #{@is_tpb.inspect}, tpb_shipper_crid: #{@tpb_shipper_crid.inspect},"\
  " tpb_shipper_name: #{@tpb_shipper_name.inspect}, destination_country_code:"\
  " #{@destination_country_code.inspect}, foreign_postal_code:"\
  " #{@foreign_postal_code.inspect}, price_group: #{@price_group.inspect}, cust_ref_num1:"\
  " #{@cust_ref_num1.inspect}, cust_ref_num2: #{@cust_ref_num2.inspect}, permit_finance_no:"\
  " #{@permit_finance_no.inspect}, permit_type: #{@permit_type.inspect}, permit_no:"\
  " #{@permit_no.inspect}, price_type: #{@price_type.inspect}, claimed_postage:"\
  " #{@claimed_postage.inspect}, assessed_postage: #{@assessed_postage.inspect},"\
  " payment_method: #{@payment_method.inspect}, eps_tran_type: #{@eps_tran_type.inspect},"\
  " transaction_description: #{@transaction_description.inspect}, ship_tran_amt:"\
  " #{@ship_tran_amt.inspect}, piece_count: #{@piece_count.inspect}, eps_account_nickname:"\
  " #{@eps_account_nickname.inspect}, eps_acc_num: #{@eps_acc_num.inspect}, ship_tran_dt:"\
  " #{@ship_tran_dt.inspect}, display_tran_id: #{@display_tran_id.inspect}, ach_withdrawal_id:"\
  " #{@ach_withdrawal_id.inspect}, weight: #{@weight.inspect}, dim_length:"\
  " #{@dim_length.inspect}, dim_width: #{@dim_width.inspect}, dim_height:"\
  " #{@dim_height.inspect}, total_variance: #{@total_variance.inspect}, manifest_zone:"\
  " #{@manifest_zone.inspect}, census_reason: #{@census_reason.inspect}, assessment_type:"\
  " #{@assessment_type.inspect}, admin_fee_type: #{@admin_fee_type.inspect}, dispute_id:"\
  " #{@dispute_id.inspect}, dts_first: #{@dts_first.inspect}, assd_mc_code:"\
  " #{@assd_mc_code.inspect}, assessed_length: #{@assessed_length.inspect}, assessed_weight:"\
  " #{@assessed_weight.inspect}, assessed_height: #{@assessed_height.inspect}, assessed_width:"\
  " #{@assessed_width.inspect}, assessed_zone: #{@assessed_zone.inspect}, packaging:"\
  " #{@packaging.inspect}, upc_code: #{@upc_code.inspect}, scan_nonstndrd_length_fee1:"\
  " #{@scan_nonstndrd_length_fee1.inspect}, scan_nonstndrd_length_fee2:"\
  " #{@scan_nonstndrd_length_fee2.inspect}, scan_nonstndrd_volume_fee:"\
  " #{@scan_nonstndrd_volume_fee.inspect}, scan_nonstndrd_char_fee:"\
  " #{@scan_nonstndrd_char_fee.inspect}, noncompliance_fee: #{@noncompliance_fee.inspect},"\
  " assessment_year: #{@assessment_year.inspect}, assessed_mail_class:"\
  " #{@assessed_mail_class.inspect}, merchant_rate_charged: #{@merchant_rate_charged.inspect},"\
  " gross_commission: #{@gross_commission.inspect}, platform_rate: #{@platform_rate.inspect},"\
  " cc_withdrawal_id: #{@cc_withdrawal_id.inspect}, mid_owner_name:"\
  " #{@mid_owner_name.inspect}, mid_user_name: #{@mid_user_name.inspect}, invoice_id:"\
  " #{@invoice_id.inspect}, assessment_details: #{@assessment_details.inspect},"\
  " assessment_month: #{@assessment_month.inspect}, ach_withdrawal_date:"\
  " #{@ach_withdrawal_date.inspect}, cc_withdrawal_date: #{@cc_withdrawal_date.inspect},"\
  " invoice_date: #{@invoice_date.inspect}, crid: #{@crid.inspect}, platform_user_id:"\
  " #{@platform_user_id.inspect}, external_ref_id: #{@external_ref_id.inspect}, pkg_grp_id:"\
  " #{@pkg_grp_id.inspect}>"
end

#to_custom_ach_withdrawal_date ⇒ Object 



1267
1268
1269
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 1267

def to_custom_ach_withdrawal_date
  DateTimeHelper.to_rfc3339(ach_withdrawal_date)
end

#to_custom_cc_withdrawal_date ⇒ Object 



1271
1272
1273
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 1271

def to_custom_cc_withdrawal_date
  DateTimeHelper.to_rfc3339(cc_withdrawal_date)
end

#to_custom_dts_first ⇒ Object 



1263
1264
1265
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 1263

def to_custom_dts_first
  DateTimeHelper.to_rfc3339(dts_first)
end

#to_custom_invoice_date ⇒ Object 



1275
1276
1277
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 1275

def to_custom_invoice_date
  DateTimeHelper.to_rfc3339(invoice_date)
end

#to_custom_mailing_date ⇒ Object 



1255
1256
1257
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 1255

def to_custom_mailing_date
  DateTimeHelper.to_rfc3339(mailing_date)
end

#to_custom_ship_tran_dt ⇒ Object 



1259
1260
1261
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 1259

def to_custom_ship_tran_dt
  DateTimeHelper.to_rfc3339(ship_tran_dt)
end

#to_custom_transmission_date ⇒ Object 



1251
1252
1253
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 1251

def to_custom_transmission_date
  DateTimeHelper.to_rfc3339(transmission_date)
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
 
# File 'lib/usps_api/models/package_transaction_details.rb', line 1280

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} transmission_date: #{@transmission_date}, mailing_date: #{@mailing_date},"\
  " master_mid: #{@master_mid}, manifest_transaction_id: #{@manifest_transaction_id}, efn:"\
  " #{@efn}, i_mpb: #{@i_mpb}, pic: #{@pic}, mailer_id: #{@mailer_id}, service_type_code:"\
  " #{@service_type_code}, processing_category: #{@processing_category},"\
  " processing_category_name: #{@processing_category_name}, capt_wt: #{@capt_wt},"\
  " usps_dimensional_weight: #{@usps_dimensional_weight}, capt_dim_len: #{@capt_dim_len},"\
  " capt_dim_wd: #{@capt_dim_wd}, capt_dim_ht: #{@capt_dim_ht}, entry_facility_zipcode:"\
  " #{@entry_facility_zipcode}, destination_zip_code: #{@destination_zip_code},"\
  " destntn_rate_ind: #{@destntn_rate_ind}, rate_indicator: #{@rate_indicator}, sku: #{@sku},"\
  " base_postage: #{@base_postage}, published_price: #{@published_price},"\
  " manifest_nonstndrd_length_fee1: #{@manifest_nonstndrd_length_fee1},"\
  " manifest_nonstndrd_length_fee2: #{@manifest_nonstndrd_length_fee2},"\
  " manifest_nonstndrd_volume_fee: #{@manifest_nonstndrd_volume_fee}, man_nonstndrd_char_fee:"\
  " #{@man_nonstndrd_char_fee}, extra_service_code1: #{@extra_service_code1},"\
  " extra_service_code2: #{@extra_service_code2}, extra_service_code3:"\
  " #{@extra_service_code3}, extra_service_code4: #{@extra_service_code4},"\
  " extra_service_code5: #{@extra_service_code5}, extra_service1_amount:"\
  " #{@extra_service1_amount}, extra_service2_amount: #{@extra_service2_amount},"\
  " extra_service3_amount: #{@extra_service3_amount}, extra_service4_amount:"\
  " #{@extra_service4_amount}, extra_service5_amount: #{@extra_service5_amount},"\
  " extra_service1_sku: #{@extra_service1_sku}, extra_service2_sku: #{@extra_service2_sku},"\
  " extra_service3_sku: #{@extra_service3_sku}, extra_service4_sku: #{@extra_service4_sku},"\
  " extra_service5_sku: #{@extra_service5_sku}, srch_sku: #{@srch_sku}, warnings:"\
  " #{@warnings}, manifest_package_id: #{@manifest_package_id}, manifest_dimensional_weight:"\
  " #{@manifest_dimensional_weight}, manifest_dri: #{@manifest_dri}, manifest_rate_indicator:"\
  " #{@manifest_rate_indicator}, is_tpb: #{@is_tpb}, tpb_shipper_crid: #{@tpb_shipper_crid},"\
  " tpb_shipper_name: #{@tpb_shipper_name}, destination_country_code:"\
  " #{@destination_country_code}, foreign_postal_code: #{@foreign_postal_code}, price_group:"\
  " #{@price_group}, cust_ref_num1: #{@cust_ref_num1}, cust_ref_num2: #{@cust_ref_num2},"\
  " permit_finance_no: #{@permit_finance_no}, permit_type: #{@permit_type}, permit_no:"\
  " #{@permit_no}, price_type: #{@price_type}, claimed_postage: #{@claimed_postage},"\
  " assessed_postage: #{@assessed_postage}, payment_method: #{@payment_method}, eps_tran_type:"\
  " #{@eps_tran_type}, transaction_description: #{@transaction_description}, ship_tran_amt:"\
  " #{@ship_tran_amt}, piece_count: #{@piece_count}, eps_account_nickname:"\
  " #{@eps_account_nickname}, eps_acc_num: #{@eps_acc_num}, ship_tran_dt: #{@ship_tran_dt},"\
  " display_tran_id: #{@display_tran_id}, ach_withdrawal_id: #{@ach_withdrawal_id}, weight:"\
  " #{@weight}, dim_length: #{@dim_length}, dim_width: #{@dim_width}, dim_height:"\
  " #{@dim_height}, total_variance: #{@total_variance}, manifest_zone: #{@manifest_zone},"\
  " census_reason: #{@census_reason}, assessment_type: #{@assessment_type}, admin_fee_type:"\
  " #{@admin_fee_type}, dispute_id: #{@dispute_id}, dts_first: #{@dts_first}, assd_mc_code:"\
  " #{@assd_mc_code}, assessed_length: #{@assessed_length}, assessed_weight:"\
  " #{@assessed_weight}, assessed_height: #{@assessed_height}, assessed_width:"\
  " #{@assessed_width}, assessed_zone: #{@assessed_zone}, packaging: #{@packaging}, upc_code:"\
  " #{@upc_code}, scan_nonstndrd_length_fee1: #{@scan_nonstndrd_length_fee1},"\
  " scan_nonstndrd_length_fee2: #{@scan_nonstndrd_length_fee2}, scan_nonstndrd_volume_fee:"\
  " #{@scan_nonstndrd_volume_fee}, scan_nonstndrd_char_fee: #{@scan_nonstndrd_char_fee},"\
  " noncompliance_fee: #{@noncompliance_fee}, assessment_year: #{@assessment_year},"\
  " assessed_mail_class: #{@assessed_mail_class}, merchant_rate_charged:"\
  " #{@merchant_rate_charged}, gross_commission: #{@gross_commission}, platform_rate:"\
  " #{@platform_rate}, cc_withdrawal_id: #{@cc_withdrawal_id}, mid_owner_name:"\
  " #{@mid_owner_name}, mid_user_name: #{@mid_user_name}, invoice_id: #{@invoice_id},"\
  " assessment_details: #{@assessment_details}, assessment_month: #{@assessment_month},"\
  " ach_withdrawal_date: #{@ach_withdrawal_date}, cc_withdrawal_date: #{@cc_withdrawal_date},"\
  " invoice_date: #{@invoice_date}, crid: #{@crid}, platform_user_id: #{@platform_user_id},"\
  " external_ref_id: #{@external_ref_id}, pkg_grp_id: #{@pkg_grp_id}>"
end