newstore-apimatic-sdk 0.0.1

data/lib/new_store_api/controllers/counting_controller.rb

@@ -0,0 +1,134 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # CountingController
+  class CountingController < 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 list of count task line items
+    # @param [UUID | String] task_id Required parameter: Represents a task to
+    # count stock.
+    # @param [Integer] offset Optional parameter: TODO: type description here
+    # @param [Integer] limit Optional parameter: TODO: type description here
+    # @param [String] accept Optional parameter: TODO: type description here
+    # @return [ListCountTaskLineItemsResponse] Response from the API call.
+    def list_count_tasks_line_items(task_id,
+                                    offset: nil,
+                                    limit: nil,
+                                    accept: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/inventory/count-tasks/{task_id}/line-items',
+                                     Server::API)
+                   .template_param(new_parameter(task_id, key: 'task_id')
+                                    .should_encode(true))
+                   .query_param(new_parameter(offset, key: 'offset'))
+                   .query_param(new_parameter(limit, key: 'limit'))
+                   .header_param(new_parameter(accept, key: 'accept'))
+                   .auth(Single.new('oauth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ListCountTaskLineItemsResponse.method(:from_hash)))
+        .execute
+    end
+
+    # Returns list of zones where a product was scanned.
+    # @param [UUID | String] task_id Required parameter: Represents a task to
+    # count stock.
+    # @param [String] product_id Required parameter: Represents a product id
+    # @return [ListProductZonesResponse] Response from the API call.
+    def list_product_zones(task_id,
+                           product_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/inventory/count-tasks/{task_id}/products/{product_id}',
+                                     Server::API)
+                   .template_param(new_parameter(task_id, key: 'task_id')
+                                    .should_encode(true))
+                   .template_param(new_parameter(product_id, key: 'product_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(ListProductZonesResponse.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 list of zones for a count task
+    # @param [UUID | String] task_id Required parameter: Represents a task to
+    # count stock.
+    # @param [String] accept Optional parameter: TODO: type description here
+    # @return [ListZonesResponse] Response from the API call.
+    def list_zones(task_id,
+                   accept: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/inventory/count-tasks/{task_id}/zones',
+                                     Server::API)
+                   .template_param(new_parameter(task_id, key: 'task_id')
+                                    .should_encode(true))
+                   .header_param(new_parameter(accept, key: 'accept'))
+                   .auth(Single.new('oauth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ListZonesResponse.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 [String] zone_code Required parameter: Represents the zone where
+    # stock was counted.
+    # @param [UUID | String] task_id Required parameter: Represents a task to
+    # count stock.
+    # @param [CompleteZoneRequest] body Required parameter: TODO: type
+    # description here
+    # @return [void] Response from the API call.
+    def replace_count_task_zone(zone_code,
+                                task_id,
+                                body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/inventory/count-tasks/{task_id}/zones/{zone_code}',
+                                     Server::API)
+                   .template_param(new_parameter(zone_code, key: 'zone_code')
+                                    .should_encode(true))
+                   .template_param(new_parameter(task_id, key: 'task_id')
+                                    .should_encode(true))
+                   .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/customer_configuration_controller.rb

@@ -0,0 +1,47 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # CustomerConfigurationController
+  class CustomerConfigurationController < BaseController
+    # Returns configuration settings for the tenant, including BYO CRM settings.
+    # @return [ConfigurationResponse] Response from the API call.
+    def show_configuration
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/customer/config',
+                                     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(ConfigurationResponse.method(:from_hash)))
+        .execute
+    end
+
+    # Updates configuration settings for the tenant, including BYO CRM settings.
+    # Note that the following restrictions exist:
+    # - BYO CRM and `nom_consumer_profiles_merge` can't be enabled at the same
+    # time.
+    # @param [ConfigurationRequest] body Required parameter: Configuration
+    # settings to update
+    # @return [ConfigurationResponse] Response from the API call.
+    def update_configuration(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PATCH,
+                                     '/customer/config',
+                                     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(ConfigurationResponse.method(:from_hash)))
+        .execute
+    end
+  end
+end

data/lib/new_store_api/controllers/customer_profile_controller.rb

@@ -0,0 +1,195 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # CustomerProfileController
+  class CustomerProfileController < BaseController
+    # **Warning: This endpoint is currently only available for non-pii
+    # tenants.**
+    # Retrieves a mapping of existing customer profiles given a list of profile
+    # emails.
+    # Any emails provided that are not associated with a Customer Profile, will
+    # not be part of the mapping returned.
+    # **Notes:**
+    # For profiles created before Jan 6th 2022 there is no uniqueness guarantee
+    # for the email. This means that for some tenants the mapping returned
+    # from this endpoint may be a bigger set than the emails requested.
+    # @param [RetrieveBulkEmailLookupRequest] body Required parameter: TODO:
+    # type description here
+    # @return [RetrieveBulkEmailLookupResponse] Response from the API call.
+    def create_retrieval_bulk_email_profiles(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/customer/profiles/lookup-bulk-emails',
+                                     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(RetrieveBulkEmailLookupResponse.method(:from_hash)))
+        .execute
+    end
+
+    # Returns a searchable list of consumer profiles.
+    # Note: This endpoint is designed for paginated front-end use with a search
+    # function. It is not suitable for exporting a comprehensive list of all
+    # customers due to the following limitations:
+    # - Pagination Per Page Limit: Up to 500 profiles can be fetched per page.
+    # - Total Profiles Limit: There is a maximum limit of 10,000 profiles.
+    # - API Error Beyond Limit: When trying to paginate beyond 10,000 profiles,
+    # the API will start returning errors.
+    # @param [String] q Optional parameter: The search term to filter customers.
+    # The term is compared to the values in the `email`, `fullname` and
+    # `phonenumber` fields. A partial match is also considered a match.  The
+    # term will also be compared to the values in the `id` and `display_id`
+    # fields. Only an exact match is considered a match.
+    # @param [String] sort Optional parameter: The sort to be applied to
+    # customers response.
+    # @param [Integer] offset Optional parameter: The customer profiles page
+    # offset.
+    # @param [Integer] count Optional parameter: The number of requested
+    # customer profiles.
+    # @return [ListProfilesResponse] Response from the API call.
+    def list_profiles(q: nil,
+                      sort: nil,
+                      offset: 0,
+                      count: 10)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/customer/profiles',
+                                     Server::API)
+                   .query_param(new_parameter(q, key: 'q'))
+                   .query_param(new_parameter(sort, key: 'sort'))
+                   .query_param(new_parameter(offset, key: 'offset'))
+                   .query_param(new_parameter(count, key: 'count'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('oauth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ListProfilesResponse.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>
+    # Get-or-create by email. Creates a new customer profile, or, if a profile
+    # already exists for the given email, returns that existing profile
+    # unchanged. It does NOT update an existing profile — use the update
+    # endpoint (`PATCH /profiles/{profile_id}`) to change fields on an existing
+    # profile.
+    # KNOWN LIMITATION: on success this endpoint always responds `201 Created`,
+    # even when it returned a pre-existing profile instead of creating one. The
+    # status code therefore cannot be used to tell a create apart from a get;
+    # if you need to distinguish them, compare the returned profile's
+    # `created_at` and `updated_at`. Neither a `200` nor a `409` is returned by
+    # this endpoint.
+    # **Note:**
+    # The Consumer Profile V2 API allows for a single approach to create
+    # customer names. When creating a profile, the client must choose one of the
+    # following name approaches:
+    # - first_name and last_name
+    # - full_name
+    # Providing both approaches will result in a bad request error from the API.
+    # @param [CreateProfileRequest] body Required parameter: Request payload
+    # @return [ProfileResponse] Response from the API call.
+    def create_or_show_profile(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/customer/profiles',
+                                     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(ProfileResponse.method(:from_hash)))
+        .execute
+    end
+
+    # Returns a single customer profile for the given customer `profile_id`.
+    # @param [String] profile_id Required parameter: Profile ID
+    # @return [ProfileResponse] Response from the API call.
+    def show_profile(profile_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/customer/profiles/{profile_id}',
+                                     Server::API)
+                   .template_param(new_parameter(profile_id, key: 'profile_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(ProfileResponse.method(:from_hash)))
+        .execute
+    end
+
+    # Updates an existing customer profile for the given `profile_id`.
+    # **Note:**
+    # The Consumer Profile V2 API allows for a single approach to update
+    # customer names. When updating a profile, the client must choose one of the
+    # following name approaches:
+    # - first_name and last_name
+    # - full_name
+    # Providing both approaches will result in a bad request error from the API.
+    # **Note:**
+    # If `extended_attributes` is provided, it will replace any existing
+    # attributes for the customer.
+    # @param [String] profile_id Required parameter: Profile ID
+    # @param [UpdateProfileRequest] body Required parameter: Request payload
+    # @return [ProfileResponse] Response from the API call.
+    def update_profile(profile_id,
+                       body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PATCH,
+                                     '/customer/profiles/{profile_id}',
+                                     Server::API)
+                   .template_param(new_parameter(profile_id, key: 'profile_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(ProfileResponse.method(:from_hash)))
+        .execute
+    end
+
+    # Creates request for customer profile deletion.
+    # @param [String] profile_id Required parameter: Profile ID
+    # @param [ProfileDeletionRequest] body Required parameter: Request payload
+    # @return [void] Response from the API call.
+    def create_profile_deletion_request(profile_id,
+                                        body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/customer/profiles/{profile_id}',
+                                     Server::API)
+                   .template_param(new_parameter(profile_id, key: 'profile_id')
+                                    .should_encode(true))
+                   .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/data_controller.rb

@@ -0,0 +1,61 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # DataController
+  class DataController < BaseController
+    # Stores a new PII data entry in a residency compliant way.
+    # @param [CreateDataRequest] body Required parameter: The data entry to
+    # store
+    # @return [CreateDataResponse] Response from the API call.
+    def create_data(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/customer/data',
+                                     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(CreateDataResponse.method(:from_hash)))
+        .execute
+    end
+
+    # Deletes data entry for the given `data_id`.
+    # @param [String] data_id Required parameter: Data ID
+    # @return [void] Response from the API call.
+    def destroy_data(data_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/customer/data/{data_id}',
+                                     Server::API)
+                   .template_param(new_parameter(data_id, key: 'data_id')
+                                    .should_encode(true))
+                   .auth(Single.new('oauth')))
+        .response(new_response_handler
+                    .is_response_void(true))
+        .execute
+    end
+
+    # Returns data for the given `data_id`, depending on the defined
+    # content-type.
+    # @param [String] data_id Required parameter: Data ID
+    # @return [Binary] Response from the API call.
+    def show_data(data_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/customer/data/{data_id}',
+                                     Server::API)
+                   .template_param(new_parameter(data_id, key: 'data_id')
+                                    .should_encode(true))
+                   .auth(Single.new('oauth')))
+        .response(new_response_handler)
+        .execute
+    end
+  end
+end

data/lib/new_store_api/controllers/datasets_controller.rb

@@ -0,0 +1,64 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # DatasetsController
+  class DatasetsController < 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>
+    # List all available datasets
+    # @param [String] x_new_store_tenant Required parameter: Tenant identifier
+    # @return [Object] Response from the API call.
+    def list_datasets(x_new_store_tenant)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/data-exports/datasets',
+                                     Server::API)
+                   .header_param(new_parameter(x_new_store_tenant, key: 'X-NewStore-Tenant'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('oauth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:json_deserialize)))
+        .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>
+    # Get details of a specific dataset
+    # @param [String] dataset_id Required parameter: The unique identifier of
+    # the dataset
+    # @param [String] x_new_store_tenant Required parameter: Tenant identifier
+    # @return [Object] Response from the API call.
+    def show_dataset(dataset_id,
+                     x_new_store_tenant)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/data-exports/datasets/{dataset_id}',
+                                     Server::API)
+                   .template_param(new_parameter(dataset_id, key: 'dataset_id')
+                                    .should_encode(true))
+                   .header_param(new_parameter(x_new_store_tenant, key: 'X-NewStore-Tenant'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('oauth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:json_deserialize)))
+        .execute
+    end
+  end
+end

data/lib/new_store_api/controllers/device_notifications_controller.rb

@@ -0,0 +1,38 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # DeviceNotificationsController
+  class DeviceNotificationsController < 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>
+    # Creates a notification for push notifications
+    # @param [NotificationRequest] body Optional parameter: TODO: type
+    # description here
+    # @return [NotificationResponse] Response from the API call.
+    def create_notification(body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/retail-org/devices/notifications',
+                                     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(NotificationResponse.method(:from_hash)))
+        .execute
+    end
+  end
+end

data/lib/new_store_api/controllers/device_registrations_controller.rb

@@ -0,0 +1,38 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # DeviceRegistrationsController
+  class DeviceRegistrationsController < 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>
+    # Creates a registration for push notifications
+    # @param [RegistrationRequest] body Optional parameter: TODO: type
+    # description here
+    # @return [RegistrationResponse] Response from the API call.
+    def create_registration(body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/retail-org/devices/registrations',
+                                     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(RegistrationResponse.method(:from_hash)))
+        .execute
+    end
+  end
+end

data/lib/new_store_api/controllers/device_subscriptions_controller.rb

@@ -0,0 +1,84 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # DeviceSubscriptionsController
+  class DeviceSubscriptionsController < 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>
+    # Delete subscriptions for push notifications
+    # @return [void] Response from the API call.
+    def destroy_subscription
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/retail-org/devices/subscriptions',
+                                     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>
+    # Reads subscriptions for push notifications
+    # @return [SubscriptionsResponse] Response from the API call.
+    def list_subscriptions
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/retail-org/devices/subscriptions',
+                                     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(SubscriptionsResponse.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 subscription for push notifications
+    # @param [SubscriptionRequest] body Optional parameter: TODO: type
+    # description here
+    # @return [SubscriptionResponse] Response from the API call.
+    def create_subscription(body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/retail-org/devices/subscriptions',
+                                     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(SubscriptionResponse.method(:from_hash)))
+        .execute
+    end
+  end
+end