newstore-apimatic-sdk 0.0.1

data/lib/new_store_api/controllers/tenant_config_controller.rb

@@ -0,0 +1,68 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # TenantConfigController
+  class TenantConfigController < BaseController
+    # Get fiscal configuration of the tenant.
+    # @param [Float] version Optional parameter: Configuration version number. *
+    # If left empty, the latest version of the configuration will be returned.
+    # @param [TrueClass | FalseClass] include_metadata Optional parameter:
+    # Include metadata fields.
+    # @return [TenantConfigV1Dto] Response from the API call.
+    def show_tenant_config(version: nil,
+                           include_metadata: false)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/config',
+                                     Server::API)
+                   .query_param(new_parameter(version, key: 'version'))
+                   .query_param(new_parameter(include_metadata, key: 'include_metadata'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('oauth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(TenantConfigV1Dto.method(:from_hash)))
+        .execute
+    end
+
+    # Get list of countries supporting offline-mode for the tenant.
+    # @return [OfflineCountriesResponseV1Dto] Response from the API call.
+    def show_tenant_offline_mode_config
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/config/offline-mode',
+                                     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(OfflineCountriesResponseV1Dto.method(:from_hash)))
+        .execute
+    end
+
+    # Update list of countries supporting offline-mode for the tenant.
+    # * Only editable countries are allowed.
+    # * List of editable countries can be retireved through `GET /f11n/config`.
+    # @param [OfflineCountriesUpdateRequestV1Dto] body Required parameter: TODO:
+    # type description here
+    # @return [OfflineCountriesResponseV1Dto] Response from the API call.
+    def update_tenant_offline_mode_config(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PATCH,
+                                     '/config/offline-mode',
+                                     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(OfflineCountriesResponseV1Dto.method(:from_hash)))
+        .execute
+    end
+  end
+end

data/lib/new_store_api/controllers/tenant_tax_configuration_controller.rb

@@ -0,0 +1,69 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # TenantTaxConfigurationController
+  class TenantTaxConfigurationController < BaseController
+    # Get tax calculation configuration of your business.
+    # @param [Integer] version Optional parameter: Specific configuration
+    # version number to fetch. If left empty, the latest version of the
+    # configuration will be returned.
+    # @return [TenantConfigDto] Response from the API call.
+    def show_tenant_config(version: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/taxes/config',
+                                     Server::API)
+                   .query_param(new_parameter(version, key: 'version'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('oauth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(TenantConfigDto.method(:from_hash)))
+        .execute
+    end
+
+    # Partially update the tax configuration of your business by merging the
+    # given fields with the existing fields.
+    # @param [TenantConfigUpdateDto] body Required parameter: TODO: type
+    # description here
+    # @return [TenantConfigDto] Response from the API call.
+    def update_tenant_config(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PATCH,
+                                     '/taxes/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(TenantConfigDto.method(:from_hash)))
+        .execute
+    end
+
+    # Create tax calculation configuration for your business.
+    # @param [TenantConfigCreateDto] body Required parameter: TODO: type
+    # description here
+    # @return [TenantConfigDto] Response from the API call.
+    def create_tenant_config(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/taxes/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(TenantConfigDto.method(:from_hash)))
+        .execute
+    end
+  end
+end

data/lib/new_store_api/controllers/token_operations_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
+  # TokenOperationsController
+  class TokenOperationsController < 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>
+    # There are two possible operations:
+    # - **tokenize**
+    #   - Tokenizes PII data that is not related to a profile, tokens are only
+    # valid for 30 days.
+    # - **detokenize**
+    #   - Detokenizes a list of tokens for profiles, addresses, or data entries.
+    # @param [TokensRequest] body Required parameter: Token operation request
+    # payload containing the data to tokenize or detokenize
+    # @param [Operation1Enum] operation Optional parameter: The token operation
+    # that will be performed. By default it's **tokenize**.
+    # @return [TokensResponse] Response from the API call.
+    def create_tokens_operations(body,
+                                 operation: Operation1Enum::TOKENIZE)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/customer/tokens',
+                                     Server::API)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .query_param(new_parameter(operation, key: 'operation'))
+                   .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(TokensResponse.method(:from_hash)))
+        .execute
+    end
+  end
+end

data/lib/new_store_api/controllers/tppe_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
+  # TppeController
+  class TppeController < BaseController
+    # Retrieves configuration.
+    # @param [String] section_id Required parameter: TODO: type description
+    # here
+    # @return [IntegrationConfig] Response from the API call.
+    def show_configuration(section_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/promotions/configurations/{section-id}',
+                                     Server::API)
+                   .template_param(new_parameter(section_id, key: 'section-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(IntegrationConfig.method(:from_hash)))
+        .execute
+    end
+
+    # Updates configuration.
+    # @param [String] section_id Required parameter: TODO: type description
+    # here
+    # @param [IntegrationConfig] body Optional parameter: Integration Config
+    # Request
+    # @return [void] Response from the API call.
+    def update_configuration(section_id,
+                             body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PATCH,
+                                     '/promotions/configurations/{section-id}',
+                                     Server::API)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .template_param(new_parameter(section_id, key: 'section-id')
+                                    .should_encode(true))
+                   .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/transferring_controller.rb

@@ -0,0 +1,37 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # TransferringController
+  class TransferringController < 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>
+    # Get the details of a Transfer Transaction.
+    # @param [UUID | String] transfer_id Required parameter: Transfer
+    # Transaction identifier.
+    # @return [GetTransferTransactionResponse] Response from the API call.
+    def show_transfer_transaction(transfer_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/inventory/transfer-transactions/{transfer_id}',
+                                     Server::API)
+                   .template_param(new_parameter(transfer_id, key: 'transfer_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(GetTransferTransactionResponse.method(:from_hash)))
+        .execute
+    end
+  end
+end

data/lib/new_store_api/controllers/users_controller.rb

@@ -0,0 +1,224 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # UsersController
+  class UsersController < 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>
+    # Retrieves the retailer's identity configuration, such as identity
+    # providers.
+    # @return [GetConfigResponse] Response from the API call.
+    def show_config
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/iam/config',
+                                     Server::API)
+                   .header_param(new_parameter('application/json', key: 'accept')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(GetConfigResponse.method(:from_hash)))
+        .execute
+    end
+
+    # Retrieves information and permissions of the user identified by the bearer
+    # token.
+    # @param [ApplicationEnum] application Optional parameter: Filter the users
+    # permission by application.
+    # @return [GetUserinfoResponse] Response from the API call.
+    def show_user_info(application: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/iam/userinfo',
+                                     Server::API)
+                   .query_param(new_parameter(application, key: 'application'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('oauth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(GetUserinfoResponse.method(:from_hash)))
+        .execute
+    end
+
+    # Retrieves all available user accounts for the retailer. Searches if the
+    # query parameter is used.
+    # @param [String] q Optional parameter: Query the resulting list by
+    # first/last name or email address.
+    # @param [String] associate_id Optional parameter: Filter to get user with
+    # the given associate_id.
+    # @param [Integer] offset Optional parameter: The offset to be used for the
+    # resulting user account list.
+    # @param [Integer] count Optional parameter: The number of requested user
+    # accounts.
+    # @param [String] role Optional parameter: The role of the users to filter
+    # by.
+    # @return [GetUsersResponse] Response from the API call.
+    def list_users(q: nil,
+                   associate_id: nil,
+                   offset: 0,
+                   count: 25,
+                   role: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/iam/users',
+                                     Server::API)
+                   .query_param(new_parameter(q, key: 'q'))
+                   .query_param(new_parameter(associate_id, key: 'associate_id'))
+                   .query_param(new_parameter(offset, key: 'offset'))
+                   .query_param(new_parameter(count, key: 'count'))
+                   .query_param(new_parameter(role, key: 'role'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('oauth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(GetUsersResponse.method(:from_hash)))
+        .execute
+    end
+
+    # Creates a new user account.
+    # To assign roles to a new user account, provide the IDs of the relevant
+    # roles in the `roles` property.
+    # To retrieve the role IDs, use the [List roles
+    # method](#operation/ListRoles).
+    # If the `external_directory` property is set to `false`, the user account
+    # is created
+    # in Auth0 as well and an email with password setup instructions is sent.
+    # The user can then use these
+    # credentials to log into NewStore.
+    # **Note:** If the user has no roles assigned, they will be able to log in
+    # to NOM but will not be able to interact
+    # with NOM until you assign roles to the user to allow them to interact with
+    # the various apps. See the
+    # [Create user role](#operation/CreateRole) method.
+    # @param [PostUsersRequest] body Required parameter: TODO: type description
+    # here
+    # @return [User] Response from the API call.
+    def create_user(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/iam/users',
+                                     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(User.method(:from_hash)))
+        .execute
+    end
+
+    # Deletes the user account with the specified ID.
+    # If the `external_directory` property is set to `false`, the user account
+    # will be deleted in Auth0 as well.
+    # If the `external_directory` property is set to `true`, the user account
+    # will not be deleted from the
+    # respective enterprise directory.
+    # @param [String] id Required parameter: user id
+    # @return [void] Response from the API call.
+    def destroy_user(id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/iam/users/{id}',
+                                     Server::API)
+                   .template_param(new_parameter(id, key: 'id')
+                                    .should_encode(true))
+                   .auth(Single.new('oauth')))
+        .response(new_response_handler
+                    .is_response_void(true))
+        .execute
+    end
+
+    # Retrieves the user account with the specified ID.
+    # @param [String] id Required parameter: user id
+    # @return [User] Response from the API call.
+    def show_user(id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/iam/users/{id}',
+                                     Server::API)
+                   .template_param(new_parameter(id, key: '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(User.method(:from_hash)))
+        .execute
+    end
+
+    # Updates the user account with the specified ID.
+    # If the `external_directory` property is changed to `false`, the user
+    # account will be created in
+    # Auth0 as well and an email with password setup instructions will be send.
+    # The user can then use
+    # these credentials to log into NewStore.
+    # **Note:** If the user has no roles assigned, they will be able to log in
+    # to NOM but will not be able to interact
+    # with NOM until you assign roles to the user to allow them to interact with
+    # the various apps. See the
+    # [Create user role](#operation/CreateRole) method..
+    # If the `external_directory` property is changed to `true`, the user
+    # account will be deleted from Auth0.
+    # The user then can login with the enterprise directory credentials.
+    # @param [String] id Required parameter: user id
+    # @param [PutUsersByIdRequest] body Required parameter: TODO: type
+    # description here
+    # @return [User] Response from the API call.
+    def replace_user(id,
+                     body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/iam/users/{id}',
+                                     Server::API)
+                   .template_param(new_parameter(id, key: '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(User.method(:from_hash)))
+        .execute
+    end
+
+    # <div style="background-color: rgba(243, 156, 18, 0.15); border: 1px solid
+    # #f39c12; border-left: 4px solid #f39c12; padding: 12px; margin: 10px 0;
+    # border-radius: 4px; color: #f39c12;">
+    #   <strong>🚧 BETA:</strong> This endpoint is in beta and may change.
+    #   <br />
+    #   See <a href="https://docs.newstore.com/docs/api-lifecycle"
+    # target="_blank" style="color: #f39c12; text-decoration: underline;">API
+    # Lifecycle Documentation</a> for details.
+    # </div>
+    # Retrieves the support access details for the user with the specified ID.
+    # @param [String] id Required parameter: user id
+    # @return [SupportAccessDetails] Response from the API call.
+    def show_user_access_details(id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/iam/users/{id}/support-access-details',
+                                     Server::API)
+                   .template_param(new_parameter(id, key: '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(SupportAccessDetails.method(:from_hash)))
+        .execute
+    end
+  end
+end

data/lib/new_store_api/exceptions/api_exception.rb

@@ -0,0 +1,21 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Class for exceptions when there is a network error, status code error, etc.
+  class APIException < CoreLibrary::ApiException
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} status_code: #{@response_code}, reason: #{@reason}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} status_code: #{@response_code.inspect}, reason: #{@reason.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/exceptions/o_auth_provider_exception.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
+  # OAuth 2 Authorization endpoint exception.
+  class OAuthProviderException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Gets or sets error code.
+    # @return [OAuthProviderErrorEnum]
+    attr_accessor :error
+
+    # Gets or sets human-readable text providing additional information on
+    # error.
+    # Used to assist the client developer in understanding the error that
+    # occurred.
+    # @return [String]
+    attr_accessor :error_description
+
+    # Gets or sets a URI identifying a human-readable web page with information
+    # about the error, used to provide the client developer with additional
+    # information about the error.
+    # @return [String]
+    attr_accessor :error_uri
+
+    # The constructor.
+    # @param [String] reason The reason for raising an exception.
+    # @param [HttpResponse] response The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] hash The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      return nil unless hash
+
+      @error = hash.key?('error') ? hash['error'] : nil
+      @error_description =
+        hash.key?('error_description') ? hash['error_description'] : SKIP
+      @error_uri = hash.key?('error_uri') ? hash['error_uri'] : SKIP
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error: #{@error}, error_description: #{@error_description}, error_uri:"\
+      " #{@error_uri}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error: #{@error.inspect}, error_description: #{@error_description.inspect},"\
+      " error_uri: #{@error_uri.inspect}>"
+    end
+  end
+end