newstore-apimatic-sdk 0.0.1

data/lib/new_store_api/controllers/shipment_configurations_controller.rb

@@ -0,0 +1,136 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # ShipmentConfigurationsController
+  class ShipmentConfigurationsController < BaseController
+    # TODO: type endpoint description here
+    # @param [ConfigurationNameEnum] name Required parameter: TODO: type
+    # description here
+    # @return [UsePrioritizedProviderRates | UseCustomizableProviderRates | SetFixServiceLevelShippingPrice | PackingTimeDuration | CustomizationAdapterConfig | CarriersConfig | AdapterHttpTimeout | FulfillmentNodeCustomsInfo | GenerateStaticOptionForDc] Response from the API call.
+    def show_configuration_by_name(name)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/fulfillment/configurations/shipments/{name}',
+                                     Server::API)
+                   .template_param(new_parameter(name, key: 'name')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('oauth')))
+        .response(new_response_handler
+                    .deserializer(proc do |response, should_symbolize|
+                      APIHelper.deserialize_union_type(
+                        UnionTypeLookUp.get(:ShowConfigurationByNameResponse),
+                        response, should_symbolize, true
+                      )
+                    end)
+                    .deserialize_into(ResponseShowconfigurationbyname.method(:from_hash)))
+        .execute
+    end
+
+    # TODO: type endpoint description here
+    # @param [ConfigurationNameEnum] name Required parameter: TODO: type
+    # description here
+    # @param [UsePrioritizedProviderRates | UseCustomizableProviderRates |
+    # SetFixServiceLevelShippingPrice | PackingTimeDuration |
+    # CustomizationAdapterConfig | CarriersConfig | AdapterHttpTimeout |
+    # FulfillmentNodeCustomsInfo | GenerateStaticOptionForDc] body Required
+    # parameter: TODO: type description here
+    # @return [UsePrioritizedProviderRates | UseCustomizableProviderRates | SetFixServiceLevelShippingPrice | PackingTimeDuration | CustomizationAdapterConfig | CarriersConfig | AdapterHttpTimeout | FulfillmentNodeCustomsInfo | GenerateStaticOptionForDc] Response from the API call.
+    def create_configuration_by_name(name,
+                                     body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/fulfillment/configurations/shipments/{name}',
+                                     Server::API)
+                   .template_param(new_parameter(name, key: 'name')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .validator(proc do |value|
+                                  UnionTypeLookUp.get(:CreateConfigurationByNameBody)
+                                                 .validate(value)
+                                end))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('oauth')))
+        .response(new_response_handler
+                    .deserializer(proc do |response, should_symbolize|
+                      APIHelper.deserialize_union_type(
+                        UnionTypeLookUp.get(:CreateConfigurationByNameResponse),
+                        response, should_symbolize, true
+                      )
+                    end)
+                    .deserialize_into(ResponseCreateconfigurationbyname.method(:from_hash)))
+        .execute
+    end
+
+    # Designed for humans only: check Provider Rates, Service Levels, PRP and
+    # Carriers configurations
+    # @return [Hash[String, Mixed]] Response from the API call.
+    def show_configurations_checks
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/fulfillment/configurations/shipments/checks',
+                                     Server::API)
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('oauth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:dynamic_deserializer)))
+        .execute
+    end
+
+    # <div style="background-color: rgba(243, 156, 18, 0.15); border: 1px solid
+    # #f39c12; border-left: 4px solid #f39c12; padding: 12px; margin: 10px 0;
+    # border-radius: 4px; color: #f39c12;">
+    #   <strong>🚧 BETA:</strong> This endpoint is in beta and may change.
+    #   <br />
+    #   See <a href="https://docs.newstore.com/docs/api-lifecycle"
+    # target="_blank" style="color: #f39c12; text-decoration: underline;">API
+    # Lifecycle Documentation</a> for details.
+    # </div>
+    # @return [ConfigurationFeatureFlags] Response from the API call.
+    def show_configuration_feature_flags
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/fulfillment/configurations/shipments/feature-flags',
+                                     Server::API)
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('oauth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ConfigurationFeatureFlags.method(:from_hash)))
+        .execute
+    end
+
+    # <div style="background-color: rgba(243, 156, 18, 0.15); border: 1px solid
+    # #f39c12; border-left: 4px solid #f39c12; padding: 12px; margin: 10px 0;
+    # border-radius: 4px; color: #f39c12;">
+    #   <strong>🚧 BETA:</strong> This endpoint is in beta and may change.
+    #   <br />
+    #   See <a href="https://docs.newstore.com/docs/api-lifecycle"
+    # target="_blank" style="color: #f39c12; text-decoration: underline;">API
+    # Lifecycle Documentation</a> for details.
+    # </div>
+    # @param [ConfigurationFeatureFlags] body Required parameter: TODO: type
+    # description here
+    # @return [ConfigurationFeatureFlags] Response from the API call.
+    def create_configuration_feature_flags(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/fulfillment/configurations/shipments/feature-flags',
+                                     Server::API)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('oauth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ConfigurationFeatureFlags.method(:from_hash)))
+        .execute
+    end
+  end
+end

data/lib/new_store_api/controllers/shipping_labels_controller.rb

@@ -0,0 +1,30 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # ShippingLabelsController
+  class ShippingLabelsController < BaseController
+    # TODO: type endpoint description here
+    # @param [String] public_key Required parameter: TODO: type description
+    # here
+    # @param [String] x_newstore_tenant Required parameter: TODO: type
+    # description here
+    # @return [Object] Response from the API call.
+    def show_shipping_label(public_key,
+                            x_newstore_tenant)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/fulfillment/shipping-labels/{public_key}',
+                                     Server::API)
+                   .template_param(new_parameter(public_key, key: 'public_key')
+                                    .should_encode(true))
+                   .header_param(new_parameter(x_newstore_tenant, key: 'x-newstore-tenant'))
+                   .header_param(new_parameter('application/json', key: 'accept')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:json_deserialize)))
+        .execute
+    end
+  end
+end

data/lib/new_store_api/controllers/shipping_option_audits_controller.rb

@@ -0,0 +1,54 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # ShippingOptionAuditsController
+  class ShippingOptionAuditsController < BaseController
+    # TODO: type endpoint description here
+    # @param [DateTime] search_from Required parameter: TODO: type description
+    # here
+    # @param [Integer] offset Optional parameter: Example:0
+    # @param [Integer] page_size Optional parameter: Example:15
+    # @param [String] search_key Optional parameter: Example:
+    # @return [AuditsResponse] Response from the API call.
+    def list_shipping_option_audits(search_from,
+                                    offset: 0,
+                                    page_size: 15,
+                                    search_key: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/fulfillment/shipping-audits',
+                                     Server::API)
+                   .query_param(new_parameter(search_from, key: 'search_from'))
+                   .query_param(new_parameter(offset, key: 'offset'))
+                   .query_param(new_parameter(page_size, key: 'page_size'))
+                   .query_param(new_parameter(search_key, key: 'search_key'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('oauth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(AuditsResponse.method(:from_hash)))
+        .execute
+    end
+
+    # TODO: type endpoint description here
+    # @param [String] audit_id Required parameter: TODO: type description here
+    # @return [AuditResponse] Response from the API call.
+    def show_shipping_option_audit(audit_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/fulfillment/shipping-audits/{audit_id}',
+                                     Server::API)
+                   .template_param(new_parameter(audit_id, key: 'audit_id')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('oauth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(AuditResponse.method(:from_hash)))
+        .execute
+    end
+  end
+end

data/lib/new_store_api/controllers/shipping_options_controller.rb

@@ -0,0 +1,185 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # ShippingOptionsController
+  class ShippingOptionsController < BaseController
+    # <div style="background-color: rgba(243, 156, 18, 0.15); border: 1px solid
+    # #f39c12; border-left: 4px solid #f39c12; padding: 12px; margin: 10px 0;
+    # border-radius: 4px; color: #f39c12;">
+    #   <strong>🚧 BETA:</strong> This endpoint is in beta and may change.
+    #   <br />
+    #   See <a href="https://docs.newstore.com/docs/api-lifecycle"
+    # target="_blank" style="color: #f39c12; text-decoration: underline;">API
+    # Lifecycle Documentation</a> for details.
+    # </div>
+    # Estimate shipping costs of all possible Service Levels for a given bag of
+    # products.
+    # ## Goal
+    # This is primarily meant for Endless Aisle orders, where a customer is
+    # waiting in front of a person to
+    # select a shipping offer with an estimate of a price and delivery time.
+    # **This endpoint allows to respond faster than `POST /shipping-options`,
+    # although possibly with less accurate results.**
+    # Then the user/customer can chose the service level of their choice.
+    # ## Requesting some Service Level Rates
+    # Follow the documentation for the request body's schema. In a nutshell, you
+    # only need to provide the
+    # recipient's address, the products to ship along with their metadata
+    # (weight / dimensions / customs / preorder…).
+    # ### Pre-order products
+    # For product that are part of a pre-order, provide both `is_preorder=True`
+    # and its `online_from` date, as shown in the schema.
+    # ## Using the Service Level Rates
+    # The responses provides a list of "service level rates", where each item of
+    # the list match a single service level,
+    # with all requested products dispatched in various fulfillment nodes, and
+    # for different prices.
+    # The **total price and currency of the option** are set in `total_price`
+    # and `total_price_currency` respectively, and should be
+    # the price and currency to show to the user/customer.
+    # Once the user/customer selected a service level, another process must
+    # follow up with generation of a real option (and pricing) to be obtained
+    # from a real carrier.
+    # ### Getting a real Option (and pricing) from a real carrier
+    # Once a user/customer selected their preferred shipping method/cost, you
+    # may generate real options
+    # using **POST /shipping-options** endpoint.
+    # The endpoint is very similar to this one, sharing a large part of its
+    # payload with the addition of the sender address.
+    # You will need to specify the Service Level ID that correspond to the
+    # user/customer's choice.
+    # ## Example
+    # 1. Get Service Level Rates
+    # URL and attributes have been trimmed to keep the example concise, please
+    # refer to the exact request body schema.
+    # ```
+    # $ curl -d '{"products": [...2 products...], "recipient_address":
+    # {"country_code": "US", ...}}' https://.../service-level-rates
+    # {
+    #     "service_level_rates": [
+    #         {
+    #             "service_level_id": "Standard", "total_price": "10.0",
+    # "total_price_currency": "EUR",
+    #             "fulfillment_assignments": [
+    #                 {"location_id": "StoreNYC", "products": [...1/2
+    # product...]},
+    #                 {"location_id": "DC01", "products": [...2/2 product...]}
+    #             ]
+    #         },
+    #         {
+    #             "service_level_id": "Express", "total_price": "35.8",
+    # "total_price_currency": "EUR",
+    #             "fulfillment_assignments": [
+    #                 {"location_id": "StoreNYC", "products": [...1/2
+    # product...]},
+    #                 {"location_id": "DC01", "products": [...2/2 product...]}
+    #             ]
+    #         }
+    #     ]
+    # }
+    # ```
+    # User selects the `Express` service level, as it's more expensive but
+    # faster. You can now proceed to generate
+    # a real options that will be used to create the order in NewStore platform.
+    # You will need to generate one option for each `fulfillment_assignment`, as
+    # it requires both a Service Level **and**
+    # a **Fulfillment Node ID**.
+    # ```
+    # $ curl -d '{"products": [...], "recipient_address": {...},
+    # "service_level": "Express", "location_id": "StoreNYC", ...}'
+    # $ curl -d '{"products": [...], "recipient_address": {...},
+    # "service_level": "Express", "location_id": "DC01", ...}'
+    # ```
+    # Once real options are generated, capture can proceed with those. Use the
+    # `option_id` as replacement of the `shipping_option_token`.
+    # ## Details on Price and Currency selection modes
+    # 
+    #  * `Service Level`: by default, if nothing else is configured, then the
+    # Service Level informs the price.
+    #  * `Provider Rate Customization`: if enabled by tenant and customized
+    # provider rate is set to use custom price.
+    #  * `Carrier`: if a `Provider Rate` matching the Service Level is
+    # configured to set the price of the option.
+    # The price again obliges to different configurations, and the total shown
+    # in those attributes can be different from
+    # the addition of prices of each `fulfillment_assignments`.
+    # ## Corner Cases
+    #  * In case of international shipment, the resulting price might not be
+    # correct depending on the tenant's provider rates priority. This is
+    # documented in the code.
+    #  * Should a `service_level_rate` host a mix of currencies, `total_price`
+    # and `total_price_currency` will be null.
+    # @param [RequestServiceLevelRates] body Required parameter: TODO: type
+    # description here
+    # @return [ResponseServiceLevelRates] Response from the API call.
+    def create_service_level_rates(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/fulfillment/service-level-rates',
+                                     Server::API)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('oauth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ResponseServiceLevelRates.method(:from_hash)))
+        .execute
+    end
+
+    # TODO: type endpoint description here
+    # @param [RequestShippingOption] body Required parameter: TODO: type
+    # description here
+    # @param [String] x_audit_route_id Optional parameter: Example:
+    # @param [String] x_audit_option_id Optional parameter: Example:
+    # @param [String] x_dlv1_offer Optional parameter: Example:
+    # @param [String] x_dlv1_no_prca Optional parameter: Example:
+    # @return [ResponseShippingOption] Response from the API call.
+    def create_shipping_option(body,
+                               x_audit_route_id: nil,
+                               x_audit_option_id: nil,
+                               x_dlv1_offer: nil,
+                               x_dlv1_no_prca: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/fulfillment/shipping-options',
+                                     Server::API)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter(x_audit_route_id, key: 'x-audit-route-id'))
+                   .header_param(new_parameter(x_audit_option_id, key: 'x-audit-option-id'))
+                   .header_param(new_parameter(x_dlv1_offer, key: 'x-dlv1-offer'))
+                   .header_param(new_parameter(x_dlv1_no_prca, key: 'x-dlv1-no-prca'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('oauth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ResponseShippingOption.method(:from_hash)))
+        .execute
+    end
+
+    # TODO: type endpoint description here
+    # @param [UUID | String] option_id Required parameter: TODO: type
+    # description here
+    # @return [ResponseShippingOption] Response from the API call.
+    def show_shipping_option(option_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/fulfillment/shipping-options/{option_id}',
+                                     Server::API)
+                   .template_param(new_parameter(option_id, key: 'option_id')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('oauth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ResponseShippingOption.method(:from_hash)))
+        .execute
+    end
+  end
+end

data/lib/new_store_api/controllers/shortings_controller.rb

@@ -0,0 +1,48 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # ShortingsController
+  class ShortingsController < BaseController
+    # <div style="background-color: rgba(243, 156, 18, 0.15); border: 1px solid
+    # #f39c12; border-left: 4px solid #f39c12; padding: 12px; margin: 10px 0;
+    # border-radius: 4px; color: #f39c12;">
+    #   <strong>🚧 BETA:</strong> This endpoint is in beta and may change.
+    #   <br />
+    #   See <a href="https://docs.newstore.com/docs/api-lifecycle"
+    # target="_blank" style="color: #f39c12; text-decoration: underline;">API
+    # Lifecycle Documentation</a> for details.
+    # </div>
+    # @param [Integer] offset Optional parameter: TODO: type description here
+    # @param [Integer] limit Optional parameter: TODO: type description here
+    # @param [String] from_date Optional parameter: TODO: type description
+    # here
+    # @param [String] to_date Optional parameter: TODO: type description here
+    # @param [ShortingTypeEnum] type Optional parameter: TODO: type description
+    # here
+    # @return [GetShortingsModel] Response from the API call.
+    def list_shortings(offset: nil,
+                       limit: nil,
+                       from_date: nil,
+                       to_date: nil,
+                       type: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/fulfillment/shortings',
+                                     Server::API)
+                   .query_param(new_parameter(offset, key: 'offset'))
+                   .query_param(new_parameter(limit, key: 'limit'))
+                   .query_param(new_parameter(from_date, key: 'from_date'))
+                   .query_param(new_parameter(to_date, key: 'to_date'))
+                   .query_param(new_parameter(type, key: 'type'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('oauth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(GetShortingsModel.method(:from_hash)))
+        .execute
+    end
+  end
+end

data/lib/new_store_api/controllers/simulation_controller.rb

@@ -0,0 +1,43 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # SimulationController
+  class SimulationController < BaseController
+    # <div style="background-color: rgba(243, 156, 18, 0.15); border: 1px solid
+    # #f39c12; border-left: 4px solid #f39c12; padding: 12px; margin: 10px 0;
+    # border-radius: 4px; color: #f39c12;">
+    #   <strong>🚧 BETA:</strong> This endpoint is in beta and may change.
+    #   <br />
+    #   See <a href="https://docs.newstore.com/docs/api-lifecycle"
+    # target="_blank" style="color: #f39c12; text-decoration: underline;">API
+    # Lifecycle Documentation</a> for details.
+    # </div>
+    # Dry-run routing using only the request body (no downstream fetcher HTTP
+    # calls).
+    # @param [RoutingSimulationRequestPayload] body Required parameter: TODO:
+    # type description here
+    # @param [String] user_id Optional parameter: Optional user identifier for
+    # audit logging.
+    # @return [RoutingSimulationResponsePayload] Response from the API call.
+    def create_routing_simulation(body,
+                                  user_id: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/routing/simulations',
+                                     Server::API)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter(user_id, key: 'user-id'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('oauth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(RoutingSimulationResponsePayload.method(:from_hash)))
+        .execute
+    end
+  end
+end

data/lib/new_store_api/controllers/stock_controller.rb

@@ -0,0 +1,139 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # StockController
+  class StockController < BaseController
+    # <div style="background-color: rgba(23, 162, 184, 0.15); border: 1px solid
+    # #17a2b8; border-left: 4px solid #17a2b8; padding: 12px; margin: 10px 0;
+    # border-radius: 4px; color: #17a2b8;">
+    #   <strong>ℹ️ Rate Limit:</strong> This endpoint is rate limited to 90
+    # requests per second.
+    # </div>
+    # Retrieves the allocations and reservations by ATP keys in your business.
+    # @param [String] product_id Required parameter: The product ID of the
+    # item.
+    # @param [String] fulfillment_node_id Required parameter: The fulfillment
+    # node ID of the store/warehouse.
+    # @return [AtpInsightsResponse] Response from the API call.
+    def list_atp_insights(product_id,
+                          fulfillment_node_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v0/stock/insights',
+                                     Server::API)
+                   .query_param(new_parameter(product_id, key: 'product_id'))
+                   .query_param(new_parameter(fulfillment_node_id, key: 'fulfillment_node_id'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('oauth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(AtpInsightsResponse.method(:from_hash)))
+        .execute
+    end
+
+    # <div style="background-color: rgba(243, 156, 18, 0.15); border: 1px solid
+    # #f39c12; border-left: 4px solid #f39c12; padding: 12px; margin: 10px 0;
+    # border-radius: 4px; color: #f39c12;">
+    #   <strong>🚧 BETA:</strong> This endpoint is in beta and may change.
+    #   <br />
+    #   See <a href="https://docs.newstore.com/docs/api-lifecycle"
+    # target="_blank" style="color: #f39c12; text-decoration: underline;">API
+    # Lifecycle Documentation</a> for details.
+    # </div>
+    # Retrieves the atp for the specified product IDs.
+    # **Note**: This API only supports requesting for 2000 items. If more items
+    # need to be requested fetch the next
+    # page. The boolean ``has_more`` and the number ``total_count`` indicates if
+    # there are more pages to be fetched.
+    # @param [StockProductAvailabilityRequest] body Optional parameter: A list
+    # of ATP keys
+    # @return [StockProductAvailabilityResponse] Response from the API call.
+    def create_product_availability_list(body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v0/stock/products/availability',
+                                     Server::API)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('oauth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(StockProductAvailabilityResponse.method(:from_hash)))
+        .execute
+    end
+
+    # Retrieves the count for unallocated items for the specified product ID. In
+    # this request,
+    # the ATP keys are defined as a combination of the same product ID and
+    # different fulfillment locations.
+    # The number of unallocated items returned in the response payload is the
+    # number of
+    # items that are sellable on hand, after removing the number of safety stock
+    # items and
+    # allocations.
+    # **Note**: This API only supports requesting for 2000 items. If more items
+    # need to be requested,
+    # use multiple requests.
+    # @param [String] product_id Optional parameter: The product ID of the
+    # item.
+    # @return [StockUnallocatedItemsResponse] Response from the API call.
+    def list_unallocated_items_by_product_id(product_id: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v0/stock/unallocated_items',
+                                     Server::API)
+                   .query_param(new_parameter(product_id, key: 'product_id'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('oauth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(StockUnallocatedItemsResponse.method(:from_hash)))
+        .execute
+    end
+
+    # <div style="background-color: rgba(243, 156, 18, 0.15); border: 1px solid
+    # #f39c12; border-left: 4px solid #f39c12; padding: 12px; margin: 10px 0;
+    # border-radius: 4px; color: #f39c12;">
+    #   <strong>🚧 BETA:</strong> This endpoint is in beta and may change.
+    #   <br />
+    #   See <a href="https://docs.newstore.com/docs/api-lifecycle"
+    # target="_blank" style="color: #f39c12; text-decoration: underline;">API
+    # Lifecycle Documentation</a> for details.
+    # </div>
+    # Retrieves the count for unallocated items for a specified set of ``ATP
+    # keys``, where
+    # ATP keys are defined as a combination of the product ID and fulfillment
+    # location.
+    # The number of unallocated items returned in the response payload is the
+    # number of
+    # items that are sellable on hand, after removing the number of safety stock
+    # items and
+    # allocations.
+    # **Note**: This API only supports requesting for 2000 items. If more items
+    # need to be requested,
+    # use multiple requests.
+    # @param [StockUnallocatedItemsRequest] body Optional parameter: A list of
+    # ATP keys
+    # @return [StockUnallocatedItemsResponse] Response from the API call.
+    def create_unallocated_items_list(body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v0/stock/unallocated_items',
+                                     Server::API)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('oauth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(StockUnallocatedItemsResponse.method(:from_hash)))
+        .execute
+    end
+  end
+end