newstore-apimatic-sdk 0.0.1

data/lib/new_store_api/controllers/discounts_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
+  # DiscountsController
+  class DiscountsController < 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>
+    # Calculates discounts for cart
+    # @param [Cart] body Optional parameter: TODO: type description here
+    # @return [CartDiscount] Response from the API call.
+    def create_discount(body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/promotions/cart-discounts',
+                                     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(CartDiscount.method(:from_hash)))
+        .execute
+    end
+  end
+end

data/lib/new_store_api/controllers/easypost_adapter_config_controller.rb

@@ -0,0 +1,74 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # EasypostAdapterConfigController
+  class EasypostAdapterConfigController < BaseController
+    # Deletes the shipping configuration of the retailer that is integrated with
+    # the EasyPost adapter.
+    # @return [void] Response from the API call.
+    def destroy_easypost_adapter_config
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/fulfillment/adapters/config',
+                                     Server::API)
+                   .auth(Single.new('oauth')))
+        .response(new_response_handler
+                    .is_response_void(true))
+        .execute
+    end
+
+    # Retrieves the shipping configuration of the retailer that is integrated
+    # with the EasyPost adapter. Credentials are redacted but you can still push
+    # the configuration using the PUT endpoint with the REDACTED value: we will
+    # use the current value. A new value will be validated before saving the
+    # configuration.
+    # @return [EasypostAdapterConfig] Response from the API call.
+    def show_easypost_adapter_config
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/fulfillment/adapters/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(EasypostAdapterConfig.method(:from_hash)))
+        .execute
+    end
+
+    # Creates or updates the shipping configuration of the retailer that is
+    # integrated with the EasyPost adapter. Any current data in the existing
+    # configuration is overwritten using this request.
+    # A few notes on this configuration:
+    # * When an account has a large number of carrier accounts, please do
+    # associate a Fulfillment Node to a Carrier Account. Not doing so will
+    # result in long response time, waste of resources, extra easypost charges
+    # and possibly order injection issues.
+    # * Once the easypost API Key has been set, it is forbidden to change it.
+    # This is to prevent options that were already generated to become
+    # completely invalid in case the api key isn't from the same account. If you
+    # really need to change this key, please open a case in the NewStore Support
+    # Portal and we will discuss the best way to do that.
+    # @param [EasypostAdapterConfig] body Optional parameter: TODO: type
+    # description here
+    # @return [EasypostAdapterConfig] Response from the API call.
+    def replace_easypost_adapter_config(body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/fulfillment/adapters/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(EasypostAdapterConfig.method(:from_hash)))
+        .execute
+    end
+  end
+end

data/lib/new_store_api/controllers/events_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
+  # EventsController
+  class EventsController < 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>
+    # <div style="background-color: rgba(23, 162, 184, 0.15); border: 1px solid
+    # #17a2b8; border-left: 4px solid #17a2b8; padding: 12px; margin: 10px 0;
+    # border-radius: 4px; color: #17a2b8;">
+    #   <strong>ℹ️ Rate Limit:</strong> This endpoint is rate limited to 100
+    # requests per second.
+    # </div>
+    # @param [String] event_name Required parameter: Name of the event to
+    # publish (e.g. order.created).
+    # @param [String] team Required parameter: Publishing team — must be in the
+    # allowlist.
+    # @param [String] service Required parameter: Publishing service name.
+    # @param [String] entity_id Required parameter: ID of the domain entity the
+    # event is about.
+    # @param [String] tenant Required parameter: Tenant identifier.
+    # @param [String] idempotency_key Required parameter: Unique key for
+    # deduplication.
+    # @param [Object] body Required parameter: Event payload — JSON object, max
+    # 40 MiB.
+    # @param [String] correlation_ids Optional parameter: JSON object — accepted
+    # keys: `order_id`, `customer_id`.
+    # @return [Object] Response from the API call.
+    def create_event(event_name,
+                     team,
+                     service,
+                     entity_id,
+                     tenant,
+                     idempotency_key,
+                     body,
+                     correlation_ids: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/event-stream/events/{event_name}',
+                                     Server::API)
+                   .template_param(new_parameter(event_name, key: 'event_name')
+                                    .should_encode(true))
+                   .header_param(new_parameter(team, key: 'Team'))
+                   .header_param(new_parameter(service, key: 'Service'))
+                   .header_param(new_parameter(entity_id, key: 'Entity-Id'))
+                   .header_param(new_parameter(tenant, key: 'Tenant'))
+                   .header_param(new_parameter(idempotency_key, key: 'Idempotency-Key'))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter(correlation_ids, key: 'Correlation-Ids'))
+                   .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(:json_deserialize)))
+        .execute
+    end
+  end
+end

data/lib/new_store_api/controllers/extensions_controller.rb

@@ -0,0 +1,144 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # ExtensionsController
+  class ExtensionsController < 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 extension types.
+    # @return [void] Response from the API call.
+    def list_extension_types
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/extensions/extension-types',
+                                     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>
+    # Get extension type.
+    # @param [String] type_id Required parameter: The id of the extension
+    # type.
+    # @return [void] Response from the API call.
+    def show_extension_type(type_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/extensions/extension-types/{type_id}',
+                                     Server::API)
+                   .template_param(new_parameter(type_id, key: 'type_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>
+    # List extensions.
+    # @return [void] Response from the API call.
+    def list_extensions
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/extensions/extensions',
+                                     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>
+    # Create a new extension.
+    # @return [void] Response from the API call.
+    def create_extension
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/extensions/extensions',
+                                     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>
+    # Get extension.
+    # @param [String] extension_id Required parameter: The id of the
+    # extension.
+    # @return [void] Response from the API call.
+    def show_extension(extension_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/extensions/extensions/{extension_id}',
+                                     Server::API)
+                   .template_param(new_parameter(extension_id, key: 'extension_id')
+                                    .should_encode(true))
+                   .auth(Single.new('oauth')))
+        .response(new_response_handler
+                    .is_response_void(true))
+        .execute
+    end
+
+    # Updates an extension.
+    # @param [String] extension_id Required parameter: The id of the extension
+    # to update.
+    # @return [void] Response from the API call.
+    def update_extension(extension_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PATCH,
+                                     '/extensions/extensions/{extension_id}',
+                                     Server::API)
+                   .template_param(new_parameter(extension_id, key: 'extension_id')
+                                    .should_encode(true))
+                   .auth(Single.new('oauth')))
+        .response(new_response_handler
+                    .is_response_void(true))
+        .execute
+    end
+  end
+end

data/lib/new_store_api/controllers/financial_document_controller.rb

@@ -0,0 +1,161 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # FinancialDocumentController
+  class FinancialDocumentController < 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>
+    # Republish documents created events for a specific order_id:
+    # * financial_documents.sales_receipt_created
+    # * financial_documents.return_receipt_created
+    # * financial_documents.exchange_receipt_created
+    # * financial_documents.invoice_created
+    # * financial_documents.refund_note_created
+    # @param [String] x_newstore_tenant Required parameter: TODO: type
+    # description here
+    # @param [String] tenant Required parameter: TODO: type description here
+    # @param [String] order_id Required parameter: TODO: type description here
+    # @param [String] request_id Optional parameter: ID of the request
+    # @return [String] Response from the API call.
+    def create_new_documents_created_events(x_newstore_tenant,
+                                            tenant,
+                                            order_id,
+                                            request_id: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/checkout/financial-documents/document-created-events/{order_id}',
+                                     Server::API)
+                   .header_param(new_parameter(x_newstore_tenant, key: 'X-Newstore-Tenant'))
+                   .header_param(new_parameter(tenant, key: 'tenant'))
+                   .template_param(new_parameter(order_id, key: 'order_id')
+                                    .should_encode(true))
+                   .header_param(new_parameter(request_id, key: 'request-id'))
+                   .auth(Single.new('oauth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:deserialize_primitive_types))
+                    .deserialize_into(proc do |response| response&.to_s end)
+                    .is_primitive_response(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>
+    # Retrieve or generate a exchange receipt for a given order.
+    # @param [String] x_newstore_tenant Required parameter: TODO: type
+    # description here
+    # @param [String] request_id Optional parameter: ID of the request
+    # @param [CheckoutFinancialDocumentsExchangeReceiptsRequest] body Optional
+    # parameter: TODO: type description here
+    # @return [PermalinkResponse] Response from the API call.
+    def create_exchange_receipt(x_newstore_tenant,
+                                request_id: nil,
+                                body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/checkout/financial-documents/exchange-receipts',
+                                     Server::API)
+                   .header_param(new_parameter(x_newstore_tenant, key: 'X-Newstore-Tenant'))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .header_param(new_parameter(request_id, key: 'request-id'))
+                   .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(PermalinkResponse.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>
+    # Retrieve or regenerate return_receipt for a given order. This endpoint
+    # will not generate
+    # a return receipt if it hasn't been generated before.
+    # @param [String] x_newstore_tenant Required parameter: TODO: type
+    # description here
+    # @param [String] request_id Optional parameter: ID of the request
+    # @param [GetReturnReceiptRequest] body Optional parameter: TODO: type
+    # description here
+    # @return [ReturnReceiptResponse] Response from the API call.
+    def create_return_receipt(x_newstore_tenant,
+                              request_id: nil,
+                              body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/checkout/financial-documents/return-receipts',
+                                     Server::API)
+                   .header_param(new_parameter(x_newstore_tenant, key: 'X-Newstore-Tenant'))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .header_param(new_parameter(request_id, key: 'request-id'))
+                   .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(ReturnReceiptResponse.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>
+    # Retrieve or generate a sales receipt for a given order.
+    # @param [String] x_newstore_tenant Required parameter: TODO: type
+    # description here
+    # @param [String] request_id Optional parameter: ID of the request
+    # @param [CheckoutFinancialDocumentsSalesReceiptsRequest] body Optional
+    # parameter: TODO: type description here
+    # @return [PermalinkResponse] Response from the API call.
+    def create_sales_receipt(x_newstore_tenant,
+                             request_id: nil,
+                             body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/checkout/financial-documents/sales-receipts',
+                                     Server::API)
+                   .header_param(new_parameter(x_newstore_tenant, key: 'X-Newstore-Tenant'))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .header_param(new_parameter(request_id, key: 'request-id'))
+                   .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(PermalinkResponse.method(:from_hash)))
+        .execute
+    end
+  end
+end

data/lib/new_store_api/controllers/fiscal_providers_controller.rb

@@ -0,0 +1,23 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # FiscalProvidersController
+  class FiscalProvidersController < BaseController
+    # Get supported fiscal countries list.
+    # @return [FiscalCountriesDto] Response from the API call.
+    def list_fiscal_countries
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/providers/fiscal-countries',
+                                     Server::API)
+                   .header_param(new_parameter('application/json', key: 'accept')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(FiscalCountriesDto.method(:from_hash)))
+        .execute
+    end
+  end
+end