Class: Peddler::APIs::ShippingV2::Rate

Inherits:
Data
  • Object
show all
Defined in:
sig/peddler/apis/shipping_v2.rbs

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#available_value_added_service_groups ⇒ Array[Peddler::APIs::ShippingV2::AvailableValueAddedServiceGroup]? (readonly)

Returns the value of attribute available_value_added_service_groups.

Returns:



1577
1578
1579
 
# File 'sig/peddler/apis/shipping_v2.rbs', line 1577

def available_value_added_service_groups
  @available_value_added_service_groups
end

#benefits ⇒ Peddler::APIs::ShippingV2::Benefits? (readonly)

Returns the value of attribute benefits.

Returns:



1578
1579
1580
 
# File 'sig/peddler/apis/shipping_v2.rbs', line 1578

def benefits
  @benefits
end

#billed_weight ⇒ Peddler::APIs::ShippingV2::Weight? (readonly)

Returns the value of attribute billed_weight.

Returns:



1579
1580
1581
 
# File 'sig/peddler/apis/shipping_v2.rbs', line 1579

def billed_weight
  @billed_weight
end

#carrier_id ⇒ String (readonly)

Returns the value of attribute carrier_id.

Returns:

  • (String) 


1580
1581
1582
 
# File 'sig/peddler/apis/shipping_v2.rbs', line 1580

def carrier_id
  @carrier_id
end

#carrier_name ⇒ String (readonly)

Returns the value of attribute carrier_name.

Returns:

  • (String) 


1581
1582
1583
 
# File 'sig/peddler/apis/shipping_v2.rbs', line 1581

def carrier_name
  @carrier_name
end

#payment_type ⇒ String? (readonly)

Returns the value of attribute payment_type.

Returns:

  • (String, nil) 


1582
1583
1584
 
# File 'sig/peddler/apis/shipping_v2.rbs', line 1582

def payment_type
  @payment_type
end

#promise ⇒ Peddler::APIs::ShippingV2::Promise (readonly)

Returns the value of attribute promise.

Returns:



1583
1584
1585
 
# File 'sig/peddler/apis/shipping_v2.rbs', line 1583

def promise
  @promise
end

#rate_id ⇒ String (readonly)

Returns the value of attribute rate_id.

Returns:

  • (String) 


1584
1585
1586
 
# File 'sig/peddler/apis/shipping_v2.rbs', line 1584

def rate_id
  @rate_id
end

#rate_item_list ⇒ Array[Peddler::APIs::ShippingV2::RateItem]? (readonly)

Returns the value of attribute rate_item_list.

Returns:



1585
1586
1587
 
# File 'sig/peddler/apis/shipping_v2.rbs', line 1585

def rate_item_list
  @rate_item_list
end

#requires_additional_inputs ⇒ Boolean (readonly)

Returns the value of attribute requires_additional_inputs.

Returns:

  • (Boolean) 


1586
1587
1588
 
# File 'sig/peddler/apis/shipping_v2.rbs', line 1586

def requires_additional_inputs
  @requires_additional_inputs
end

#service_id ⇒ String (readonly)

Returns the value of attribute service_id.

Returns:

  • (String) 


1587
1588
1589
 
# File 'sig/peddler/apis/shipping_v2.rbs', line 1587

def service_id
  @service_id
end

#service_name ⇒ String (readonly)

Returns the value of attribute service_name.

Returns:

  • (String) 


1588
1589
1590
 
# File 'sig/peddler/apis/shipping_v2.rbs', line 1588

def service_name
  @service_name
end

#supported_document_specifications ⇒ Array[Peddler::APIs::ShippingV2::SupportedDocumentSpecification] (readonly)

Returns the value of attribute supported_document_specifications.

Returns:



1589
1590
1591
 
# File 'sig/peddler/apis/shipping_v2.rbs', line 1589

def supported_document_specifications
  @supported_document_specifications
end

#total_charge ⇒ Peddler::Money (readonly)

Returns the value of attribute total_charge.

Returns:



1590
1591
1592
 
# File 'sig/peddler/apis/shipping_v2.rbs', line 1590

def total_charge
  @total_charge
end

Class Method Details

.[](carrier_id:, carrier_name:, promise:, rate_id:, requires_additional_inputs:, service_id:, service_name:, supported_document_specifications:, total_charge:, available_value_added_service_groups:, benefits:, billed_weight:, payment_type:, rate_item_list:) ⇒ Peddler::APIs::ShippingV2::Rate .[](arg0, arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, arg9, arg10, arg11, arg12, arg13) ⇒ Peddler::APIs::ShippingV2::Rate

Overloads:



1570
1571
 
# File 'sig/peddler/apis/shipping_v2.rbs', line 1570

def self.[]: (carrier_id: String, carrier_name: String, promise: Peddler::APIs::ShippingV2::Promise, rate_id: String, requires_additional_inputs: bool, service_id: String, service_name: String, supported_document_specifications: Array[Peddler::APIs::ShippingV2::SupportedDocumentSpecification], total_charge: Peddler::Money, ?available_value_added_service_groups: Array[Peddler::APIs::ShippingV2::AvailableValueAddedServiceGroup]?, ?benefits: Peddler::APIs::ShippingV2::Benefits?, ?billed_weight: Peddler::APIs::ShippingV2::Weight?, ?payment_type: String?, ?rate_item_list: Array[Peddler::APIs::ShippingV2::RateItem]?) -> Peddler::APIs::ShippingV2::Rate
| (String, String, Peddler::APIs::ShippingV2::Promise, String, bool, String, String, Array[Peddler::APIs::ShippingV2::SupportedDocumentSpecification], Peddler::Money, Array[Peddler::APIs::ShippingV2::AvailableValueAddedServiceGroup]?, Peddler::APIs::ShippingV2::Benefits?, Peddler::APIs::ShippingV2::Weight?, String?, Array[Peddler::APIs::ShippingV2::RateItem]?) -> Peddler::APIs::ShippingV2::Rate

.members ⇒ [ :carrier_id, :carrier_name, :promise, :rate_id, :requires_additional_inputs, :service_id, :service_name, :supported_document_specifications, :total_charge, :available_value_added_service_groups, :benefits, :billed_weight, :payment_type, :rate_item_list ]

Returns:

  • ([ :carrier_id, :carrier_name, :promise, :rate_id, :requires_additional_inputs, :service_id, :service_name, :supported_document_specifications, :total_charge, :available_value_added_service_groups, :benefits, :billed_weight, :payment_type, :rate_item_list ]) 


1573
 
# File 'sig/peddler/apis/shipping_v2.rbs', line 1573

def self.members: () -> [ :carrier_id, :carrier_name, :promise, :rate_id, :requires_additional_inputs, :service_id, :service_name, :supported_document_specifications, :total_charge, :available_value_added_service_groups, :benefits, :billed_weight, :payment_type, :rate_item_list ]

.new(carrier_id:, carrier_name:, promise:, rate_id:, requires_additional_inputs:, service_id:, service_name:, supported_document_specifications:, total_charge:, available_value_added_service_groups:, benefits:, billed_weight:, payment_type:, rate_item_list:) ⇒ Peddler::APIs::ShippingV2::Rate .new(arg0, arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, arg9, arg10, arg11, arg12, arg13) ⇒ Peddler::APIs::ShippingV2::Rate

Overloads:



1568
1569
 
# File 'sig/peddler/apis/shipping_v2.rbs', line 1568

def self.new: (carrier_id: String, carrier_name: String, promise: Peddler::APIs::ShippingV2::Promise, rate_id: String, requires_additional_inputs: bool, service_id: String, service_name: String, supported_document_specifications: Array[Peddler::APIs::ShippingV2::SupportedDocumentSpecification], total_charge: Peddler::Money, ?available_value_added_service_groups: Array[Peddler::APIs::ShippingV2::AvailableValueAddedServiceGroup]?, ?benefits: Peddler::APIs::ShippingV2::Benefits?, ?billed_weight: Peddler::APIs::ShippingV2::Weight?, ?payment_type: String?, ?rate_item_list: Array[Peddler::APIs::ShippingV2::RateItem]?) -> Peddler::APIs::ShippingV2::Rate
| (String, String, Peddler::APIs::ShippingV2::Promise, String, bool, String, String, Array[Peddler::APIs::ShippingV2::SupportedDocumentSpecification], Peddler::Money, Array[Peddler::APIs::ShippingV2::AvailableValueAddedServiceGroup]?, Peddler::APIs::ShippingV2::Benefits?, Peddler::APIs::ShippingV2::Weight?, String?, Array[Peddler::APIs::ShippingV2::RateItem]?) -> Peddler::APIs::ShippingV2::Rate

.parse ⇒ Peddler::APIs::ShippingV2::Rate

Parameters:

  • (Hash[String | Symbol, untyped])
  • (Object)

Returns:



1575
 
# File 'sig/peddler/apis/shipping_v2.rbs', line 1575

def self.parse: (?Hash[String | Symbol, untyped], **untyped) -> Peddler::APIs::ShippingV2::Rate

Instance Method Details

#members ⇒ [ :carrier_id, :carrier_name, :promise, :rate_id, :requires_additional_inputs, :service_id, :service_name, :supported_document_specifications, :total_charge, :available_value_added_service_groups, :benefits, :billed_weight, :payment_type, :rate_item_list ]

Returns:

  • ([ :carrier_id, :carrier_name, :promise, :rate_id, :requires_additional_inputs, :service_id, :service_name, :supported_document_specifications, :total_charge, :available_value_added_service_groups, :benefits, :billed_weight, :payment_type, :rate_item_list ]) 


1592
 
# File 'sig/peddler/apis/shipping_v2.rbs', line 1592

def members: () -> [ :carrier_id, :carrier_name, :promise, :rate_id, :requires_additional_inputs, :service_id, :service_name, :supported_document_specifications, :total_charge, :available_value_added_service_groups, :benefits, :billed_weight, :payment_type, :rate_item_list ]

#requires_additional_inputs? ⇒ Boolean

Returns:

  • (Boolean) 


1593
 
# File 'sig/peddler/apis/shipping_v2.rbs', line 1593

def requires_additional_inputs?: () -> bool

#to_h ⇒ { carrier_id: String, carrier_name: String, promise: Peddler::APIs::ShippingV2::Promise, rate_id: String, requires_additional_inputs: bool, service_id: String, service_name: String, supported_document_specifications: Array[Peddler::APIs::ShippingV2::SupportedDocumentSpecification], total_charge: Peddler::Money, available_value_added_service_groups: Array[Peddler::APIs::ShippingV2::AvailableValueAddedServiceGroup]?, benefits: Peddler::APIs::ShippingV2::Benefits?, billed_weight: Peddler::APIs::ShippingV2::Weight?, payment_type: String?, rate_item_list: Array[Peddler::APIs::ShippingV2::RateItem]? }

Returns:



1594
 
# File 'sig/peddler/apis/shipping_v2.rbs', line 1594

def to_h: () -> { carrier_id: String, carrier_name: String, promise: Peddler::APIs::ShippingV2::Promise, rate_id: String, requires_additional_inputs: bool, service_id: String, service_name: String, supported_document_specifications: Array[Peddler::APIs::ShippingV2::SupportedDocumentSpecification], total_charge: Peddler::Money, available_value_added_service_groups: Array[Peddler::APIs::ShippingV2::AvailableValueAddedServiceGroup]?, benefits: Peddler::APIs::ShippingV2::Benefits?, billed_weight: Peddler::APIs::ShippingV2::Weight?, payment_type: String?, rate_item_list: Array[Peddler::APIs::ShippingV2::RateItem]? }