delivery-five-post-client 0.1.0

data/lib/delivery_five_post_client/resources/api/v3/partners/orders.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module DeliveryFivePostClient
+  module Resources
+    class API
+      class V3
+        class Partners
+          class Orders
+            # Отмена заказа / Cancel order
+            #
+            # @overload cancel_order(order_id, request_options: {})
+            #
+            # @param order_id [String] UUID в формате v4 / UUID in v4 format
+            #
+            # @param request_options [DeliveryFivePostClient::RequestOptions, Hash{Symbol=>Object}, nil]
+            #
+            # @return [nil]
+            #
+            # @see DeliveryFivePostClient::Models::API::V3::Partners::OrderCancelOrderParams
+            def cancel_order(order_id, params = {})
+              @client.request(
+                method: :delete,
+                path: ["api/v3/partners/orders/%1$s", order_id],
+                model: NilClass,
+                options: params[:request_options]
+              )
+            end
+
+            # Универсальное создание заказа / Universal order creation
+            #
+            # @overload create_order(cargoes:, client:, cost:, receiver:, sender_order_id:, warehouse:, brand_name: nil, client_order_id: nil, request_options: {})
+            #
+            # @param cargoes [Array<DeliveryFivePostClient::Models::API::V1::Cargo>] Грузоместа / Cargoes
+            #
+            # @param client [DeliveryFivePostClient::Models::API::V1::ClientInfo] Информация о клиенте / Client information
+            #
+            # @param cost [DeliveryFivePostClient::Models::API::V1::OrderCost] Стоимостные параметры заказа / Order cost parameters
+            #
+            # @param receiver [DeliveryFivePostClient::Models::API::V1::ReceiverLocation] Точка получения / Receiver location
+            #
+            # @param sender_order_id [String] ID заказа партнера / Partner order ID
+            #
+            # @param warehouse [DeliveryFivePostClient::Models::API::V1::OrderCreate::Warehouse] Ссылка на склад / Warehouse reference
+            #
+            # @param brand_name [String] Название бренда отправителя / Sender brand name
+            #
+            # @param client_order_id [String] ID заказа клиента / Client order ID
+            #
+            # @param request_options [DeliveryFivePostClient::RequestOptions, Hash{Symbol=>Object}, nil]
+            #
+            # @return [DeliveryFivePostClient::Models::API::V1::OrderCreateResponse]
+            #
+            # @see DeliveryFivePostClient::Models::API::V3::Partners::OrderCreateOrderParams
+            def create_order(params)
+              parsed, options = DeliveryFivePostClient::API::V3::Partners::OrderCreateOrderParams.dump_request(params)
+              @client.request(
+                method: :post,
+                path: "api/v3/partners/orders",
+                body: parsed,
+                model: DeliveryFivePostClient::API::V1::OrderCreateResponse,
+                options: options
+              )
+            end
+
+            # @api private
+            #
+            # @param client [DeliveryFivePostClient::Client]
+            def initialize(client:)
+              @client = client
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/delivery_five_post_client/resources/api/v3/partners.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module DeliveryFivePostClient
+  module Resources
+    class API
+      class V3
+        class Partners
+          # @return [DeliveryFivePostClient::Resources::API::V3::Partners::Orders]
+          attr_reader :orders
+
+          # @api private
+          #
+          # @param client [DeliveryFivePostClient::Client]
+          def initialize(client:)
+            @client = client
+            @orders = DeliveryFivePostClient::Resources::API::V3::Partners::Orders.new(client: client)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/delivery_five_post_client/resources/api/v3.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module DeliveryFivePostClient
+  module Resources
+    class API
+      class V3
+        # @return [DeliveryFivePostClient::Resources::API::V3::Partners]
+        attr_reader :partners
+
+        # @api private
+        #
+        # @param client [DeliveryFivePostClient::Client]
+        def initialize(client:)
+          @client = client
+          @partners = DeliveryFivePostClient::Resources::API::V3::Partners.new(client: client)
+        end
+      end
+    end
+  end
+end

data/lib/delivery_five_post_client/resources/api.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module DeliveryFivePostClient
+  module Resources
+    class API
+      # @return [DeliveryFivePostClient::Resources::API::V1]
+      attr_reader :v1
+
+      # @return [DeliveryFivePostClient::Resources::API::V2]
+      attr_reader :v2
+
+      # @return [DeliveryFivePostClient::Resources::API::V3]
+      attr_reader :v3
+
+      # @api private
+      #
+      # @param client [DeliveryFivePostClient::Client]
+      def initialize(client:)
+        @client = client
+        @v1 = DeliveryFivePostClient::Resources::API::V1.new(client: client)
+        @v2 = DeliveryFivePostClient::Resources::API::V2.new(client: client)
+        @v3 = DeliveryFivePostClient::Resources::API::V3.new(client: client)
+      end
+    end
+  end
+end

data/lib/delivery_five_post_client/resources/webhooks.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module DeliveryFivePostClient
+  module Resources
+    class Webhooks
+      # Событие изменения статуса грузоместа / Cargo status change event
+      #
+      # @overload create_cargo_status(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}, nil]
+      #
+      # @return [nil]
+      #
+      # @see DeliveryFivePostClient::Models::WebhookCreateCargoStatusParams
+      def create_cargo_status(params)
+        parsed, options = DeliveryFivePostClient::WebhookCreateCargoStatusParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "webhooks/cargo-status",
+          body: parsed,
+          model: NilClass,
+          options: options
+        )
+      end
+
+      # Событие изменения статуса заказа / Order status change event
+      #
+      # @overload create_order_status(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}, nil]
+      #
+      # @return [nil]
+      #
+      # @see DeliveryFivePostClient::Models::WebhookCreateOrderStatusParams
+      def create_order_status(params)
+        parsed, options = DeliveryFivePostClient::WebhookCreateOrderStatusParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "webhooks/order-status",
+          body: parsed,
+          model: NilClass,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [DeliveryFivePostClient::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/delivery_five_post_client/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module DeliveryFivePostClient
+  VERSION = "0.1.0"
+end

data/lib/delivery_five_post_client.rb

@@ -0,0 +1,182 @@
+# frozen_string_literal: true
+
+# Standard libraries.
+# rubocop:disable Lint/RedundantRequireStatement
+require "English"
+require "base64"
+require "cgi"
+require "date"
+require "erb"
+require "etc"
+require "json"
+require "net/http"
+require "openssl"
+require "pathname"
+require "rbconfig"
+require "securerandom"
+require "set"
+require "stringio"
+require "time"
+require "uri"
+# rubocop:enable Lint/RedundantRequireStatement
+
+# We already ship the preferred sorbet manifests in the package itself.
+# `tapioca` currently does not offer us a way to opt out of unnecessary compilation.
+if Object.const_defined?(:Tapioca) &&
+   caller.chain([$PROGRAM_NAME]).chain(ARGV).any?(/tapioca/) &&
+   ARGV.none?(/dsl/)
+  return
+end
+
+# Gems.
+require "connection_pool"
+
+# Package files.
+require_relative "delivery_five_post_client/version"
+require_relative "delivery_five_post_client/internal/util"
+require_relative "delivery_five_post_client/internal/type/converter"
+require_relative "delivery_five_post_client/internal/type/unknown"
+require_relative "delivery_five_post_client/internal/type/boolean"
+require_relative "delivery_five_post_client/internal/type/file_input"
+require_relative "delivery_five_post_client/internal/type/enum"
+require_relative "delivery_five_post_client/internal/type/union"
+require_relative "delivery_five_post_client/internal/type/array_of"
+require_relative "delivery_five_post_client/internal/type/hash_of"
+require_relative "delivery_five_post_client/internal/type/base_model"
+require_relative "delivery_five_post_client/internal/type/base_page"
+require_relative "delivery_five_post_client/internal/type/request_parameters"
+require_relative "delivery_five_post_client/internal"
+require_relative "delivery_five_post_client/request_options"
+require_relative "delivery_five_post_client/file_part"
+require_relative "delivery_five_post_client/errors"
+require_relative "delivery_five_post_client/internal/transport/base_client"
+require_relative "delivery_five_post_client/internal/transport/pooled_net_requester"
+require_relative "delivery_five_post_client/client"
+require_relative "delivery_five_post_client/models/api/v1/order_create"
+require_relative "delivery_five_post_client/models/api/v1/order_status_request"
+require_relative "delivery_five_post_client/models/api/v1/partners/task_status_request"
+require_relative "delivery_five_post_client/models/api/v1/address"
+require_relative "delivery_five_post_client/models/api/v1/cargo"
+require_relative "delivery_five_post_client/models/api/v1/client_info"
+require_relative "delivery_five_post_client/models/api/v1/currency"
+require_relative "delivery_five_post_client/models/api/v1/execution_status"
+require_relative "delivery_five_post_client/models/api/v1/get_label_status_by_sender_order_ids_params"
+require_relative "delivery_five_post_client/models/api/v1/get_label_status_by_sender_order_ids_response"
+require_relative "delivery_five_post_client/models/api/v1/order_cost"
+require_relative "delivery_five_post_client/models/api/v1/order_create_response"
+require_relative "delivery_five_post_client/models/api/v1/partner_create_order_params"
+require_relative "delivery_five_post_client/models/api/v1/partner_delivery_params_params"
+require_relative "delivery_five_post_client/models/api/v1/partner_delivery_params_response"
+require_relative "delivery_five_post_client/models/api/v1/partner_delivery_to_address_params"
+require_relative "delivery_five_post_client/models/api/v1/partner_delivery_to_address_response"
+require_relative "delivery_five_post_client/models/api/v1/partner_get_actual_cargo_size_params"
+require_relative "delivery_five_post_client/models/api/v1/partner_get_actual_cargo_size_response"
+require_relative "delivery_five_post_client/models/api/v1/partner_get_cargo_status_params"
+require_relative "delivery_five_post_client/models/api/v1/partner_get_cargo_status_response"
+require_relative "delivery_five_post_client/models/api/v1/partner_get_order_history_mass_params"
+require_relative "delivery_five_post_client/models/api/v1/partner_get_order_history_mass_response"
+require_relative "delivery_five_post_client/models/api/v1/partner_get_order_status_params"
+require_relative "delivery_five_post_client/models/api/v1/partner_get_order_status_response"
+require_relative "delivery_five_post_client/models/api/v1/partner_get_receipts_params"
+require_relative "delivery_five_post_client/models/api/v1/partner_get_receipts_response"
+require_relative "delivery_five_post_client/models/api/v1/partner_get_receiver_locations_params"
+require_relative "delivery_five_post_client/models/api/v1/partner_get_receiver_locations_response"
+require_relative "delivery_five_post_client/models/api/v1/partner_get_security_code_params"
+require_relative "delivery_five_post_client/models/api/v1/partner_get_security_code_response"
+require_relative "delivery_five_post_client/models/api/v1/partner_order_labels_params"
+require_relative "delivery_five_post_client/models/api/v1/partner_order_labels_response"
+require_relative "delivery_five_post_client/models/api/v1/partner_pickup_points_params"
+require_relative "delivery_five_post_client/models/api/v1/partner_pickup_points_response"
+require_relative "delivery_five_post_client/models/api/v1/partner_retrieve_params"
+require_relative "delivery_five_post_client/models/api/v1/partner_retrieve_response"
+require_relative "delivery_five_post_client/models/api/v1/partner_retrieve_warehouse_all_params"
+require_relative "delivery_five_post_client/models/api/v1/partner_retrieve_warehouse_all_response"
+require_relative "delivery_five_post_client/models/api/v1/partners/contacts"
+require_relative "delivery_five_post_client/models/api/v1/partners/extend_storage_day_extend_storage_days_params"
+require_relative "delivery_five_post_client/models/api/v1/partners/extend_storage_day_extend_storage_days_response"
+require_relative "delivery_five_post_client/models/api/v1/partners/extend_storage_day_status_params"
+require_relative "delivery_five_post_client/models/api/v1/partners/jwt_generate_params"
+require_relative "delivery_five_post_client/models/api/v1/partners/jwt_generate_response"
+require_relative "delivery_five_post_client/models/api/v1/partners/order_c2c_params"
+require_relative "delivery_five_post_client/models/api/v1/partners/order_c2c_response"
+require_relative "delivery_five_post_client/models/api/v1/partners/orders/cargo_created_info"
+require_relative "delivery_five_post_client/models/api/v1/partners/orders/cargo_create_params"
+require_relative "delivery_five_post_client/models/api/v1/partners/orders/cargo_delete_params"
+require_relative "delivery_five_post_client/models/api/v1/partners/orders/cargo_update_params"
+require_relative "delivery_five_post_client/models/api/v1/partners/orders/product_value"
+require_relative "delivery_five_post_client/models/api/v1/partners/orders/vat_rate"
+require_relative "delivery_five_post_client/models/api/v1/partners/orders/vendor_info"
+require_relative "delivery_five_post_client/models/api/v1/partners/order_update_client_info_params"
+require_relative "delivery_five_post_client/models/api/v1/partners/order_update_payment_value_params"
+require_relative "delivery_five_post_client/models/api/v1/partners/partner_supply_create_params"
+require_relative "delivery_five_post_client/models/api/v1/partners/partner_supply_delete_params"
+require_relative "delivery_five_post_client/models/api/v1/partners/partner_supply_delete_response"
+require_relative "delivery_five_post_client/models/api/v1/partners/partner_supply_retrieve_params"
+require_relative "delivery_five_post_client/models/api/v1/partners/partner_supply_retrieve_partner_supply_params"
+require_relative "delivery_five_post_client/models/api/v1/partners/partner_supply_retrieve_partner_supply_response"
+require_relative "delivery_five_post_client/models/api/v1/partners/partner_supply_update_params"
+require_relative "delivery_five_post_client/models/api/v1/partners/redirection_create_params"
+require_relative "delivery_five_post_client/models/api/v1/partners/redirection_create_response"
+require_relative "delivery_five_post_client/models/api/v1/partners/redirection_status_params"
+require_relative "delivery_five_post_client/models/api/v1/partners/return_retrieve_get_placement_code_params"
+require_relative "delivery_five_post_client/models/api/v1/partners/return_retrieve_get_placement_code_response"
+require_relative "delivery_five_post_client/models/api/v1/partners/return_retrieve_get_return_barcode_params"
+require_relative "delivery_five_post_client/models/api/v1/partners/return_retrieve_get_return_barcode_response"
+require_relative "delivery_five_post_client/models/api/v1/partners/supply_cargo"
+require_relative "delivery_five_post_client/models/api/v1/partners/supply_info"
+require_relative "delivery_five_post_client/models/api/v1/partners/supply_status"
+require_relative "delivery_five_post_client/models/api/v1/partners/supply_type"
+require_relative "delivery_five_post_client/models/api/v1/partners/tasks/report/avd_create_params"
+require_relative "delivery_five_post_client/models/api/v1/partners/tasks/report/avd_create_response"
+require_relative "delivery_five_post_client/models/api/v1/partners/tasks/report/avd_result_params"
+require_relative "delivery_five_post_client/models/api/v1/partners/tasks/report/avd_status_params"
+require_relative "delivery_five_post_client/models/api/v1/partners/tasks/report/avd_status_response"
+require_relative "delivery_five_post_client/models/api/v1/partners/task_status"
+require_relative "delivery_five_post_client/models/api/v1/partners/task_status_response"
+require_relative "delivery_five_post_client/models/api/v1/partners/warehouse_create_params"
+require_relative "delivery_five_post_client/models/api/v1/partners/warehouse_create_response"
+require_relative "delivery_five_post_client/models/api/v1/partners/warehouse_info"
+require_relative "delivery_five_post_client/models/api/v1/partners/warehouse_retrieve_params"
+require_relative "delivery_five_post_client/models/api/v1/partners/warehouse_update_params"
+require_relative "delivery_five_post_client/models/api/v1/receiver_location"
+require_relative "delivery_five_post_client/models/api/v1/tariff_c2c_params"
+require_relative "delivery_five_post_client/models/api/v1/tariff_c2c_response"
+require_relative "delivery_five_post_client/models/api/v2/partner_create_return_order_params"
+require_relative "delivery_five_post_client/models/api/v2/partner_create_return_order_response"
+require_relative "delivery_five_post_client/models/api/v2/pickup_point"
+require_relative "delivery_five_post_client/models/api/v2/point_get_c2c_pickup_points_params"
+require_relative "delivery_five_post_client/models/api/v2/point_get_c2c_pickup_points_response"
+require_relative "delivery_five_post_client/models/api/v2/point_get_c2c_placement_points_params"
+require_relative "delivery_five_post_client/models/api/v2/point_get_c2c_placement_points_response"
+require_relative "delivery_five_post_client/models/api/v2/points/sl_get_c2c_delivery_terms_params"
+require_relative "delivery_five_post_client/models/api/v2/points/sl_get_c2c_delivery_terms_response"
+require_relative "delivery_five_post_client/models/api/v3/partners/order_cancel_order_params"
+require_relative "delivery_five_post_client/models/api/v3/partners/order_create_order_params"
+require_relative "delivery_five_post_client/models/mile_type"
+require_relative "delivery_five_post_client/models/webhook_create_cargo_status_params"
+require_relative "delivery_five_post_client/models/webhook_create_order_status_params"
+require_relative "delivery_five_post_client/models"
+require_relative "delivery_five_post_client/resources/api"
+require_relative "delivery_five_post_client/resources/api/v1"
+require_relative "delivery_five_post_client/resources/api/v1/get_label_statuses"
+require_relative "delivery_five_post_client/resources/api/v1/partners"
+require_relative "delivery_five_post_client/resources/api/v1/partners/extend_storage_days"
+require_relative "delivery_five_post_client/resources/api/v1/partners/jwt"
+require_relative "delivery_five_post_client/resources/api/v1/partners/orders"
+require_relative "delivery_five_post_client/resources/api/v1/partners/orders/cargo"
+require_relative "delivery_five_post_client/resources/api/v1/partners/partner_supply"
+require_relative "delivery_five_post_client/resources/api/v1/partners/redirection"
+require_relative "delivery_five_post_client/resources/api/v1/partners/return_"
+require_relative "delivery_five_post_client/resources/api/v1/partners/tasks"
+require_relative "delivery_five_post_client/resources/api/v1/partners/tasks/report"
+require_relative "delivery_five_post_client/resources/api/v1/partners/tasks/report/avds"
+require_relative "delivery_five_post_client/resources/api/v1/partners/warehouse"
+require_relative "delivery_five_post_client/resources/api/v1/tariff"
+require_relative "delivery_five_post_client/resources/api/v2"
+require_relative "delivery_five_post_client/resources/api/v2/partners"
+require_relative "delivery_five_post_client/resources/api/v2/points"
+require_relative "delivery_five_post_client/resources/api/v2/points/sl"
+require_relative "delivery_five_post_client/resources/api/v3"
+require_relative "delivery_five_post_client/resources/api/v3/partners"
+require_relative "delivery_five_post_client/resources/api/v3/partners/orders"
+require_relative "delivery_five_post_client/resources/webhooks"

data/manifest.yaml

@@ -0,0 +1,17 @@
+dependencies:
+  - English
+  - base64
+  - cgi
+  - date
+  - erb
+  - etc
+  - json
+  - net/http
+  - openssl
+  - pathname
+  - rbconfig
+  - securerandom
+  - set
+  - stringio
+  - time
+  - uri

data/rbi/delivery_five_post_client/client.rbi

@@ -0,0 +1,70 @@
+# typed: strong
+
+module DeliveryFivePostClient
+  class Client < DeliveryFivePostClient::Internal::Transport::BaseClient
+    DEFAULT_MAX_RETRIES = 2
+
+    DEFAULT_TIMEOUT_IN_SECONDS = T.let(60.0, Float)
+
+    DEFAULT_INITIAL_RETRY_DELAY = T.let(0.5, Float)
+
+    DEFAULT_MAX_RETRY_DELAY = T.let(8.0, Float)
+
+    ENVIRONMENTS =
+      T.let(
+        {
+          production: "https://api-preprod-omni.x5.ru",
+          environment_1: "https://api-omni.x5.ru"
+        },
+        T::Hash[Symbol, String]
+      )
+
+    sig { returns(String) }
+    attr_reader :api_key
+
+    sig { returns(DeliveryFivePostClient::Resources::API) }
+    attr_reader :api
+
+    sig { returns(DeliveryFivePostClient::Resources::Webhooks) }
+    attr_reader :webhooks
+
+    # @api private
+    sig { override.returns(T::Hash[String, String]) }
+    private def auth_headers
+    end
+
+    # Creates and returns a new client for interacting with the API.
+    sig do
+      params(
+        api_key: T.nilable(String),
+        environment: T.nilable(T.any(Symbol, String)),
+        base_url: T.nilable(String),
+        max_retries: Integer,
+        timeout: Float,
+        initial_retry_delay: Float,
+        max_retry_delay: Float
+      ).returns(T.attached_class)
+    end
+    def self.new(
+      # Defaults to `ENV["DELIVERY_FIVE_POST_CLIENT_API_KEY"]`
+      api_key: ENV["DELIVERY_FIVE_POST_CLIENT_API_KEY"],
+      # Specifies the environment to use for the API.
+      #
+      # Each environment maps to a different base URL:
+      #
+      # - `production` corresponds to `https://api-preprod-omni.x5.ru`
+      # - `environment_1` corresponds to `https://api-omni.x5.ru`
+      environment: nil,
+      # Override the default base URL for the API, e.g.,
+      # `"https://api.example.com/v2/"`. Defaults to
+      # `ENV["DELIVERY_FIVE_POST_CLIENT_BASE_URL"]`
+      base_url: ENV["DELIVERY_FIVE_POST_CLIENT_BASE_URL"],
+      # Max number of retries to attempt after a failed retryable request.
+      max_retries: DeliveryFivePostClient::Client::DEFAULT_MAX_RETRIES,
+      timeout: DeliveryFivePostClient::Client::DEFAULT_TIMEOUT_IN_SECONDS,
+      initial_retry_delay: DeliveryFivePostClient::Client::DEFAULT_INITIAL_RETRY_DELAY,
+      max_retry_delay: DeliveryFivePostClient::Client::DEFAULT_MAX_RETRY_DELAY
+    )
+    end
+  end
+end