newstore-apimatic-sdk 0.0.1

data/lib/new_store_api/controllers/routing_config_controller.rb

@@ -0,0 +1,345 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # RoutingConfigController
+  class RoutingConfigController < BaseController
+    # Retrieves the current configuration to determine if you can update
+    # the status for fulfillment requests that were processed outside of the
+    # NewStore platform,
+    # because of possible issues with fulfillment or shipping status updates.
+    # For more information, see the
+    # [guide](https://docs.newstore.com/docs/monitoring-orders#updating-the-ship
+    # ment-status-for-external-orders).
+    # @return [ExternalFulfillmentSettingsResponse] Response from the API call.
+    def show_external_fulfillment_settings
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v0/config/routing/can_update_ffr_processed_externally',
+                                     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(ExternalFulfillmentSettingsResponse.method(:from_hash)))
+        .execute
+    end
+
+    # Enables the configuration to allow you to update
+    # the status for fulfillment requests that were processed outside of the
+    # NewStore platform,
+    # because of possible issues with fulfillment or shipping status updates.
+    # For more information, see the
+    # [guide](https://docs.newstore.com/docs/monitoring-orders#updating-the-ship
+    # ment-status-for-external-orders).
+    # @param [ExternalFulfillmentSettingsRequest] body Optional parameter: TODO:
+    # type description here
+    # @return [void] Response from the API call.
+    def create_external_fulfillment_settings(body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v0/config/routing/can_update_ffr_processed_externally',
+                                     Server::API)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('oauth')))
+        .response(new_response_handler
+                    .is_response_void(true))
+        .execute
+    end
+
+    # Retrieves the configuration based on which it is determined if orders in
+    # your business are
+    # canceled automatically in case of a conflict.
+    # The configuration also contains the reasons for which orders can be
+    # canceled automatically.
+    # For more information about the properties, see the
+    # [guide](/developers/configuration/config-insuff-inv).
+    # @return [CancellationPolicySettings] Response from the API call.
+    def show_cancellation_policy_settings
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v0/config/routing/cancel_on_conflict',
+                                     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(CancellationPolicySettings.method(:from_hash)))
+        .execute
+    end
+
+    # Sets the configuration based on which it is determined if orders in your
+    # business are
+    # canceled automatically in case of a conflict.
+    # The configuration also contains the reasons for which orders can be
+    # canceled automatically.
+    # For more information about the properties, see the
+    # [guide](/developers/configuration/config-insuff-inv).
+    # @param [CancellationPolicySettings] body Optional parameter: TODO: type
+    # description here
+    # @return [void] Response from the API call.
+    def create_cancellation_policy_settings(body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v0/config/routing/cancel_on_conflict',
+                                     Server::API)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('oauth')))
+        .response(new_response_handler
+                    .is_response_void(true))
+        .execute
+    end
+
+    # Retrieves the current configuration that determines if on hold orders are
+    # routed to
+    # fulfillment locations automatically when stock becomes available in these
+    # locations.
+    # @return [AutomaticReroutingSettings] Response from the API call.
+    def show_automatic_rerouting_setting
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v0/config/routing/enable_automatic_rerouting',
+                                     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(AutomaticReroutingSettings.method(:from_hash)))
+        .execute
+    end
+
+    # Sets the configuration that determines if on hold orders are routed to
+    # fulfillment locations automatically when stock becomes available in these
+    # locations.
+    # @param [AutomaticReroutingSettings] body Optional parameter: TODO: type
+    # description here
+    # @return [void] Response from the API call.
+    def create_automatic_rerouting_setting(body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v0/config/routing/enable_automatic_rerouting',
+                                     Server::API)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('oauth')))
+        .response(new_response_handler
+                    .is_response_void(true))
+        .execute
+    end
+
+    # Retrieves the current configuration that determines if orders are routed
+    # to fulfillment locations based on a capacity aware algorithm.
+    # @return [CapacityBasedRoutingSettings] Response from the API call.
+    def show_capacity_based_routing_settings
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v0/config/routing/enable_capacity_based_routing',
+                                     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(CapacityBasedRoutingSettings.method(:from_hash)))
+        .execute
+    end
+
+    # Sets the current configuration that determines if orders are routed to
+    # fulfillment locations based on a capacity aware algorithm.
+    # @param [CapacityBasedRoutingSettings] body Required parameter: TODO: type
+    # description here
+    # @return [void] Response from the API call.
+    def create_capacity_based_routing_settings(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v0/config/routing/enable_capacity_based_routing',
+                                     Server::API)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('oauth')))
+        .response(new_response_handler
+                    .is_response_void(true))
+        .execute
+    end
+
+    # Retrieves the configuration that determines if orders will be
+    # automatically routed to
+    # fulfillment locations where stock has become available, even if these
+    # locations had
+    # rejected the order fulfillment request earlier, due to insufficient stock
+    # at
+    # these locations.
+    # @return [RejectedReroutingSettings] Response from the API call.
+    def show_rejected_rerouting_settings
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v0/config/routing/reroute_to_rejected_fulfillment_nodes',
+                                     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(RejectedReroutingSettings.method(:from_hash)))
+        .execute
+    end
+
+    # Sets the configuration that determines if orders will be automatically
+    # routed to
+    # fulfillment locations where stock has become available, even if these
+    # locations had
+    # rejected the order fulfillment request earlier, due to insufficient stock
+    # at
+    # these locations.
+    # @param [RejectedReroutingSettings] body Optional parameter: TODO: type
+    # description here
+    # @return [void] Response from the API call.
+    def create_rejected_rerouting_settings(body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v0/config/routing/reroute_to_rejected_fulfillment_nodes',
+                                     Server::API)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('oauth')))
+        .response(new_response_handler
+                    .is_response_void(true))
+        .execute
+    end
+
+    # Retrieves the current configuration, which determines if NewStore skips
+    # updating shipping
+    # offers when orders are routed to a warehouse or DC for fulfillment. By
+    # default, this is set to `true`.
+    # We recommend setting this configuration to ``true``.
+    # Please be aware that having this value set to `true` can cause a
+    # fulfillment request routed to DC to have an empty shipping provider field
+    # if the tenant is also configured, skipping soft routing on an order
+    # injection.
+    # @return [ShippingOfferUpdateSettings] Response from the API call.
+    def show_shipping_offer_update_settings
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v0/config/routing/skip_shipping_offer_update_for_dc_orders',
+                                     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(ShippingOfferUpdateSettings.method(:from_hash)))
+        .execute
+    end
+
+    # Sets the configuration that allows NewStore to skip updating shipping
+    # offers when orders
+    # are routed to a warehouse or DC for fulfillment.
+    # We recommend setting this configuration to ``true``.
+    # @param [ShippingOfferUpdateSettings] body Optional parameter: TODO: type
+    # description here
+    # @return [void] Response from the API call.
+    def create_shipping_offer_update_settings(body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v0/config/routing/skip_shipping_offer_update_for_dc_orders',
+                                     Server::API)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('oauth')))
+        .response(new_response_handler
+                    .is_response_void(true))
+        .execute
+    end
+
+    # Specifies if ATP is requested from an external source or from NewStore.
+    # If set to ``true``, NewStore uses ATP from an external availability source
+    # such as
+    # an [external OMS](/product/processes/about-ffment/#external-oms-config).
+    # If not set or set to ``false``, NewStore retrieves ATP based on
+    # the stock on hand) for the products.
+    # @return [ExternalAtpSettings] Response from the API call.
+    def show_external_atp_settings
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v0/config/routing/uses_external_atp',
+                                     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(ExternalAtpSettings.method(:from_hash)))
+        .execute
+    end
+
+    # Specifies if ATP is requested from an external source or from NewStore.
+    # If set to ``true``, NewStore uses ATP from an external availability source
+    # such as
+    # an [external OMS](/product/processes/about-ffment/#external-oms-config).
+    # If not set or set to ``false``, NewStore retrieves ATP based on
+    # the stock on hand for the products.
+    # @param [ExternalAtpSettings] body Optional parameter: TODO: type
+    # description here
+    # @return [void] Response from the API call.
+    def create_external_atp_settings(body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v0/config/routing/uses_external_atp',
+                                     Server::API)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('oauth')))
+        .response(new_response_handler
+                    .is_response_void(true))
+        .execute
+    end
+
+    # List all shipments limits. This method is limited to return a maximum of
+    # 10.000 shipments limits per tenant.
+    # @return [ShipmentLimitsResponse] Response from the API call.
+    def list_shipment_limits
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v0/routing/shipments_limit',
+                                     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(ShipmentLimitsResponse.method(:from_hash)))
+        .execute
+    end
+
+    # Upsert a shipment limit for a (`currency`,`service_level`) pair.
+    # An order will be marked as a conflict if any limit on
+    # `limit_exceeded_when` is reached.
+    # It is not allowed to have two limits with the same `shipment_count_gt`
+    # value.
+    # The  `order_amount_lt` of a given limit should be greater than or equal to
+    # others limits with
+    # smaller `shipment_count_gt`.
+    # @param [ShipmentLimitsRequest] body Required parameter: TODO: type
+    # description here
+    # @return [void] Response from the API call.
+    def create_shipment_limits(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v0/routing/shipments_limit',
+                                     Server::API)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('oauth')))
+        .response(new_response_handler
+                    .is_response_void(true))
+        .execute
+    end
+  end
+end

data/lib/new_store_api/controllers/routing_controller.rb

@@ -0,0 +1,58 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # RoutingController
+  class RoutingController < BaseController
+    # Get insights on routing and shipment details for orders being processed in
+    # the NewStore platform.
+    # This includes details such as:
+    # - Items in the order
+    # - The fulfillment location that is assigned to fulfill orders
+    # - The time when the shipment was dispatched from the fulfillment location
+    # - Order routing strategies
+    # - Service levels
+    # Data is retained up to 45 days for successfully routed order items. Until
+    # order items have been successfully routed, related data is retained
+    # indefinitely.
+    # @param [String] order_id Required parameter: A sales order UUID or
+    # external order ID
+    # @return [RoutingInsights] Response from the API call.
+    def list_order_routing_insights(order_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v0/routing/insights/order/{order_id}',
+                                     Server::API)
+                   .template_param(new_parameter(order_id, key: 'order_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(RoutingInsights.method(:from_hash)))
+        .execute
+    end
+
+    # Generate Routing Options given the following parameters
+    # @param [RoutingOptionsRequest] body Optional parameter: TODO: type
+    # description here
+    # @return [RoutingOptionsResponse] Response from the API call.
+    def create_routing_options(body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v0/routing/options',
+                                     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(RoutingOptionsResponse.method(:from_hash)))
+        .execute
+    end
+  end
+end

data/lib/new_store_api/controllers/routing_ruleset_controller.rb

@@ -0,0 +1,135 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # RoutingRulesetController
+  class RoutingRulesetController < BaseController
+    # Retrieves the current 'Routing Rule V2'. If customer using V1, this
+    # endpoint
+    # maps the V1 configuration to V2 and returns a 200 OK.
+    # @return [RoutingRuleset1] Response from the API call.
+    def show_routing_ruleset
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v0/routing/ruleset',
+                                     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(RoutingRuleset1.method(:from_hash)))
+        .execute
+    end
+
+    # A convenience endpoint is where you use JSON patch to change parts of
+    # routing rules.
+    # **Note:**
+    # - You have the option of defining route entries with a single `country` or
+    # multiple `countries` by
+    # providing the optional `Content-Type` header with your desired payload
+    # version.
+    # - If you'd like to define multiple countries set the Content-Type header
+    # to application/json; version=1.
+    # Select the appropriate Content-Type in the the request schema drop-down to
+    # see the schema for supporting
+    # multiple countries.
+    # - To use payload version 1 via the PATCH operation you need to update the
+    # route entries from `country`
+    # to `countries` via PUT endpoint for compatibility.
+    # @param [String] if_match Optional parameter: Entity tag of the routing
+    # ruleset the client expects to update, as returned in the `ETag` header of
+    # a previous GET response. When provided, the update is applied only if the
+    # current ruleset's entity tag matches, enabling optimistic-concurrency
+    # control.
+    # @param [Array[AddReplaceOrTest | Remove | MoveOrCopy] | nil] body Optional
+    # parameter: TODO: type description here
+    # @return [PutRoutingRulesetResponse] Response from the API call.
+    def update_routing_ruleset(if_match: nil,
+                               body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PATCH,
+                                     '/v0/routing/ruleset',
+                                     Server::API)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .header_param(new_parameter(if_match, key: 'If-Match'))
+                   .body_param(new_parameter(body)
+                                .validator(proc do |value|
+                                  UnionTypeLookUp.get(:FulfillmentConfigJsonPatchRequest)
+                                                 .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(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(PutRoutingRulesetResponse.method(:from_hash)))
+        .execute
+    end
+
+    # This endpoint is used to initially seed the routing rules or to replace it
+    # completely
+    # **Note:**
+    # - You have the option of defining route entries with a single `country` or
+    # multiple `countries` by
+    # providing the optional `Content-Type` header with your desired payload
+    # version.
+    # - If you'd like to define multiple countries set the Content-Type header
+    # to application/json; version=1.
+    # Select the appropriate Content-Type in the the request schema drop-down to
+    # see the schema for supporting
+    # multiple countries.
+    # @param [RoutingRuleset1] body Required parameter: TODO: type description
+    # here
+    # @param [String] if_match Optional parameter: Entity tag of the routing
+    # ruleset the client expects to replace, as returned in the `ETag` header of
+    # a previous GET response. When provided, the replacement is applied only if
+    # the current ruleset's entity tag matches, enabling optimistic-concurrency
+    # control. The header is ignored when no ruleset exists yet (initial
+    # seeding).
+    # @return [PutRoutingRulesetResponse] Response from the API call.
+    def replace_routing_ruleset(body,
+                                if_match: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/v0/routing/ruleset',
+                                     Server::API)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter(if_match, key: 'If-Match'))
+                   .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(PutRoutingRulesetResponse.method(:from_hash)))
+        .execute
+    end
+
+    # Retrieves a section of the current 'Routing Rule V2'. If customer using
+    # V1, this endpoint
+    # is of no use, and will return the error.
+    # @param [SectionEnum] section Required parameter: name of the section to
+    # retrieve
+    # @return [FulfillmentConfigGetRoutingRulesSectionSampleResponse | FulfillmentConfigGetRoutingRulesSectionSampleResponse1 | FulfillmentConfigGetRoutingRulesSectionSampleResponse2 | FulfillmentConfigGetRoutingRulesSectionSampleResponse3] Response from the API call.
+    def show_routing_ruleset_section(section)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v0/routing/ruleset/{section}',
+                                     Server::API)
+                   .template_param(new_parameter(section, key: 'section')
+                                    .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(:FulfillmentConfigGetRoutingRulesSectionSampleResponse4),
+                        response, should_symbolize, true
+                      )
+                    end))
+        .execute
+    end
+  end
+end

data/lib/new_store_api/controllers/sales_goals_management_controller.rb

@@ -0,0 +1,51 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # SalesGoalsManagementController
+  class SalesGoalsManagementController < 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>
+    # @return [void] Response from the API call.
+    def show_sales_goal_file
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/insights/sales-goals',
+                                     Server::API)
+                   .auth(Single.new('oauth')))
+        .response(new_response_handler
+                    .is_response_void(true))
+        .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 [void] Response from the API call.
+    def replace_sales_goal_file
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/insights/sales-goals',
+                                     Server::API)
+                   .auth(Single.new('oauth')))
+        .response(new_response_handler
+                    .is_response_void(true))
+        .execute
+    end
+  end
+end