Class: DeliveryFivePostClient::Models::API::V1::PartnerGetOrderHistoryMassResponse::Order

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

Defined Under Namespace

Classes: History

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(orders:) ⇒ Object

Ответ с историей статусов заказов / Order history response

Parameters:



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
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
# File 'lib/delivery_five_post_client/models/api/v1/partner_get_order_history_mass_response.rb', line 21

class Order < DeliveryFivePostClient::Internal::Type::BaseModel
  # @!attribute history
  #   История изменений статусов / Status change history
  #
  #   @return [Array<DeliveryFivePostClient::Models::API::V1::PartnerGetOrderHistoryMassResponse::Order::History>]
  required :history,
           -> { DeliveryFivePostClient::Internal::Type::ArrayOf[DeliveryFivePostClient::Models::API::V1::PartnerGetOrderHistoryMassResponse::Order::History] }

  # @!attribute order_id
  #   UUID в формате v4 / UUID in v4 format
  #
  #   @return [String]
  required :order_id, String, api_name: :orderId

  # @!attribute sender_order_id
  #   ID заказа партнера / Partner order ID
  #
  #   @return [String]
  required :sender_order_id, String, api_name: :senderOrderId

  # @!method initialize(history:, order_id:, sender_order_id:)
  #   История статусов одного заказа / Single order status history
  #
  #   @param history [Array<DeliveryFivePostClient::Models::API::V1::PartnerGetOrderHistoryMassResponse::Order::History>] История изменений статусов / Status change history
  #
  #   @param order_id [String] UUID в формате v4 / UUID in v4 format
  #
  #   @param sender_order_id [String] ID заказа партнера / Partner order ID

  class History < DeliveryFivePostClient::Internal::Type::BaseModel
    # @!attribute change_date
    #   Дата изменения / Change date
    #
    #   @return [Time]
    required :change_date, Time, api_name: :changeDate

    # @!attribute execution_status
    #   Статусы исполнения заказа / Order execution statuses
    #
    #   @return [Symbol, DeliveryFivePostClient::Models::API::V1::ExecutionStatus]
    required :execution_status,
             enum: -> { DeliveryFivePostClient::API::V1::ExecutionStatus },
             api_name: :executionStatus

    # @!attribute status
    #   Статус заказа / Order 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(change_date:, execution_status:, status:, error_desc: nil, mile_type: nil)
    #   Запись в истории статусов / Status history entry
    #
    #   @param change_date [Time] Дата изменения / Change date
    #
    #   @param execution_status [Symbol, DeliveryFivePostClient::Models::API::V1::ExecutionStatus] Статусы исполнения заказа / Order execution statuses
    #
    #   @param status [String] Статус заказа / Order status
    #
    #   @param error_desc [String] Описание ошибки / Error description
    #
    #   @param mile_type [Symbol, DeliveryFivePostClient::Models::MileType] Тип мили доставки / Delivery mile type
  end
end

Instance Attribute Details

#history ⇒ Array<DeliveryFivePostClient::Models::API::V1::PartnerGetOrderHistoryMassResponse::Order::History>

История изменений статусов / Status change history



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

required :history,
-> { DeliveryFivePostClient::Internal::Type::ArrayOf[DeliveryFivePostClient::Models::API::V1::PartnerGetOrderHistoryMassResponse::Order::History] }

#order_id ⇒ String

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

Returns:

  • (String)


33
# File 'lib/delivery_five_post_client/models/api/v1/partner_get_order_history_mass_response.rb', line 33

required :order_id, String, api_name: :orderId

#sender_order_id ⇒ String

ID заказа партнера / Partner order ID

Returns:

  • (String)


39
# File 'lib/delivery_five_post_client/models/api/v1/partner_get_order_history_mass_response.rb', line 39

required :sender_order_id, String, api_name: :senderOrderId