newstore-apimatic-sdk 0.0.1

data/lib/new_store_api/controllers/segmentation_controller.rb

@@ -0,0 +1,485 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # SegmentationController
+  class SegmentationController < 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>
+    # Returns a list of segmentation imports.
+    # @return [ListImportsResponse] Response from the API call.
+    def list_imports
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/customer/imports',
+                                     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(ListImportsResponse.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>
+    # Creates a new segmentation import from an S3 URI CSV.
+    # @param [CreateImportRequest] body Required parameter: TODO: type
+    # description here
+    # @return [ImportResponse] Response from the API call.
+    def create_import(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/customer/imports',
+                                     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(ImportResponse.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>
+    # Deletes the segmentation import and all associated tags for the given
+    # `import_id`.
+    # @param [String] import_id Required parameter: TODO: type description
+    # here
+    # @return [void] Response from the API call.
+    def destroy_import(import_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/customer/imports/{import_id}',
+                                     Server::API)
+                   .template_param(new_parameter(import_id, key: 'import_id')
+                                    .should_encode(true))
+                   .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>
+    # Returns a single segmentation import for the given `import_id`.
+    # @param [String] import_id Required parameter: TODO: type description
+    # here
+    # @return [ImportResponse] Response from the API call.
+    def show_import(import_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/customer/imports/{import_id}',
+                                     Server::API)
+                   .template_param(new_parameter(import_id, key: 'import_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(ImportResponse.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>
+    # Updates an existing segmentation import.
+    # @param [String] import_id Required parameter: TODO: type description
+    # here
+    # @param [PatchImportRequest] body Required parameter: TODO: type
+    # description here
+    # @return [ImportResponse] Response from the API call.
+    def update_import(import_id,
+                      body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PATCH,
+                                     '/customer/imports/{import_id}',
+                                     Server::API)
+                   .template_param(new_parameter(import_id, key: 'import_id')
+                                    .should_encode(true))
+                   .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(ImportResponse.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>
+    # Lists tags for a given import
+    # @param [String] import_id Required parameter: TODO: type description
+    # here
+    # @param [Integer] limit Optional parameter: The number of requested tags.
+    # @param [Integer] offset Optional parameter: The tags page offset.
+    # @param [OrderByEnum] order_by Optional parameter: The field used to order
+    # the results.
+    # @param [TrueClass | FalseClass] desc Optional parameter: The direction of
+    # the ordering.
+    # @return [ListImportTags] Response from the API call.
+    def list_import_tags(import_id,
+                         limit: 10,
+                         offset: 0,
+                         order_by: nil,
+                         desc: false)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/customer/imports/{import_id}/tags',
+                                     Server::API)
+                   .template_param(new_parameter(import_id, key: 'import_id')
+                                    .should_encode(true))
+                   .query_param(new_parameter(limit, key: 'limit'))
+                   .query_param(new_parameter(offset, key: 'offset'))
+                   .query_param(new_parameter(order_by, key: 'order_by'))
+                   .query_param(new_parameter(desc, key: 'desc'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('oauth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ListImportTags.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>
+    # Generates a presigned URL that will allow the upload of a CSV file to be
+    # used in an import.
+    # @param [PresignedUrlRequest] body Required parameter: TODO: type
+    # description here
+    # @return [PresignedUrlResponse] Response from the API call.
+    def create_presigned_url(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/customer/imports/presigned-urls',
+                                     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(PresignedUrlResponse.method(:from_hash)))
+        .execute
+    end
+
+    # Returns a list of segmentation tags associated to the given `profile_id`.
+    # @param [String] profile_id Required parameter: Profile ID
+    # @param [Integer] limit Optional parameter: The number of requested
+    # customer profiles.
+    # @param [Integer] offset Optional parameter: The customer profiles page
+    # offset.
+    # @param [OrderBy1Enum] order_by Optional parameter: The field used to order
+    # the results. Ascending order will be applied for the field provided.
+    # @return [ListTagsResponse] Response from the API call.
+    def list_profile_tags(profile_id,
+                          limit: 10,
+                          offset: 0,
+                          order_by: OrderBy1Enum::UPDATED_AT)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/customer/profiles/{profile_id}/tags',
+                                     Server::API)
+                   .template_param(new_parameter(profile_id, key: 'profile_id')
+                                    .should_encode(true))
+                   .query_param(new_parameter(limit, key: 'limit'))
+                   .query_param(new_parameter(offset, key: 'offset'))
+                   .query_param(new_parameter(order_by, key: 'order_by'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('oauth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ListTagsResponse.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>
+    # Returns a list of segmentation tags.
+    # @param [Integer] limit Optional parameter: The number of requested tags.
+    # @param [Integer] offset Optional parameter: The tags page offset.
+    # @param [OrderBy1Enum] order_by Optional parameter: The field used to order
+    # the results. Ascending order will be applied for the field provided.
+    # @param [String] store_id Optional parameter: To filter the tags based on
+    # the store ID. The response will return only store specific tags.
+    # @param [String] is_import_enabled Optional parameter: Returns all the tags
+    # that have associated imports that are enabled for a store. A store_id must
+    # be provided. The offset and limit fields must not be present. The entire
+    # data is returned.
+    # @return [ListTagsResponse] Response from the API call.
+    def list_tags(limit: 10,
+                  offset: 0,
+                  order_by: OrderBy1Enum::UPDATED_AT,
+                  store_id: nil,
+                  is_import_enabled: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/customer/tags',
+                                     Server::API)
+                   .query_param(new_parameter(limit, key: 'limit'))
+                   .query_param(new_parameter(offset, key: 'offset'))
+                   .query_param(new_parameter(order_by, key: 'order_by'))
+                   .query_param(new_parameter(store_id, key: 'store_id'))
+                   .query_param(new_parameter(is_import_enabled, key: 'is_import_enabled'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('oauth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ListTagsResponse.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>
+    # Creates a new segmentation tag.
+    # @param [CreateTagRequest] body Required parameter: TODO: type description
+    # here
+    # @return [TagResponse] Response from the API call.
+    def create_tag(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/customer/tags',
+                                     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(TagResponse.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>
+    # Deletes data entry for the given `tag_id`.
+    # @param [String] tag_id Required parameter: TODO: type description here
+    # @return [void] Response from the API call.
+    def destroy_tag(tag_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/customer/tags/{tag_id}',
+                                     Server::API)
+                   .template_param(new_parameter(tag_id, key: 'tag_id')
+                                    .should_encode(true))
+                   .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>
+    # Returns a single segmentation tag for the given customer `tag_id`.
+    # @param [String] tag_id Required parameter: TODO: type description here
+    # @return [TagResponse] Response from the API call.
+    def show_tag(tag_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/customer/tags/{tag_id}',
+                                     Server::API)
+                   .template_param(new_parameter(tag_id, key: 'tag_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(TagResponse.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>
+    # Updates an existing segmentation tag for the given `tag_id`.
+    # @param [String] tag_id Required parameter: TODO: type description here
+    # @param [UpdateTagRequest] body Required parameter: TODO: type description
+    # here
+    # @return [TagResponse] Response from the API call.
+    def update_tag(tag_id,
+                   body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PATCH,
+                                     '/customer/tags/{tag_id}',
+                                     Server::API)
+                   .template_param(new_parameter(tag_id, key: 'tag_id')
+                                    .should_encode(true))
+                   .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(TagResponse.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>
+    # Returns a list of profiles associated to the given `tag_id`.
+    # @param [Array[String]] tag_id Required parameter: TODO: type description
+    # here
+    # @param [Integer] limit Optional parameter: The number of requested
+    # customer profiles.
+    # @param [Integer] offset Optional parameter: The customer profiles page
+    # offset.
+    # @return [ListTagProfilesResponse] Response from the API call.
+    def list_tag_profiles(tag_id,
+                          limit: 10,
+                          offset: 0)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/customer/tags/{tag_id}/profiles',
+                                     Server::API)
+                   .template_param(new_parameter(tag_id, key: 'tag_id')
+                                    .should_encode(true))
+                   .query_param(new_parameter(limit, key: 'limit'))
+                   .query_param(new_parameter(offset, key: 'offset'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('oauth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ListTagProfilesResponse.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>
+    # There are two possible operations:
+    # - **assign**
+    #   - Assigns the tag with `tag_id` to the provided list of profiles.
+    # - **unassign**
+    #   - Unassigns a list of profiles from the tag with `tag_id`.
+    # @param [String] tag_id Required parameter: TODO: type description here
+    # @param [OperationTagsRequest] body Required parameter: TODO: type
+    # description here
+    # @param [OperationEnum] operation Optional parameter: The segmentation tag
+    # operation that will be performed. By default it's **assign**.
+    # @return [void] Response from the API call.
+    def create_segmentation_tags_operations(tag_id,
+                                            body,
+                                            operation: OperationEnum::ASSIGN)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/customer/tags/{tag_id}/profiles',
+                                     Server::API)
+                   .template_param(new_parameter(tag_id, key: 'tag_id')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .query_param(new_parameter(operation, key: 'operation'))
+                   .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/settings_controller.rb

@@ -0,0 +1,165 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # SettingsController
+  class SettingsController < 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>
+    # Returns the current status of an asynchronous write operation.
+    # @param [UUID | String] operation_id Required parameter: The operation
+    # identifier returned by a write request.
+    # @return [OperationResponse] Response from the API call.
+    def show_platform_operation(operation_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/retail-org/operations/{operationId}',
+                                     Server::API)
+                   .template_param(new_parameter(operation_id, key: 'operationId')
+                                    .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(OperationResponse.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>
+    # Returns the current global-scoped settings for the tenant, aggregated
+    # across all active config declarations.
+    # @return [SettingsResponse] Response from the API call.
+    def show_global_platform_settings
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/retail-org/settings',
+                                     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(SettingsResponse.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>
+    # Submits a partial update to global-scoped settings. The write is validated
+    # and executed asynchronously. Returns 202 with an operation ID on success.
+    # @param [Object] body Required parameter: Partial settings update keyed by
+    # declaration key.
+    # @param [String] if_match Optional parameter: Version string from a
+    # previous read (e.g. "v42"). If provided, the write is rejected with 409 if
+    # the current version does not match.
+    # @return [WriteAccepted] Response from the API call.
+    def update_global_platform_settings(body,
+                                        if_match: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PATCH,
+                                     '/retail-org/settings',
+                                     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(APIHelper.method(:json_serialize))
+                   .auth(Single.new('oauth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(WriteAccepted.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>
+    # Returns the current store-scoped settings for a specific store, aggregated
+    # across all active config declarations.
+    # @param [String] store_id Required parameter: The store identifier.
+    # @return [SettingsResponse] Response from the API call.
+    def show_store_platform_settings(store_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/retail-org/settings/stores/{storeId}',
+                                     Server::API)
+                   .template_param(new_parameter(store_id, key: 'storeId')
+                                    .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(SettingsResponse.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>
+    # Submits a partial update to store-scoped settings for a specific store.
+    # The write is validated and executed asynchronously. Returns 202 with an
+    # operation ID on success.
+    # @param [String] store_id Required parameter: The store identifier.
+    # @param [Object] body Required parameter: Partial settings update keyed by
+    # declaration key.
+    # @param [String] if_match Optional parameter: Version string from a
+    # previous read (e.g. "v42"). If provided, the write is rejected with 409 if
+    # the current version does not match.
+    # @return [WriteAccepted] Response from the API call.
+    def update_store_platform_settings(store_id,
+                                       body,
+                                       if_match: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PATCH,
+                                     '/retail-org/settings/stores/{storeId}',
+                                     Server::API)
+                   .template_param(new_parameter(store_id, key: 'storeId')
+                                    .should_encode(true))
+                   .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(APIHelper.method(:json_serialize))
+                   .auth(Single.new('oauth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(WriteAccepted.method(:from_hash)))
+        .execute
+    end
+  end
+end