delivery-five-post-client 0.1.0

data/rbi/delivery_five_post_client/models/api/v1/order_cost.rbi

@@ -0,0 +1,157 @@
+# typed: strong
+
+module DeliveryFivePostClient
+  module Models
+    module API
+      module V1
+        class OrderCost < DeliveryFivePostClient::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                DeliveryFivePostClient::API::V1::OrderCost,
+                DeliveryFivePostClient::Internal::AnyHash
+              )
+            end
+
+          # Оценочная стоимость заказа / Order assessed value
+          sig { returns(Float) }
+          attr_accessor :assessed_value
+
+          # Валюта (в текущей версии поддерживается только RUB) / Currency (currently only
+          # RUB is supported)
+          sig { returns(DeliveryFivePostClient::API::V1::Currency::OrSymbol) }
+          attr_accessor :payment_currency
+
+          # Общая стоимость товаров / Total price of items
+          sig { returns(Float) }
+          attr_accessor :price
+
+          # Стоимость доставки / Delivery price
+          sig { returns(T.nilable(Float)) }
+          attr_reader :delivery_price
+
+          sig { params(delivery_price: Float).void }
+          attr_writer :delivery_price
+
+          # Тип оплаты / Payment type
+          sig do
+            returns(
+              T.nilable(
+                DeliveryFivePostClient::API::V1::OrderCost::PaymentType::OrSymbol
+              )
+            )
+          end
+          attr_reader :payment_type
+
+          sig do
+            params(
+              payment_type:
+                DeliveryFivePostClient::API::V1::OrderCost::PaymentType::OrSymbol
+            ).void
+          end
+          attr_writer :payment_type
+
+          # Сумма наложенного платежа / Cash on delivery amount
+          sig { returns(T.nilable(Float)) }
+          attr_reader :payment_value
+
+          sig { params(payment_value: Float).void }
+          attr_writer :payment_value
+
+          # Сумма предоплаты / Prepayment amount
+          sig { returns(T.nilable(Float)) }
+          attr_reader :prepayment_sum
+
+          sig { params(prepayment_sum: Float).void }
+          attr_writer :prepayment_sum
+
+          # Стоимостные параметры заказа / Order cost parameters
+          sig do
+            params(
+              assessed_value: Float,
+              payment_currency:
+                DeliveryFivePostClient::API::V1::Currency::OrSymbol,
+              price: Float,
+              delivery_price: Float,
+              payment_type:
+                DeliveryFivePostClient::API::V1::OrderCost::PaymentType::OrSymbol,
+              payment_value: Float,
+              prepayment_sum: Float
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Оценочная стоимость заказа / Order assessed value
+            assessed_value:,
+            # Валюта (в текущей версии поддерживается только RUB) / Currency (currently only
+            # RUB is supported)
+            payment_currency:,
+            # Общая стоимость товаров / Total price of items
+            price:,
+            # Стоимость доставки / Delivery price
+            delivery_price: nil,
+            # Тип оплаты / Payment type
+            payment_type: nil,
+            # Сумма наложенного платежа / Cash on delivery amount
+            payment_value: nil,
+            # Сумма предоплаты / Prepayment amount
+            prepayment_sum: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                assessed_value: Float,
+                payment_currency:
+                  DeliveryFivePostClient::API::V1::Currency::OrSymbol,
+                price: Float,
+                delivery_price: Float,
+                payment_type:
+                  DeliveryFivePostClient::API::V1::OrderCost::PaymentType::OrSymbol,
+                payment_value: Float,
+                prepayment_sum: Float
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # Тип оплаты / Payment type
+          module PaymentType
+            extend DeliveryFivePostClient::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  DeliveryFivePostClient::API::V1::OrderCost::PaymentType
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            PREPAID =
+              T.let(
+                :PREPAID,
+                DeliveryFivePostClient::API::V1::OrderCost::PaymentType::TaggedSymbol
+              )
+            POSTPAID =
+              T.let(
+                :POSTPAID,
+                DeliveryFivePostClient::API::V1::OrderCost::PaymentType::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  DeliveryFivePostClient::API::V1::OrderCost::PaymentType::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/delivery_five_post_client/models/api/v1/order_create.rbi

@@ -0,0 +1,168 @@
+# typed: strong
+
+module DeliveryFivePostClient
+  module Models
+    module API
+      module V1
+        class OrderCreate < DeliveryFivePostClient::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                DeliveryFivePostClient::API::V1::OrderCreate,
+                DeliveryFivePostClient::Internal::AnyHash
+              )
+            end
+
+          # Грузоместа / Cargoes
+          sig { returns(T::Array[DeliveryFivePostClient::API::V1::Cargo]) }
+          attr_accessor :cargoes
+
+          # Информация о клиенте / Client information
+          sig { returns(DeliveryFivePostClient::API::V1::ClientInfo) }
+          attr_reader :client
+
+          sig do
+            params(
+              client: DeliveryFivePostClient::API::V1::ClientInfo::OrHash
+            ).void
+          end
+          attr_writer :client
+
+          # Стоимостные параметры заказа / Order cost parameters
+          sig { returns(DeliveryFivePostClient::API::V1::OrderCost) }
+          attr_reader :cost
+
+          sig do
+            params(
+              cost: DeliveryFivePostClient::API::V1::OrderCost::OrHash
+            ).void
+          end
+          attr_writer :cost
+
+          # Точка получения / Receiver location
+          sig { returns(DeliveryFivePostClient::API::V1::ReceiverLocation) }
+          attr_reader :receiver
+
+          sig do
+            params(
+              receiver:
+                DeliveryFivePostClient::API::V1::ReceiverLocation::OrHash
+            ).void
+          end
+          attr_writer :receiver
+
+          # ID заказа партнера / Partner order ID
+          sig { returns(String) }
+          attr_accessor :sender_order_id
+
+          # Ссылка на склад / Warehouse reference
+          sig do
+            returns(DeliveryFivePostClient::API::V1::OrderCreate::Warehouse)
+          end
+          attr_reader :warehouse
+
+          sig do
+            params(
+              warehouse:
+                DeliveryFivePostClient::API::V1::OrderCreate::Warehouse::OrHash
+            ).void
+          end
+          attr_writer :warehouse
+
+          # Название бренда отправителя / Sender brand name
+          sig { returns(T.nilable(String)) }
+          attr_reader :brand_name
+
+          sig { params(brand_name: String).void }
+          attr_writer :brand_name
+
+          # ID заказа клиента / Client order ID
+          sig { returns(T.nilable(String)) }
+          attr_reader :client_order_id
+
+          sig { params(client_order_id: String).void }
+          attr_writer :client_order_id
+
+          # Запрос на создание заказа / Order creation request
+          sig do
+            params(
+              cargoes: T::Array[DeliveryFivePostClient::API::V1::Cargo::OrHash],
+              client: DeliveryFivePostClient::API::V1::ClientInfo::OrHash,
+              cost: DeliveryFivePostClient::API::V1::OrderCost::OrHash,
+              receiver:
+                DeliveryFivePostClient::API::V1::ReceiverLocation::OrHash,
+              sender_order_id: String,
+              warehouse:
+                DeliveryFivePostClient::API::V1::OrderCreate::Warehouse::OrHash,
+              brand_name: String,
+              client_order_id: String
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Грузоместа / Cargoes
+            cargoes:,
+            # Информация о клиенте / Client information
+            client:,
+            # Стоимостные параметры заказа / Order cost parameters
+            cost:,
+            # Точка получения / Receiver location
+            receiver:,
+            # ID заказа партнера / Partner order ID
+            sender_order_id:,
+            # Ссылка на склад / Warehouse reference
+            warehouse:,
+            # Название бренда отправителя / Sender brand name
+            brand_name: nil,
+            # ID заказа клиента / Client order ID
+            client_order_id: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                cargoes: T::Array[DeliveryFivePostClient::API::V1::Cargo],
+                client: DeliveryFivePostClient::API::V1::ClientInfo,
+                cost: DeliveryFivePostClient::API::V1::OrderCost,
+                receiver: DeliveryFivePostClient::API::V1::ReceiverLocation,
+                sender_order_id: String,
+                warehouse:
+                  DeliveryFivePostClient::API::V1::OrderCreate::Warehouse,
+                brand_name: String,
+                client_order_id: String
+              }
+            )
+          end
+          def to_hash
+          end
+
+          class Warehouse < DeliveryFivePostClient::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  DeliveryFivePostClient::API::V1::OrderCreate::Warehouse,
+                  DeliveryFivePostClient::Internal::AnyHash
+                )
+              end
+
+            # UUID в формате v4 / UUID in v4 format
+            sig { returns(String) }
+            attr_accessor :id
+
+            # Ссылка на склад / Warehouse reference
+            sig { params(id: String).returns(T.attached_class) }
+            def self.new(
+              # UUID в формате v4 / UUID in v4 format
+              id:
+            )
+            end
+
+            sig { override.returns({ id: String }) }
+            def to_hash
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/delivery_five_post_client/models/api/v1/order_create_response.rbi

@@ -0,0 +1,106 @@
+# typed: strong
+
+module DeliveryFivePostClient
+  module Models
+    module API
+      module V1
+        class OrderCreateResponse < DeliveryFivePostClient::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                DeliveryFivePostClient::API::V1::OrderCreateResponse,
+                DeliveryFivePostClient::Internal::AnyHash
+              )
+            end
+
+          # Информация о созданных грузоместах / Created cargoes information
+          sig do
+            returns(
+              T::Array[
+                DeliveryFivePostClient::API::V1::Partners::Orders::CargoCreatedInfo
+              ]
+            )
+          end
+          attr_accessor :cargoes
+
+          # Статусы исполнения заказа / Order execution statuses
+          sig do
+            returns(
+              DeliveryFivePostClient::API::V1::ExecutionStatus::TaggedSymbol
+            )
+          end
+          attr_accessor :execution_status
+
+          # UUID в формате v4 / UUID in v4 format
+          sig { returns(String) }
+          attr_accessor :order_id
+
+          # ID заказа партнера / Partner order ID
+          sig { returns(String) }
+          attr_accessor :sender_order_id
+
+          # Статус заказа / Order status
+          sig { returns(String) }
+          attr_accessor :status
+
+          # Маркер дубликата заказа / Duplicate order marker
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_reader :is_duplicate
+
+          sig { params(is_duplicate: T::Boolean).void }
+          attr_writer :is_duplicate
+
+          # Ответ на создание заказа / Order creation response
+          sig do
+            params(
+              cargoes:
+                T::Array[
+                  DeliveryFivePostClient::API::V1::Partners::Orders::CargoCreatedInfo::OrHash
+                ],
+              execution_status:
+                DeliveryFivePostClient::API::V1::ExecutionStatus::OrSymbol,
+              order_id: String,
+              sender_order_id: String,
+              status: String,
+              is_duplicate: T::Boolean
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Информация о созданных грузоместах / Created cargoes information
+            cargoes:,
+            # Статусы исполнения заказа / Order execution statuses
+            execution_status:,
+            # UUID в формате v4 / UUID in v4 format
+            order_id:,
+            # ID заказа партнера / Partner order ID
+            sender_order_id:,
+            # Статус заказа / Order status
+            status:,
+            # Маркер дубликата заказа / Duplicate order marker
+            is_duplicate: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                cargoes:
+                  T::Array[
+                    DeliveryFivePostClient::API::V1::Partners::Orders::CargoCreatedInfo
+                  ],
+                execution_status:
+                  DeliveryFivePostClient::API::V1::ExecutionStatus::TaggedSymbol,
+                order_id: String,
+                sender_order_id: String,
+                status: String,
+                is_duplicate: T::Boolean
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/delivery_five_post_client/models/api/v1/order_status_request.rbi

@@ -0,0 +1,59 @@
+# typed: strong
+
+module DeliveryFivePostClient
+  module Models
+    module API
+      module V1
+        class OrderStatusRequest < DeliveryFivePostClient::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                DeliveryFivePostClient::API::V1::OrderStatusRequest,
+                DeliveryFivePostClient::Internal::AnyHash
+              )
+            end
+
+          # Массив UUID заказов / Array of order UUIDs
+          sig { returns(T.nilable(T::Array[String])) }
+          attr_reader :order_ids
+
+          sig { params(order_ids: T::Array[String]).void }
+          attr_writer :order_ids
+
+          # Массив ID заказов партнера / Array of partner order IDs
+          sig { returns(T.nilable(T::Array[String])) }
+          attr_reader :sender_order_ids
+
+          sig { params(sender_order_ids: T::Array[String]).void }
+          attr_writer :sender_order_ids
+
+          # Запрос на получение статуса заказов / Order status request
+          sig do
+            params(
+              order_ids: T::Array[String],
+              sender_order_ids: T::Array[String]
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Массив UUID заказов / Array of order UUIDs
+            order_ids: nil,
+            # Массив ID заказов партнера / Array of partner order IDs
+            sender_order_ids: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                order_ids: T::Array[String],
+                sender_order_ids: T::Array[String]
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/delivery_five_post_client/models/api/v1/partner_create_order_params.rbi

@@ -0,0 +1,38 @@
+# typed: strong
+
+module DeliveryFivePostClient
+  module Models
+    module API
+      module V1
+        class PartnerCreateOrderParams < DeliveryFivePostClient::Models::API::V1::OrderCreate
+          extend DeliveryFivePostClient::Internal::Type::RequestParameters::Converter
+          include DeliveryFivePostClient::Internal::Type::RequestParameters
+
+          OrHash =
+            T.type_alias do
+              T.any(
+                DeliveryFivePostClient::API::V1::PartnerCreateOrderParams,
+                DeliveryFivePostClient::Internal::AnyHash
+              )
+            end
+
+          sig do
+            params(
+              request_options: DeliveryFivePostClient::RequestOptions::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(request_options: {})
+          end
+
+          sig do
+            override.returns(
+              { request_options: DeliveryFivePostClient::RequestOptions }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/delivery_five_post_client/models/api/v1/partner_delivery_params_params.rbi

@@ -0,0 +1,64 @@
+# typed: strong
+
+module DeliveryFivePostClient
+  module Models
+    module API
+      module V1
+        class PartnerDeliveryParamsParams < DeliveryFivePostClient::Internal::Type::BaseModel
+          extend DeliveryFivePostClient::Internal::Type::RequestParameters::Converter
+          include DeliveryFivePostClient::Internal::Type::RequestParameters
+
+          OrHash =
+            T.type_alias do
+              T.any(
+                DeliveryFivePostClient::API::V1::PartnerDeliveryParamsParams,
+                DeliveryFivePostClient::Internal::AnyHash
+              )
+            end
+
+          # Город / City
+          sig { returns(T.nilable(String)) }
+          attr_reader :city
+
+          sig { params(city: String).void }
+          attr_writer :city
+
+          # Регион / Region
+          sig { returns(T.nilable(String)) }
+          attr_reader :region
+
+          sig { params(region: String).void }
+          attr_writer :region
+
+          sig do
+            params(
+              city: String,
+              region: String,
+              request_options: DeliveryFivePostClient::RequestOptions::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Город / City
+            city: nil,
+            # Регион / Region
+            region: nil,
+            request_options: {}
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                city: String,
+                region: String,
+                request_options: DeliveryFivePostClient::RequestOptions
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end