Class: DeliveryFivePostClient::Models::API::V1::PartnerGetCargoStatusResponse::Cargo

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/delivery_five_post_client/models/api/v1/partner_get_cargo_status_response.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(cargo_id:, change_date:, sender_cargo_id:, status:, error_desc: nil, mile_type: nil) ⇒ Object

Статус грузоместа / Cargo status

Parameters:

  • cargo_id (String) —

    UUID в формате v4 / UUID in v4 format

  • change_date (Time) —

    Дата изменения статуса / Status change date

  • sender_cargo_id (String) —

    ID грузоместа партнера / Partner cargo ID

  • status (String) —

    Статус грузоместа / Cargo status

  • error_desc (String) (defaults to: nil) —

    Описание ошибки / Error description

  • mile_type (Symbol, DeliveryFivePostClient::Models::MileType) (defaults to: nil) —

    Тип мили доставки / Delivery mile type



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/delivery_five_post_client/models/api/v1/partner_get_cargo_status_response.rb', line 21

class Cargo < DeliveryFivePostClient::Internal::Type::BaseModel
  # @!attribute cargo_id
  #   UUID в формате v4 / UUID in v4 format
  #
  #   @return [String]
  required :cargo_id, String, api_name: :cargoId

  # @!attribute change_date
  #   Дата изменения статуса / Status change date
  #
  #   @return [Time]
  required :change_date, Time, api_name: :changeDate

  # @!attribute sender_cargo_id
  #   ID грузоместа партнера / Partner cargo ID
  #
  #   @return [String]
  required :sender_cargo_id, String, api_name: :senderCargoId

  # @!attribute status
  #   Статус грузоместа / Cargo status
  #
  #   @return [String]
  required :status, String

  # @!attribute error_desc
  #   Описание ошибки / Error description
  #
  #   @return [String, nil]
  optional :error_desc, String, api_name: :errorDesc

  # @!attribute mile_type
  #   Тип мили доставки / Delivery mile type
  #
  #   @return [Symbol, DeliveryFivePostClient::Models::MileType, nil]
  optional :mile_type, enum: -> { DeliveryFivePostClient::MileType }, api_name: :mileType

  # @!method initialize(cargo_id:, change_date:, sender_cargo_id:, status:, error_desc: nil, mile_type: nil)
  #   Статус грузоместа / Cargo status
  #
  #   @param cargo_id [String] UUID в формате v4 / UUID in v4 format
  #
  #   @param change_date [Time] Дата изменения статуса / Status change date
  #
  #   @param sender_cargo_id [String] ID грузоместа партнера / Partner cargo ID
  #
  #   @param status [String] Статус грузоместа / Cargo status
  #
  #   @param error_desc [String] Описание ошибки / Error description
  #
  #   @param mile_type [Symbol, DeliveryFivePostClient::Models::MileType] Тип мили доставки / Delivery mile type
end

Instance Attribute Details

#cargo_id ⇒ String

UUID в формате v4 / UUID in v4 format

Returns:

  • (String) 


26
 
# File 'lib/delivery_five_post_client/models/api/v1/partner_get_cargo_status_response.rb', line 26

required :cargo_id, String, api_name: :cargoId

#change_date ⇒ Time

Дата изменения статуса / Status change date

Returns:

  • (Time) 


32
 
# File 'lib/delivery_five_post_client/models/api/v1/partner_get_cargo_status_response.rb', line 32

required :change_date, Time, api_name: :changeDate

#error_desc ⇒ String?

Описание ошибки / Error description

Returns:

  • (String, nil) 


50
 
# File 'lib/delivery_five_post_client/models/api/v1/partner_get_cargo_status_response.rb', line 50

optional :error_desc, String, api_name: :errorDesc

#mile_type ⇒ Symbol, ...

Тип мили доставки / Delivery mile type

Returns:



56
 
# File 'lib/delivery_five_post_client/models/api/v1/partner_get_cargo_status_response.rb', line 56

optional :mile_type, enum: -> { DeliveryFivePostClient::MileType }, api_name: :mileType

#sender_cargo_id ⇒ String

ID грузоместа партнера / Partner cargo ID

Returns:

  • (String) 


38
 
# File 'lib/delivery_five_post_client/models/api/v1/partner_get_cargo_status_response.rb', line 38

required :sender_cargo_id, String, api_name: :senderCargoId

#status ⇒ String

Статус грузоместа / Cargo status

Returns:

  • (String) 


44
 
# File 'lib/delivery_five_post_client/models/api/v1/partner_get_cargo_status_response.rb', line 44

required :status, String