delivery-five-post-client 0.1.0

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

@@ -0,0 +1,164 @@
+# typed: strong
+
+module DeliveryFivePostClient
+  module Models
+    module API
+      module V1
+        class Cargo < DeliveryFivePostClient::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                DeliveryFivePostClient::API::V1::Cargo,
+                DeliveryFivePostClient::Internal::AnyHash
+              )
+            end
+
+          # Высота в см / Height in cm
+          sig { returns(Float) }
+          attr_accessor :height
+
+          # Длина в см / Length in cm
+          sig { returns(Float) }
+          attr_accessor :length
+
+          # Оценочная стоимость грузоместа / Cargo assessed value
+          sig { returns(Float) }
+          attr_accessor :price
+
+          # Товарные позиции в грузоместе / Product values in cargo
+          sig do
+            returns(
+              T::Array[
+                DeliveryFivePostClient::API::V1::Partners::Orders::ProductValue
+              ]
+            )
+          end
+          attr_accessor :product_values
+
+          # ID грузоместа партнера / Partner cargo ID
+          sig { returns(String) }
+          attr_accessor :sender_cargo_id
+
+          # Вес в кг / Weight in kg
+          sig { returns(Float) }
+          attr_accessor :weight
+
+          # Ширина в см / Width in cm
+          sig { returns(Float) }
+          attr_accessor :width
+
+          # Штрих-код грузоместа / Cargo barcode
+          sig { returns(T.nilable(String)) }
+          attr_reader :barcode
+
+          sig { params(barcode: String).void }
+          attr_writer :barcode
+
+          # Ставка НДС (%) / VAT rate (%)
+          sig do
+            returns(
+              T.nilable(
+                DeliveryFivePostClient::API::V1::Partners::Orders::VatRate::OrFloat
+              )
+            )
+          end
+          attr_reader :vat
+
+          sig do
+            params(
+              vat:
+                DeliveryFivePostClient::API::V1::Partners::Orders::VatRate::OrFloat
+            ).void
+          end
+          attr_writer :vat
+
+          # Информация о поставщике / Vendor information
+          sig do
+            returns(
+              T.nilable(
+                DeliveryFivePostClient::API::V1::Partners::Orders::VendorInfo
+              )
+            )
+          end
+          attr_reader :vendor
+
+          sig do
+            params(
+              vendor:
+                DeliveryFivePostClient::API::V1::Partners::Orders::VendorInfo::OrHash
+            ).void
+          end
+          attr_writer :vendor
+
+          # Грузоместо / Cargo
+          sig do
+            params(
+              height: Float,
+              length: Float,
+              price: Float,
+              product_values:
+                T::Array[
+                  DeliveryFivePostClient::API::V1::Partners::Orders::ProductValue::OrHash
+                ],
+              sender_cargo_id: String,
+              weight: Float,
+              width: Float,
+              barcode: String,
+              vat:
+                DeliveryFivePostClient::API::V1::Partners::Orders::VatRate::OrFloat,
+              vendor:
+                DeliveryFivePostClient::API::V1::Partners::Orders::VendorInfo::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Высота в см / Height in cm
+            height:,
+            # Длина в см / Length in cm
+            length:,
+            # Оценочная стоимость грузоместа / Cargo assessed value
+            price:,
+            # Товарные позиции в грузоместе / Product values in cargo
+            product_values:,
+            # ID грузоместа партнера / Partner cargo ID
+            sender_cargo_id:,
+            # Вес в кг / Weight in kg
+            weight:,
+            # Ширина в см / Width in cm
+            width:,
+            # Штрих-код грузоместа / Cargo barcode
+            barcode: nil,
+            # Ставка НДС (%) / VAT rate (%)
+            vat: nil,
+            # Информация о поставщике / Vendor information
+            vendor: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                height: Float,
+                length: Float,
+                price: Float,
+                product_values:
+                  T::Array[
+                    DeliveryFivePostClient::API::V1::Partners::Orders::ProductValue
+                  ],
+                sender_cargo_id: String,
+                weight: Float,
+                width: Float,
+                barcode: String,
+                vat:
+                  DeliveryFivePostClient::API::V1::Partners::Orders::VatRate::OrFloat,
+                vendor:
+                  DeliveryFivePostClient::API::V1::Partners::Orders::VendorInfo
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,92 @@
+# typed: strong
+
+module DeliveryFivePostClient
+  module Models
+    module API
+      module V1
+        class ClientInfo < DeliveryFivePostClient::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                DeliveryFivePostClient::API::V1::ClientInfo,
+                DeliveryFivePostClient::Internal::AnyHash
+              )
+            end
+
+          # ФИО клиента / Client full name
+          sig { returns(String) }
+          attr_accessor :name
+
+          # Номер телефона в международном формате (+79001234567) / Phone number in
+          # international format (+79001234567)
+          sig { returns(String) }
+          attr_accessor :phone
+
+          # Номер телефона в международном формате (+79001234567) / Phone number in
+          # international format (+79001234567)
+          sig { returns(T.nilable(String)) }
+          attr_reader :alternative_phone
+
+          sig { params(alternative_phone: String).void }
+          attr_writer :alternative_phone
+
+          # Email адрес / Email address
+          sig { returns(T.nilable(String)) }
+          attr_reader :email
+
+          sig { params(email: String).void }
+          attr_writer :email
+
+          # Требуется ли проверка паспорта при выдаче / Is passport validation required at
+          # pickup
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_reader :passport_validation
+
+          sig { params(passport_validation: T::Boolean).void }
+          attr_writer :passport_validation
+
+          # Информация о клиенте / Client information
+          sig do
+            params(
+              name: String,
+              phone: String,
+              alternative_phone: String,
+              email: String,
+              passport_validation: T::Boolean
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # ФИО клиента / Client full name
+            name:,
+            # Номер телефона в международном формате (+79001234567) / Phone number in
+            # international format (+79001234567)
+            phone:,
+            # Номер телефона в международном формате (+79001234567) / Phone number in
+            # international format (+79001234567)
+            alternative_phone: nil,
+            # Email адрес / Email address
+            email: nil,
+            # Требуется ли проверка паспорта при выдаче / Is passport validation required at
+            # pickup
+            passport_validation: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                name: String,
+                phone: String,
+                alternative_phone: String,
+                email: String,
+                passport_validation: T::Boolean
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# typed: strong
+
+module DeliveryFivePostClient
+  module Models
+    module API
+      module V1
+        # Валюта (в текущей версии поддерживается только RUB) / Currency (currently only
+        # RUB is supported)
+        module Currency
+          extend DeliveryFivePostClient::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, DeliveryFivePostClient::API::V1::Currency)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          RUB =
+            T.let(:RUB, DeliveryFivePostClient::API::V1::Currency::TaggedSymbol)
+
+          sig do
+            override.returns(
+              T::Array[DeliveryFivePostClient::API::V1::Currency::TaggedSymbol]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,101 @@
+# typed: strong
+
+module DeliveryFivePostClient
+  module Models
+    module API
+      module V1
+        # Статусы исполнения заказа / Order execution statuses
+        module ExecutionStatus
+          extend DeliveryFivePostClient::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, DeliveryFivePostClient::API::V1::ExecutionStatus)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          CREATED =
+            T.let(
+              :CREATED,
+              DeliveryFivePostClient::API::V1::ExecutionStatus::TaggedSymbol
+            )
+          RECEIVED =
+            T.let(
+              :RECEIVED,
+              DeliveryFivePostClient::API::V1::ExecutionStatus::TaggedSymbol
+            )
+          RECEIVED_IN_DROP =
+            T.let(
+              :RECEIVED_IN_DROP,
+              DeliveryFivePostClient::API::V1::ExecutionStatus::TaggedSymbol
+            )
+          RECEIVED_IN_STORE =
+            T.let(
+              :RECEIVED_IN_STORE,
+              DeliveryFivePostClient::API::V1::ExecutionStatus::TaggedSymbol
+            )
+          RECEIVED_IN_TRANSIT_WAREHOUSE =
+            T.let(
+              :RECEIVED_IN_TRANSIT_WAREHOUSE,
+              DeliveryFivePostClient::API::V1::ExecutionStatus::TaggedSymbol
+            )
+          SHIPPED =
+            T.let(
+              :SHIPPED,
+              DeliveryFivePostClient::API::V1::ExecutionStatus::TaggedSymbol
+            )
+          IN_TRANSIT =
+            T.let(
+              :IN_TRANSIT,
+              DeliveryFivePostClient::API::V1::ExecutionStatus::TaggedSymbol
+            )
+          READY_TO_RECEIVE =
+            T.let(
+              :READY_TO_RECEIVE,
+              DeliveryFivePostClient::API::V1::ExecutionStatus::TaggedSymbol
+            )
+          DELIVERED =
+            T.let(
+              :DELIVERED,
+              DeliveryFivePostClient::API::V1::ExecutionStatus::TaggedSymbol
+            )
+          RETURNED =
+            T.let(
+              :RETURNED,
+              DeliveryFivePostClient::API::V1::ExecutionStatus::TaggedSymbol
+            )
+          REJECTED =
+            T.let(
+              :REJECTED,
+              DeliveryFivePostClient::API::V1::ExecutionStatus::TaggedSymbol
+            )
+          CANCELLED =
+            T.let(
+              :CANCELLED,
+              DeliveryFivePostClient::API::V1::ExecutionStatus::TaggedSymbol
+            )
+          LOST =
+            T.let(
+              :LOST,
+              DeliveryFivePostClient::API::V1::ExecutionStatus::TaggedSymbol
+            )
+          UNCLAIMED =
+            T.let(
+              :UNCLAIMED,
+              DeliveryFivePostClient::API::V1::ExecutionStatus::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                DeliveryFivePostClient::API::V1::ExecutionStatus::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,50 @@
+# typed: strong
+
+module DeliveryFivePostClient
+  module Models
+    module API
+      module V1
+        class GetLabelStatusBySenderOrderIDsParams < 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::GetLabelStatusBySenderOrderIDsParams,
+                DeliveryFivePostClient::Internal::AnyHash
+              )
+            end
+
+          # Массив ID заказов партнера / Array of partner order IDs
+          sig { returns(T::Array[String]) }
+          attr_accessor :sender_order_ids
+
+          sig do
+            params(
+              sender_order_ids: T::Array[String],
+              request_options: DeliveryFivePostClient::RequestOptions::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Массив ID заказов партнера / Array of partner order IDs
+            sender_order_ids:,
+            request_options: {}
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                sender_order_ids: T::Array[String],
+                request_options: DeliveryFivePostClient::RequestOptions
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,155 @@
+# typed: strong
+
+module DeliveryFivePostClient
+  module Models
+    module API
+      module V1
+        class GetLabelStatusBySenderOrderIDsResponse < DeliveryFivePostClient::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                DeliveryFivePostClient::Models::API::V1::GetLabelStatusBySenderOrderIDsResponse,
+                DeliveryFivePostClient::Internal::AnyHash
+              )
+            end
+
+          # Массив статусов этикеток / Array of label statuses
+          sig do
+            returns(
+              T::Array[
+                DeliveryFivePostClient::Models::API::V1::GetLabelStatusBySenderOrderIDsResponse::LabelStatus
+              ]
+            )
+          end
+          attr_accessor :label_statuses
+
+          # Ответ со статусами этикеток / Label statuses response
+          sig do
+            params(
+              label_statuses:
+                T::Array[
+                  DeliveryFivePostClient::Models::API::V1::GetLabelStatusBySenderOrderIDsResponse::LabelStatus::OrHash
+                ]
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Массив статусов этикеток / Array of label statuses
+            label_statuses:
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                label_statuses:
+                  T::Array[
+                    DeliveryFivePostClient::Models::API::V1::GetLabelStatusBySenderOrderIDsResponse::LabelStatus
+                  ]
+              }
+            )
+          end
+          def to_hash
+          end
+
+          class LabelStatus < DeliveryFivePostClient::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  DeliveryFivePostClient::Models::API::V1::GetLabelStatusBySenderOrderIDsResponse::LabelStatus,
+                  DeliveryFivePostClient::Internal::AnyHash
+                )
+              end
+
+            # 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
+
+            # Статус этикетки / Label status
+            sig do
+              returns(
+                DeliveryFivePostClient::Models::API::V1::GetLabelStatusBySenderOrderIDsResponse::LabelStatus::Status::TaggedSymbol
+              )
+            end
+            attr_accessor :status
+
+            # Информация о статусе этикетки / Label status information
+            sig do
+              params(
+                order_id: String,
+                sender_order_id: String,
+                status:
+                  DeliveryFivePostClient::Models::API::V1::GetLabelStatusBySenderOrderIDsResponse::LabelStatus::Status::OrSymbol
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # UUID в формате v4 / UUID in v4 format
+              order_id:,
+              # ID заказа партнера / Partner order ID
+              sender_order_id:,
+              # Статус этикетки / Label status
+              status:
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  order_id: String,
+                  sender_order_id: String,
+                  status:
+                    DeliveryFivePostClient::Models::API::V1::GetLabelStatusBySenderOrderIDsResponse::LabelStatus::Status::TaggedSymbol
+                }
+              )
+            end
+            def to_hash
+            end
+
+            # Статус этикетки / Label status
+            module Status
+              extend DeliveryFivePostClient::Internal::Type::Enum
+
+              TaggedSymbol =
+                T.type_alias do
+                  T.all(
+                    Symbol,
+                    DeliveryFivePostClient::Models::API::V1::GetLabelStatusBySenderOrderIDsResponse::LabelStatus::Status
+                  )
+                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              NEW =
+                T.let(
+                  :NEW,
+                  DeliveryFivePostClient::Models::API::V1::GetLabelStatusBySenderOrderIDsResponse::LabelStatus::Status::TaggedSymbol
+                )
+              READY =
+                T.let(
+                  :READY,
+                  DeliveryFivePostClient::Models::API::V1::GetLabelStatusBySenderOrderIDsResponse::LabelStatus::Status::TaggedSymbol
+                )
+              ERROR =
+                T.let(
+                  :ERROR,
+                  DeliveryFivePostClient::Models::API::V1::GetLabelStatusBySenderOrderIDsResponse::LabelStatus::Status::TaggedSymbol
+                )
+
+              sig do
+                override.returns(
+                  T::Array[
+                    DeliveryFivePostClient::Models::API::V1::GetLabelStatusBySenderOrderIDsResponse::LabelStatus::Status::TaggedSymbol
+                  ]
+                )
+              end
+              def self.values
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end