delivery-five-post-client 0.1.0

data/lib/delivery_five_post_client/models/api/v2/pickup_point.rb

@@ -0,0 +1,268 @@
+# frozen_string_literal: true
+
+module DeliveryFivePostClient
+  module Models
+    module API
+      module V2
+        class PickupPoint < DeliveryFivePostClient::Internal::Type::BaseModel
+          # @!attribute id
+          #   UUID в формате v4 / UUID in v4 format
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute active
+          #   Активность точки / Point is active
+          #
+          #   @return [Boolean]
+          required :active, DeliveryFivePostClient::Internal::Type::Boolean
+
+          # @!attribute additional
+          #   Дополнительные сервисы / Additional services
+          #
+          #   @return [Array<String>]
+          required :additional, DeliveryFivePostClient::Internal::Type::ArrayOf[String]
+
+          # @!attribute address
+          #   Полный адрес / Full address
+          #
+          #   @return [String]
+          required :address, String
+
+          # @!attribute city
+          #   Город / City
+          #
+          #   @return [String]
+          required :city, String
+
+          # @!attribute delivery_sl
+          #   Логистические схемы доставки / Delivery logistic schemes
+          #
+          #   @return [Array<String>]
+          required :delivery_sl,
+                   DeliveryFivePostClient::Internal::Type::ArrayOf[String],
+                   api_name: :deliverySl
+
+          # @!attribute latitude
+          #   Широта / Latitude
+          #
+          #   @return [Float]
+          required :latitude, Float
+
+          # @!attribute longitude
+          #   Долгота / Longitude
+          #
+          #   @return [Float]
+          required :longitude, Float
+
+          # @!attribute max_height
+          #   Максимальная высота (см) / Maximum height (cm)
+          #
+          #   @return [Float]
+          required :max_height, Float, api_name: :maxHeight
+
+          # @!attribute max_length
+          #   Максимальная длина (см) / Maximum length (cm)
+          #
+          #   @return [Float]
+          required :max_length, Float, api_name: :maxLength
+
+          # @!attribute max_weight
+          #   Максимальный вес (кг) / Maximum weight (kg)
+          #
+          #   @return [Float]
+          required :max_weight, Float, api_name: :maxWeight
+
+          # @!attribute max_width
+          #   Максимальная ширина (см) / Maximum width (cm)
+          #
+          #   @return [Float]
+          required :max_width, Float, api_name: :maxWidth
+
+          # @!attribute mdm_code
+          #   MDM код точки / MDM code
+          #
+          #   @return [String]
+          required :mdm_code, String, api_name: :mdmCode
+
+          # @!attribute multiplace_delivery
+          #   Поддержка многоместных отправлений / Multi-place delivery support
+          #
+          #   @return [Boolean]
+          required :multiplace_delivery,
+                   DeliveryFivePostClient::Internal::Type::Boolean,
+                   api_name: :multiplaceDelivery
+
+          # @!attribute name
+          #   Название точки выдачи / Pickup point name
+          #
+          #   @return [String]
+          required :name, String
+
+          # @!attribute phone
+          #   Номер телефона в международном формате (+79001234567) / Phone number in
+          #   international format (+79001234567)
+          #
+          #   @return [String]
+          required :phone, String
+
+          # @!attribute ready
+          #   Готовность к приему / Point is ready
+          #
+          #   @return [Boolean]
+          required :ready, DeliveryFivePostClient::Internal::Type::Boolean
+
+          # @!attribute region
+          #   Регион / Region
+          #
+          #   @return [String]
+          required :region, String
+
+          # @!attribute work_time
+          #   Время работы / Working hours
+          #
+          #   @return [String]
+          required :work_time, String, api_name: :workTime
+
+          # @!attribute last_mile_warehouse
+          #   Информация о складе снабжения / Last mile warehouse information
+          #
+          #   @return [DeliveryFivePostClient::Models::API::V2::PickupPoint::LastMileWarehouse, nil]
+          optional :last_mile_warehouse,
+                   -> { DeliveryFivePostClient::API::V2::PickupPoint::LastMileWarehouse },
+                   api_name: :lastMileWarehouse
+
+          # @!attribute min_delivery_days
+          #   Минимальный срок доставки (дни) / Minimum delivery days
+          #
+          #   @return [Integer, nil]
+          optional :min_delivery_days, Integer, api_name: :minDeliveryDays
+
+          # @!attribute rate
+          #   Тарифная информация / Rate information
+          #
+          #   @return [DeliveryFivePostClient::Models::API::V2::PickupPoint::Rate, nil]
+          optional :rate, -> { DeliveryFivePostClient::API::V2::PickupPoint::Rate }
+
+          # @!method initialize(id:, active:, additional:, address:, city:, delivery_sl:, latitude:, longitude:, max_height:, max_length:, max_weight:, max_width:, mdm_code:, multiplace_delivery:, name:, phone:, ready:, region:, work_time:, last_mile_warehouse: nil, min_delivery_days: nil, rate: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {DeliveryFivePostClient::Models::API::V2::PickupPoint} for more details.
+          #
+          #   Точка выдачи / Pickup point
+          #
+          #   @param id [String] UUID в формате v4 / UUID in v4 format
+          #
+          #   @param active [Boolean] Активность точки / Point is active
+          #
+          #   @param additional [Array<String>] Дополнительные сервисы / Additional services
+          #
+          #   @param address [String] Полный адрес / Full address
+          #
+          #   @param city [String] Город / City
+          #
+          #   @param delivery_sl [Array<String>] Логистические схемы доставки / Delivery logistic schemes
+          #
+          #   @param latitude [Float] Широта / Latitude
+          #
+          #   @param longitude [Float] Долгота / Longitude
+          #
+          #   @param max_height [Float] Максимальная высота (см) / Maximum height (cm)
+          #
+          #   @param max_length [Float] Максимальная длина (см) / Maximum length (cm)
+          #
+          #   @param max_weight [Float] Максимальный вес (кг) / Maximum weight (kg)
+          #
+          #   @param max_width [Float] Максимальная ширина (см) / Maximum width (cm)
+          #
+          #   @param mdm_code [String] MDM код точки / MDM code
+          #
+          #   @param multiplace_delivery [Boolean] Поддержка многоместных отправлений / Multi-place delivery support
+          #
+          #   @param name [String] Название точки выдачи / Pickup point name
+          #
+          #   @param phone [String] Номер телефона в международном формате (+79001234567) / Phone number in internat
+          #
+          #   @param ready [Boolean] Готовность к приему / Point is ready
+          #
+          #   @param region [String] Регион / Region
+          #
+          #   @param work_time [String] Время работы / Working hours
+          #
+          #   @param last_mile_warehouse [DeliveryFivePostClient::Models::API::V2::PickupPoint::LastMileWarehouse] Информация о складе снабжения / Last mile warehouse information
+          #
+          #   @param min_delivery_days [Integer] Минимальный срок доставки (дни) / Minimum delivery days
+          #
+          #   @param rate [DeliveryFivePostClient::Models::API::V2::PickupPoint::Rate] Тарифная информация / Rate information
+
+          # @see DeliveryFivePostClient::Models::API::V2::PickupPoint#last_mile_warehouse
+          class LastMileWarehouse < DeliveryFivePostClient::Internal::Type::BaseModel
+            # @!attribute id
+            #   UUID в формате v4 / UUID in v4 format
+            #
+            #   @return [String]
+            required :id, String
+
+            # @!attribute name
+            #   Название склада / Warehouse name
+            #
+            #   @return [String]
+            required :name, String
+
+            # @!method initialize(id:, name:)
+            #   Информация о складе снабжения / Last mile warehouse information
+            #
+            #   @param id [String] UUID в формате v4 / UUID in v4 format
+            #
+            #   @param name [String] Название склада / Warehouse name
+          end
+
+          # @see DeliveryFivePostClient::Models::API::V2::PickupPoint#rate
+          class Rate < DeliveryFivePostClient::Internal::Type::BaseModel
+            # @!attribute rate_value
+            #   Стоимость без НДС / Price without VAT
+            #
+            #   @return [Float]
+            required :rate_value, Float, api_name: :rateValue
+
+            # @!attribute rate_value_with_vat
+            #   Стоимость с НДС / Price with VAT
+            #
+            #   @return [Float]
+            required :rate_value_with_vat, Float, api_name: :rateValueWithVat
+
+            # @!attribute vat
+            #   Ставка НДС (%) / VAT rate (%)
+            #
+            #   @return [Float, DeliveryFivePostClient::Models::API::V1::Partners::Orders::VatRate]
+            required :vat, enum: -> { DeliveryFivePostClient::API::V1::Partners::Orders::VatRate }
+
+            # @!attribute rate_extra_value
+            #   Дополнительная стоимость без НДС / Additional price without VAT
+            #
+            #   @return [Float, nil]
+            optional :rate_extra_value, Float, api_name: :rateExtraValue
+
+            # @!attribute rate_extra_value_with_vat
+            #   Дополнительная стоимость с НДС / Additional price with VAT
+            #
+            #   @return [Float, nil]
+            optional :rate_extra_value_with_vat, Float, api_name: :rateExtraValueWithVat
+
+            # @!method initialize(rate_value:, rate_value_with_vat:, vat:, rate_extra_value: nil, rate_extra_value_with_vat: nil)
+            #   Тарифная информация / Rate information
+            #
+            #   @param rate_value [Float] Стоимость без НДС / Price without VAT
+            #
+            #   @param rate_value_with_vat [Float] Стоимость с НДС / Price with VAT
+            #
+            #   @param vat [Float, DeliveryFivePostClient::Models::API::V1::Partners::Orders::VatRate] Ставка НДС (%) / VAT rate (%)
+            #
+            #   @param rate_extra_value [Float] Дополнительная стоимость без НДС / Additional price without VAT
+            #
+            #   @param rate_extra_value_with_vat [Float] Дополнительная стоимость с НДС / Additional price with VAT
+          end
+        end
+      end
+    end
+  end
+end

data/lib/delivery_five_post_client/models/api/v2/point_get_c2c_pickup_points_params.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module DeliveryFivePostClient
+  module Models
+    module API
+      module V2
+        # @see DeliveryFivePostClient::Resources::API::V2::Points#get_c2c_pickup_points
+        class PointGetC2cPickupPointsParams < DeliveryFivePostClient::Internal::Type::BaseModel
+          extend DeliveryFivePostClient::Internal::Type::RequestParameters::Converter
+          include DeliveryFivePostClient::Internal::Type::RequestParameters
+
+          # @!attribute city
+          #   Город / City
+          #
+          #   @return [String, nil]
+          optional :city, String
+
+          # @!attribute from_location_id
+          #   UUID в формате v4 / UUID in v4 format
+          #
+          #   @return [String, nil]
+          optional :from_location_id, String, api_name: :fromLocationId
+
+          # @!attribute region
+          #   Регион / Region
+          #
+          #   @return [String, nil]
+          optional :region, String
+
+          # @!method initialize(city: nil, from_location_id: nil, region: nil, request_options: {})
+          #   @param city [String] Город / City
+          #
+          #   @param from_location_id [String] UUID в формате v4 / UUID in v4 format
+          #
+          #   @param region [String] Регион / Region
+          #
+          #   @param request_options [DeliveryFivePostClient::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

data/lib/delivery_five_post_client/models/api/v2/point_get_c2c_pickup_points_response.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module DeliveryFivePostClient
+  module Models
+    module API
+      module V2
+        # @type [DeliveryFivePostClient::Internal::Type::Converter]
+        PointGetC2cPickupPointsResponse =
+          DeliveryFivePostClient::Internal::Type::ArrayOf[-> { DeliveryFivePostClient::API::V2::PickupPoint }]
+      end
+    end
+  end
+end

data/lib/delivery_five_post_client/models/api/v2/point_get_c2c_placement_points_params.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module DeliveryFivePostClient
+  module Models
+    module API
+      module V2
+        # @see DeliveryFivePostClient::Resources::API::V2::Points#get_c2c_placement_points
+        class PointGetC2cPlacementPointsParams < DeliveryFivePostClient::Internal::Type::BaseModel
+          extend DeliveryFivePostClient::Internal::Type::RequestParameters::Converter
+          include DeliveryFivePostClient::Internal::Type::RequestParameters
+
+          # @!attribute city
+          #   Город / City
+          #
+          #   @return [String, nil]
+          optional :city, String
+
+          # @!attribute region
+          #   Регион / Region
+          #
+          #   @return [String, nil]
+          optional :region, String
+
+          # @!method initialize(city: nil, region: nil, request_options: {})
+          #   @param city [String] Город / City
+          #
+          #   @param region [String] Регион / Region
+          #
+          #   @param request_options [DeliveryFivePostClient::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

data/lib/delivery_five_post_client/models/api/v2/point_get_c2c_placement_points_response.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module DeliveryFivePostClient
+  module Models
+    module API
+      module V2
+        # @type [DeliveryFivePostClient::Internal::Type::Converter]
+        PointGetC2cPlacementPointsResponse =
+          DeliveryFivePostClient::Internal::Type::ArrayOf[-> { DeliveryFivePostClient::API::V2::PickupPoint }]
+      end
+    end
+  end
+end

data/lib/delivery_five_post_client/models/api/v2/points/sl_get_c2c_delivery_terms_params.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module DeliveryFivePostClient
+  module Models
+    module API
+      module V2
+        module Points
+          # @see DeliveryFivePostClient::Resources::API::V2::Points::Sl#get_c2c_delivery_terms
+          class SlGetC2cDeliveryTermsParams < DeliveryFivePostClient::Internal::Type::BaseModel
+            extend DeliveryFivePostClient::Internal::Type::RequestParameters::Converter
+            include DeliveryFivePostClient::Internal::Type::RequestParameters
+
+            # @!attribute from_location_id
+            #   UUID в формате v4 / UUID in v4 format
+            #
+            #   @return [String]
+            required :from_location_id, String, api_name: :fromLocationId
+
+            # @!attribute to_location_id
+            #   UUID в формате v4 / UUID in v4 format
+            #
+            #   @return [String]
+            required :to_location_id, String, api_name: :toLocationId
+
+            # @!method initialize(from_location_id:, to_location_id:, request_options: {})
+            #   @param from_location_id [String] UUID в формате v4 / UUID in v4 format
+            #
+            #   @param to_location_id [String] UUID в формате v4 / UUID in v4 format
+            #
+            #   @param request_options [DeliveryFivePostClient::RequestOptions, Hash{Symbol=>Object}]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/delivery_five_post_client/models/api/v2/points/sl_get_c2c_delivery_terms_response.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module DeliveryFivePostClient
+  module Models
+    module API
+      module V2
+        module Points
+          # @see DeliveryFivePostClient::Resources::API::V2::Points::Sl#get_c2c_delivery_terms
+          class SlGetC2cDeliveryTermsResponse < DeliveryFivePostClient::Internal::Type::BaseModel
+            # @!attribute max_delivery_days
+            #   Максимальный срок доставки (дней) / Max delivery days
+            #
+            #   @return [Integer]
+            required :max_delivery_days, Integer, api_name: :maxDeliveryDays
+
+            # @!attribute min_delivery_days
+            #   Минимальный срок доставки (дней) / Min delivery days
+            #
+            #   @return [Integer]
+            required :min_delivery_days, Integer, api_name: :minDeliveryDays
+
+            # @!attribute logistics_scheme
+            #   Логистическая схема / Logistics scheme
+            #
+            #   @return [String, nil]
+            optional :logistics_scheme, String, api_name: :logisticsScheme
+
+            # @!method initialize(max_delivery_days:, min_delivery_days:, logistics_scheme: nil)
+            #   Ответ сроков доставки C2C / C2C delivery terms response
+            #
+            #   @param max_delivery_days [Integer] Максимальный срок доставки (дней) / Max delivery days
+            #
+            #   @param min_delivery_days [Integer] Минимальный срок доставки (дней) / Min delivery days
+            #
+            #   @param logistics_scheme [String] Логистическая схема / Logistics scheme
+          end
+        end
+      end
+    end
+  end
+end

data/lib/delivery_five_post_client/models/api/v3/partners/order_cancel_order_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module DeliveryFivePostClient
+  module Models
+    module API
+      module V3
+        module Partners
+          # @see DeliveryFivePostClient::Resources::API::V3::Partners::Orders#cancel_order
+          class OrderCancelOrderParams < DeliveryFivePostClient::Internal::Type::BaseModel
+            extend DeliveryFivePostClient::Internal::Type::RequestParameters::Converter
+            include DeliveryFivePostClient::Internal::Type::RequestParameters
+
+            # @!method initialize(request_options: {})
+            #   @param request_options [DeliveryFivePostClient::RequestOptions, Hash{Symbol=>Object}]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/delivery_five_post_client/models/api/v3/partners/order_create_order_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module DeliveryFivePostClient
+  module Models
+    module API
+      module V3
+        module Partners
+          # @see DeliveryFivePostClient::Resources::API::V3::Partners::Orders#create_order
+          class OrderCreateOrderParams < DeliveryFivePostClient::Models::API::V1::OrderCreate
+            extend DeliveryFivePostClient::Internal::Type::RequestParameters::Converter
+            include DeliveryFivePostClient::Internal::Type::RequestParameters
+
+            # @!method initialize(request_options: {})
+            #   @param request_options [DeliveryFivePostClient::RequestOptions, Hash{Symbol=>Object}]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/delivery_five_post_client/models/mile_type.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module DeliveryFivePostClient
+  module Models
+    # Тип мили доставки / Delivery mile type
+    module MileType
+      extend DeliveryFivePostClient::Internal::Type::Enum
+
+      FIRST_MILE = :FIRST_MILE
+      MIDDLE_MILE = :MIDDLE_MILE
+      LAST_MILE = :LAST_MILE
+      RETURN_MILE = :RETURN_MILE
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/delivery_five_post_client/models/webhook_create_cargo_status_params.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module DeliveryFivePostClient
+  module Models
+    # @see DeliveryFivePostClient::Resources::Webhooks#create_cargo_status
+    class WebhookCreateCargoStatusParams < DeliveryFivePostClient::Internal::Type::BaseModel
+      extend DeliveryFivePostClient::Internal::Type::RequestParameters::Converter
+      include DeliveryFivePostClient::Internal::Type::RequestParameters
+
+      # @!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 order_id
+      #   UUID в формате v4 / UUID in v4 format
+      #
+      #   @return [String]
+      required :order_id, String, api_name: :orderId
+
+      # @!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:, order_id:, sender_cargo_id:, status:, error_desc: nil, mile_type: nil, request_options: {})
+      #   @param cargo_id [String] UUID в формате v4 / UUID in v4 format
+      #
+      #   @param change_date [Time] Дата изменения статуса / Status change date
+      #
+      #   @param order_id [String] UUID в формате v4 / UUID in v4 format
+      #
+      #   @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
+      #
+      #   @param request_options [DeliveryFivePostClient::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/delivery_five_post_client/models/webhook_create_order_status_params.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module DeliveryFivePostClient
+  module Models
+    # @see DeliveryFivePostClient::Resources::Webhooks#create_order_status
+    class WebhookCreateOrderStatusParams < DeliveryFivePostClient::Internal::Type::BaseModel
+      extend DeliveryFivePostClient::Internal::Type::RequestParameters::Converter
+      include DeliveryFivePostClient::Internal::Type::RequestParameters
+
+      # @!attribute change_date
+      #   Дата изменения статуса / Status 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 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
+
+      # @!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:, order_id:, sender_order_id:, status:, error_desc: nil, mile_type: nil, request_options: {})
+      #   @param change_date [Time] Дата изменения статуса / Status change date
+      #
+      #   @param execution_status [Symbol, DeliveryFivePostClient::Models::API::V1::ExecutionStatus] Статусы исполнения заказа / Order execution statuses
+      #
+      #   @param order_id [String] UUID в формате v4 / UUID in v4 format
+      #
+      #   @param sender_order_id [String] ID заказа партнера / Partner order ID
+      #
+      #   @param status [String] Статус заказа / Order status
+      #
+      #   @param error_desc [String] Описание ошибки / Error description
+      #
+      #   @param mile_type [Symbol, DeliveryFivePostClient::Models::MileType] Тип мили доставки / Delivery mile type
+      #
+      #   @param request_options [DeliveryFivePostClient::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end