apimatic-tql-sdk 0.0.1 → 0.0.2

data/lib/freight_financials_webhook_ingestion_api/apis/documents_api.rb

@@ -0,0 +1,73 @@
+# freight_financials_webhook_ingestion_api
+#
+# This file was automatically
+# generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module FreightFinancialsWebhookIngestionApi
+  # DocumentsApi
+  class DocumentsApi < BaseApi
+    # TODO: type endpoint description here
+    # @param [String] x_tenant_id Required parameter: Tenant identifier stamped
+    # by APIM. Required on all requests.
+    # @param [Object] body Required parameter: Cancellation token.
+    # @param [String] api_version Optional parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def upload_document(x_tenant_id,
+                        body,
+                        api_version: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/v1/Documents',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(x_tenant_id, key: 'X-Tenant-Id')
+                                  .is_required(true))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .query_param(new_parameter(api_version, key: 'api-version'))
+                   .header_param(new_parameter('application/json; charset=utf-8', key: 'content-type'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(APIHelper.method(:json_serialize)))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(UploadResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Missing required fields or invalid document type.',
+                                 ProblemDetailsException))
+        .execute
+    end
+
+    # TODO: type endpoint description here
+    # @param [String] x_tenant_id Required parameter: Tenant identifier stamped
+    # by APIM. Required on all requests.
+    # @param [UploadRequest] body Required parameter: Cancellation token.
+    # @param [String] api_version Optional parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def upload_document_base64(x_tenant_id,
+                               body,
+                               api_version: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/v1/Documents/base64',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(x_tenant_id, key: 'X-Tenant-Id')
+                                  .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .query_param(new_parameter(api_version, key: 'api-version'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(UploadResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Missing required fields or invalid document type.',
+                                 ProblemDetailsException))
+        .execute
+    end
+  end
+end

data/lib/freight_financials_webhook_ingestion_api/apis/freight_audit_api.rb

@@ -0,0 +1,54 @@
+# freight_financials_webhook_ingestion_api
+#
+# This file was automatically
+# generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module FreightFinancialsWebhookIngestionApi
+  # FreightAuditApi
+  class FreightAuditApi < BaseApi
+    #     The catch-all {*path} route parameter allows Navix to target any
+    # sub-path
+    # (e.g., /api/v1/FreightAudit/navix, /api/v1/FreightAudit/navix/invoices).
+    # The path value is captured for logging but does not affect processing.
+    # @param [String] path Required parameter: Optional sub-path captured from
+    # the URL (for logging only).
+    # @param [String] x_tenant_id Required parameter: Tenant identifier stamped
+    # by APIM. Required on all requests.
+    # @param [NavixWebhookRequest] body Required parameter: Token to cancel the
+    # operation.
+    # @param [String] api_version Optional parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def receive_navix_webhook(path,
+                              x_tenant_id,
+                              body,
+                              api_version: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/v1/FreightAudit/{path}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(path, key: 'path')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter(x_tenant_id, key: 'X-Tenant-Id')
+                                  .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .query_param(new_parameter(api_version, key: 'api-version'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:dynamic_deserializer))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'The request body could not be deserialized into a valid Navix'\
+                                  ' webhook payload.',
+                                 ProblemDetailsException)
+                    .local_error('401',
+                                 'The `X-Tenant-Id` header is missing or empty.',
+                                 ProblemDetailsException))
+        .execute
+    end
+  end
+end

data/lib/freight_financials_webhook_ingestion_api/apis/invoices_api.rb

@@ -0,0 +1,107 @@
+# freight_financials_webhook_ingestion_api
+#
+# This file was automatically
+# generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module FreightFinancialsWebhookIngestionApi
+  # InvoicesApi
+  class InvoicesApi < BaseApi
+    # TODO: type endpoint description here
+    # @param [String] x_tenant_id Required parameter: Tenant identifier stamped
+    # by APIM. Required on all requests.
+    # @param [SubmitInvoiceRequest] body Required parameter: Cancellation
+    # token.
+    # @param [String] api_version Optional parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def submit_invoice(x_tenant_id,
+                       body,
+                       api_version: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/v1/Invoices',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(x_tenant_id, key: 'X-Tenant-Id')
+                                  .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .query_param(new_parameter(api_version, key: 'api-version'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(SubmitInvoiceResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'The request body is missing required fields or contains'\
+                                  ' invalid data.',
+                                 ProblemDetailsException))
+        .execute
+    end
+
+    # TODO: type endpoint description here
+    # @param [String] x_tenant_id Required parameter: Tenant identifier stamped
+    # by APIM. Required on all requests.
+    # @param [SearchRequest] body Required parameter: Cancellation token.
+    # @param [String] api_version Optional parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def search_invoices(x_tenant_id,
+                        body,
+                        api_version: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/v1/Invoices/search',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(x_tenant_id, key: 'X-Tenant-Id')
+                                  .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .query_param(new_parameter(api_version, key: 'api-version'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(SearchResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Invalid filter criteria or pagination parameters.',
+                                 ProblemDetailsException))
+        .execute
+    end
+
+    # TODO: type endpoint description here
+    # @param [String] invoice_number Required parameter: The factoring company's
+    # invoice number.
+    # @param [String] x_tenant_id Required parameter: Tenant identifier stamped
+    # by APIM. Required on all requests.
+    # @param [String] api_version Optional parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_invoice_status(invoice_number,
+                           x_tenant_id,
+                           api_version: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/api/v1/Invoices/{invoiceNumber}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(invoice_number, key: 'invoiceNumber')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter(x_tenant_id, key: 'X-Tenant-Id')
+                                  .is_required(true))
+                   .query_param(new_parameter(api_version, key: 'api-version'))
+                   .header_param(new_parameter('application/json', key: 'accept')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(InvoiceStatusResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('404',
+                                 'No invoice exists with the specified invoice number.',
+                                 ProblemDetailsException))
+        .execute
+    end
+  end
+end

data/lib/freight_financials_webhook_ingestion_api/apis/loads_api.rb

@@ -0,0 +1,72 @@
+# freight_financials_webhook_ingestion_api
+#
+# This file was automatically
+# generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module FreightFinancialsWebhookIngestionApi
+  # LoadsApi
+  class LoadsApi < BaseApi
+    # TODO: type endpoint description here
+    # @param [String] x_tenant_id Required parameter: Tenant identifier stamped
+    # by APIM. Required on all requests.
+    # @param [SearchRequest] body Required parameter: Cancellation token.
+    # @param [String] api_version Optional parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def search_loads(x_tenant_id,
+                     body,
+                     api_version: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/v1/Loads/search',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(x_tenant_id, key: 'X-Tenant-Id')
+                                  .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .query_param(new_parameter(api_version, key: 'api-version'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(SearchResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Invalid filter criteria or pagination parameters.',
+                                 ProblemDetailsException))
+        .execute
+    end
+
+    # TODO: type endpoint description here
+    # @param [String] load_number Required parameter: The TQL load number.
+    # @param [String] x_tenant_id Required parameter: Tenant identifier stamped
+    # by APIM. Required on all requests.
+    # @param [String] api_version Optional parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_load(load_number,
+                 x_tenant_id,
+                 api_version: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/api/v1/Loads/{loadNumber}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(load_number, key: 'loadNumber')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter(x_tenant_id, key: 'X-Tenant-Id')
+                                  .is_required(true))
+                   .query_param(new_parameter(api_version, key: 'api-version'))
+                   .header_param(new_parameter('application/json', key: 'accept')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(LoadResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('404',
+                                 'No load exists with the specified load number.',
+                                 ProblemDetailsException))
+        .execute
+    end
+  end
+end

data/lib/freight_financials_webhook_ingestion_api/apis/rating_api.rb

@@ -0,0 +1,45 @@
+# freight_financials_webhook_ingestion_api
+#
+# This file was automatically
+# generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module FreightFinancialsWebhookIngestionApi
+  # RatingApi
+  class RatingApi < BaseApi
+    # TODO: type endpoint description here
+    # @param [String] x_tenant_id Required parameter: Tenant identifier stamped
+    # by APIM. Required on all requests.
+    # @param [NavixRateRequest] body Required parameter: Cancellation token.
+    # @param [String] api_version Optional parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def rate_invoice(x_tenant_id,
+                     body,
+                     api_version: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/v1/rating',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(x_tenant_id, key: 'X-Tenant-Id')
+                                  .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .query_param(new_parameter(api_version, key: 'api-version'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(NavixRateResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'The request body was missing, unparseable, or lacked the'\
+                                  ' invoice/order identifiers.',
+                                 ProblemDetailsException)
+                    .local_error('401',
+                                 'The `X-Tenant-Id` header is missing or empty.',
+                                 ProblemDetailsException))
+        .execute
+    end
+  end
+end

data/lib/{tql_otr_factoring_data_exchange → freight_financials_webhook_ingestion_api}/client.rb

@@ -1,104 +1,90 @@
-# tql_otr_factoring_data_exchange
-#
-# This file was automatically generated by
-# APIMATIC v3.0 ( https://www.apimatic.io ).
-
-module TqlOtrFactoringDataExchange
-  #  tql_otr_factoring_data_exchange client class.
-  class Client
-    include CoreLibrary
-    attr_reader :config, :auth_managers
-
-    def user_agent_detail
-      config.user_agent_detail
-    end
+# freight_financials_webhook_ingestion_api
+#
+# This file was automatically
+# generated by APIMATIC v3.0 ( https://www.apimatic.io ).
 
-    # Returns the configured authentication bearerAuth instance.
-    def bearer_auth
-      @auth_managers['bearerAuth']
-    end
-
-    # Access to invoices controller.
-    # @return [InvoicesApi] Returns the controller instance.
-    def invoices
-      @invoices ||= InvoicesApi.new @global_configuration
-    end
-
-    # Access to documents controller.
-    # @return [DocumentsApi] Returns the controller instance.
-    def documents
-      @documents ||= DocumentsApi.new @global_configuration
-    end
-
-    # Access to assignments controller.
-    # @return [AssignmentsApi] Returns the controller instance.
-    def assignments
-      @assignments ||= AssignmentsApi.new @global_configuration
-    end
-
-    # Access to loads controller.
-    # @return [LoadsApi] Returns the controller instance.
-    def loads
-      @loads ||= LoadsApi.new @global_configuration
-    end
-
-    # Access to oauth_authorization controller.
-    # @return [OauthAuthorizationApi] Returns the controller instance.
-    def oauth_authorization
-      @oauth_authorization ||= OauthAuthorizationApi.new @global_configuration
-    end
-
-    def initialize(
-      connection: nil, adapter: :net_http_persistent, timeout: 30,
-      max_retries: 0, retry_interval: 1, backoff_factor: 2,
-      retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
-      retry_methods: %i[get put], http_callback: nil, proxy_settings: nil,
-      logging_configuration: nil, environment: Environment::PRODUCTION,
-      client_credentials_auth_credentials: nil, config: nil
-    )
-      @config = if config.nil?
-                  Configuration.new(
-                    connection: connection, adapter: adapter, timeout: timeout,
-                    max_retries: max_retries, retry_interval: retry_interval,
-                    backoff_factor: backoff_factor,
-                    retry_statuses: retry_statuses,
-                    retry_methods: retry_methods, http_callback: http_callback,
-                    proxy_settings: proxy_settings,
-                    logging_configuration: logging_configuration,
-                    environment: environment,
-                    client_credentials_auth_credentials: client_credentials_auth_credentials
-                  )
-                else
-                  config
-                end
-      user_agent_params = BaseApi.user_agent_parameters
-
-      @global_configuration = GlobalConfiguration.new(client_configuration: @config)
-                                                 .base_uri_executor(@config.method(:get_base_uri))
-                                                 .global_errors(BaseApi::GLOBAL_ERRORS)
-                                                 .user_agent(BaseApi.user_agent,
-                                                             agent_parameters: user_agent_params)
-
-      initialize_auth_managers(@global_configuration)
-      @global_configuration = @global_configuration.auth_managers(@auth_managers)
-    end
-
-    # Initializes the auth managers hash used for authenticating API calls.
-    # @param [GlobalConfiguration] global_config The global configuration of the SDK)
-    def initialize_auth_managers(global_config)
-      @auth_managers = {}
-      http_client_config = global_config.client_configuration
-      %w[bearerAuth].each { |auth| @auth_managers[auth] = nil }
-      @auth_managers['bearerAuth'] = Oauth2.new(
-        http_client_config.client_credentials_auth_credentials, global_config
-      )
-    end
+module FreightFinancialsWebhookIngestionApi
+  #  freight_financials_webhook_ingestion_api client class.
+  class Client
+    include CoreLibrary
+    attr_reader :config
+
+    def user_agent_detail
+      config.user_agent_detail
+    end
+
+    # Access to assignments controller.
+    # @return [AssignmentsApi] Returns the controller instance.
+    def assignments
+      @assignments ||= AssignmentsApi.new @global_configuration
+    end
+
+    # Access to documents controller.
+    # @return [DocumentsApi] Returns the controller instance.
+    def documents
+      @documents ||= DocumentsApi.new @global_configuration
+    end
+
+    # Access to freight_audit controller.
+    # @return [FreightAuditApi] Returns the controller instance.
+    def freight_audit
+      @freight_audit ||= FreightAuditApi.new @global_configuration
+    end
+
+    # Access to invoices controller.
+    # @return [InvoicesApi] Returns the controller instance.
+    def invoices
+      @invoices ||= InvoicesApi.new @global_configuration
+    end
+
+    # Access to loads controller.
+    # @return [LoadsApi] Returns the controller instance.
+    def loads
+      @loads ||= LoadsApi.new @global_configuration
+    end
+
+    # Access to rating controller.
+    # @return [RatingApi] Returns the controller instance.
+    def rating
+      @rating ||= RatingApi.new @global_configuration
+    end
+
+    def initialize(
+      connection: nil, adapter: :net_http_persistent, timeout: 30,
+      max_retries: 0, retry_interval: 1, backoff_factor: 2,
+      retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
+      retry_methods: %i[get put], http_callback: nil, proxy_settings: nil,
+      logging_configuration: nil, environment: Environment::PRODUCTION,
+      config: nil
+    )
+      @config = if config.nil?
+                  Configuration.new(
+                    connection: connection, adapter: adapter, timeout: timeout,
+                    max_retries: max_retries, retry_interval: retry_interval,
+                    backoff_factor: backoff_factor,
+                    retry_statuses: retry_statuses,
+                    retry_methods: retry_methods, http_callback: http_callback,
+                    proxy_settings: proxy_settings,
+                    logging_configuration: logging_configuration,
+                    environment: environment
+                  )
+                else
+                  config
+                end
+      user_agent_params = BaseApi.user_agent_parameters
+
+      @global_configuration = GlobalConfiguration.new(client_configuration: @config)
+                                                 .base_uri_executor(@config.method(:get_base_uri))
+                                                 .global_errors(BaseApi::GLOBAL_ERRORS)
+                                                 .user_agent(BaseApi.user_agent,
+                                                             agent_parameters: user_agent_params)
+    end
 
     # Creates a client directly from environment variables.
     def self.from_env(**overrides)
       default_config = Configuration.build_default_config_from_env
       new_config = default_config.clone_with(**overrides)
       new(config: new_config)
-    end
-  end
-end
+    end
+  end
+end