juniper-mist-sdk 0.0.1

data/lib/mist_api/controllers/ms_ps_tickets.rb

@@ -0,0 +1,102 @@
+# mist_api
+#
+# This file was automatically generated for Juniper Networks by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module MistApi
+  # MSPsTickets
+  class MSPsTickets < BaseController
+    # Get List of Tickets of a MSP
+    # @param [UUID | String] msp_id Required parameter: TODO: type description
+    # here
+    # @param [String] start Optional parameter: Start time (epoch timestamp in
+    # seconds, or relative string like "-1d", "-1w")
+    # @param [String] mend Optional parameter: End time (epoch timestamp in
+    # seconds, or relative string like "-1d", "-2h", "now")
+    # @param [String] duration Optional parameter: Duration like 7d, 2w
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def list_msp_tickets(msp_id,
+                         start: nil,
+                         mend: nil,
+                         duration: '1d')
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/api/v1/msps/{msp_id}/tickets',
+                                     Server::API_HOST)
+                   .template_param(new_parameter(msp_id, key: 'msp_id')
+                                    .should_encode(true))
+                   .query_param(new_parameter(start, key: 'start'))
+                   .query_param(new_parameter(mend, key: 'end'))
+                   .query_param(new_parameter(duration, key: 'duration'))
+                   .auth(Or.new('apiToken', 'basicAuth', And.new('basicAuth', 'csrfToken'))))
+        .response(new_response_handler
+                    .is_nullify404(true)
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(Ticket.method(:from_hash))
+                    .is_api_response(true)
+                    .is_response_array(true)
+                    .local_error('400',
+                                 'Bad Syntax',
+                                 APIException)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 APIException)
+                    .local_error('403',
+                                 'Permission Denied',
+                                 APIException)
+                    .local_error('404',
+                                 'Not found. The API endpoint doesn’t exist or resource doesn’ t'\
+                                  ' exist',
+                                 APIException)
+                    .local_error('429',
+                                 'Too Many Request. The API Token used for the request reached'\
+                                  ' the 5000 API Calls per hour threshold',
+                                 APIException))
+        .execute
+    end
+
+    # Count by Distinct Attributes of tickets
+    # @param [UUID | String] msp_id Required parameter: TODO: type description
+    # here
+    # @param [MspTicketsCountDistinctEnum] distinct Optional parameter:
+    # Example:status
+    # @param [Integer] limit Optional parameter: Example:100
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def count_msp_tickets(msp_id,
+                          distinct: MspTicketsCountDistinctEnum::STATUS,
+                          limit: 100)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/api/v1/msps/{msp_id}/tickets/count',
+                                     Server::API_HOST)
+                   .template_param(new_parameter(msp_id, key: 'msp_id')
+                                    .should_encode(true))
+                   .query_param(new_parameter(distinct, key: 'distinct'))
+                   .query_param(new_parameter(limit, key: 'limit'))
+                   .auth(Or.new('apiToken', 'basicAuth', And.new('basicAuth', 'csrfToken'))))
+        .response(new_response_handler
+                    .is_nullify404(true)
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ResponseCount.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Syntax',
+                                 APIException)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 APIException)
+                    .local_error('403',
+                                 'Permission Denied',
+                                 APIException)
+                    .local_error('404',
+                                 'Not found. The API endpoint doesn’t exist or resource doesn’ t'\
+                                  ' exist',
+                                 APIException)
+                    .local_error('429',
+                                 'Too Many Request. The API Token used for the request reached'\
+                                  ' the 5000 API Calls per hour threshold',
+                                 APIException))
+        .execute
+    end
+  end
+end

data/lib/mist_api/controllers/orgs_sdk_invites.rb

@@ -0,0 +1,51 @@
+# mist_api
+#
+# This file was automatically generated for Juniper Networks by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module MistApi
+  # OrgsSDKInvites
+  class OrgsSDKInvites < BaseController
+    # Verify secret
+    # @param [String] secret Required parameter: TODO: type description here
+    # @param [DeviceIdString] body Optional parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def activate_sdk_invite(secret,
+                            body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/v1/mobile/verify/{secret}',
+                                     Server::API_HOST)
+                   .template_param(new_parameter(secret, key: 'secret')
+                                    .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(Or.new('apiToken', 'basicAuth', And.new('basicAuth', 'csrfToken'))))
+        .response(new_response_handler
+                    .is_nullify404(true)
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ResponseMobileVerifySecret.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Syntax',
+                                 APIException)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 APIException)
+                    .local_error('403',
+                                 'Permission Denied',
+                                 APIException)
+                    .local_error('404',
+                                 'Not found. The API endpoint doesn’t exist or resource doesn’ t'\
+                                  ' exist',
+                                 APIException)
+                    .local_error('429',
+                                 'Too Many Request. The API Token used for the request reached'\
+                                  ' the 5000 API Calls per hour threshold',
+                                 APIException))
+        .execute
+    end
+  end
+end

data/lib/mist_api/controllers/utilities_wi_fi.rb

@@ -0,0 +1,47 @@
+# mist_api
+#
+# This file was automatically generated for Juniper Networks by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module MistApi
+  # UtilitiesWiFi
+  class UtilitiesWiFi < BaseController
+    # Allows validation of twilio setup
+    # In case of success, a text message confirming successful setup should be
+    # received. In case of error, twilio error code and message are returned.
+    # @param [TestTwilio] body Optional parameter: Request Body
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def test_site_wlan_twilio_setup(body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/v1/utils/test_twilio',
+                                     Server::API_HOST)
+                   .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(Or.new('apiToken', 'basicAuth', And.new('basicAuth', 'csrfToken'))))
+        .response(new_response_handler
+                    .is_nullify404(true)
+                    .is_response_void(true)
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Syntax',
+                                 APIException)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 APIException)
+                    .local_error('403',
+                                 'Permission Denied',
+                                 APIException)
+                    .local_error('404',
+                                 'Not found. The API endpoint doesn’t exist or resource doesn’ t'\
+                                  ' exist',
+                                 APIException)
+                    .local_error('429',
+                                 'Too Many Request. The API Token used for the request reached'\
+                                  ' the 5000 API Calls per hour threshold',
+                                 APIException))
+        .execute
+    end
+  end
+end

data/lib/mist_api/events/unknown_event.rb

@@ -0,0 +1,32 @@
+# mist_api
+#
+# This file was automatically generated for Juniper Networks by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module MistApi
+  # Represents an unrecognized or unsupported event during processing.
+  class UnknownEvent
+    # @return [Array<String>]
+    attr_reader :errors
+
+    # Initialize with the errors that caused the failure.
+    # @param errors [Array<String>] A list of error messages describing the reasons for verification failure.
+    def initialize(errors)
+      @errors = errors
+    end
+
+    # Provides a user-friendly string representation of the failure.
+    # @return [String]
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} errors: #{@errors}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    # @return [String]
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} errors: #{@errors.inspect}>"
+    end
+  end
+end

data/lib/mist_api/events/webhooks/webhooks_handler.rb

@@ -0,0 +1,55 @@
+# mist_api
+#
+# This file was automatically generated for Juniper Networks by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module MistApi
+  # WebhooksHandler is responsible for verifying request signatures
+  # and parsing incoming Webhooks events into strongly typed objects.
+  class WebhooksHandler
+    include CoreLibrary
+    # Creates a new instance of the WebhooksHandler.
+    def initialize; end
+
+    # Parse the event.
+    #
+    # @param [Rack::Request] request The incoming HTTP request containing the event payload.
+    # @return[WebhookAlarms, nil, WebhookAssetRawRssi, WebhookAudits,
+    # WebhookClientInfo, WebhookClientJoin, WebhookClientLatency,
+    # WebhookClientSessions, WebhookDeviceEvents, WebhookDeviceUpdowns,
+    # WebhookDiscoveredRawRssi, WebhookGuestAuthorizations, WebhookLocation,
+    # WebhookLocationAsset, WebhookLocationCentrak, WebhookLocationClient,
+    # WebhookLocationSdk, WebhookLocationUnclient, WebhookMinisApplication,
+    # WebhookMinisReachability, WebhookMxedgeEvents, WebhookNacAccounting,
+    # WebhookNacEvents, WebhookOccupancyAlerts, WebhookPing, WebhookRssizone,
+    # WebhookSdkclientScanData, WebhookSiteSle, WebhookWifiConnRaw,
+    # WebhookWifiUnconnRaw, WebhookZone, UnknownEvent]
+    # WebhookAlarms, nil, WebhookAssetRawRssi, WebhookAudits, WebhookClientInfo,
+    # WebhookClientJoin, WebhookClientLatency, WebhookClientSessions,
+    # WebhookDeviceEvents, WebhookDeviceUpdowns, WebhookDiscoveredRawRssi,
+    # WebhookGuestAuthorizations, WebhookLocation, WebhookLocationAsset,
+    # WebhookLocationCentrak, WebhookLocationClient, WebhookLocationSdk,
+    # WebhookLocationUnclient, WebhookMinisApplication,
+    # WebhookMinisReachability, WebhookMxedgeEvents, WebhookNacAccounting,
+    # WebhookNacEvents, WebhookOccupancyAlerts, WebhookPing, WebhookRssizone,
+    # WebhookSdkclientScanData, WebhookSiteSle, WebhookWifiConnRaw,
+    # WebhookWifiUnconnRaw, WebhookZone for successful parsing;
+    #
+    # UnknownEvent for unknown events.
+    def parse_event(request)
+      return UnknownEvent.new(['Invalid request env.']) unless request.respond_to?(:env) && request.env.is_a?(Hash)
+
+      raw_body = RackRequestHelper.read_raw_body(request)
+      return UnknownEvent.new(['Invalid request body.']) if raw_body.nil? || raw_body.empty?
+
+      # Deserialize payload
+      begin
+        union = UnionTypeLookUp.get(:Webhooks)
+        raw = RackRequestHelper.read_raw_body(request)
+        APIHelper.deserialize_union_type(union, raw, false, true)
+      rescue StandardError => e
+        UnknownEvent.new(['Deserialization failed.', e.message])
+      end
+    end
+  end
+end

data/lib/mist_api/exceptions/api_exception.rb

@@ -0,0 +1,21 @@
+# mist_api
+#
+# This file was automatically generated for Juniper Networks by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module MistApi
+  # 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/mist_api/http/api_response.rb

@@ -0,0 +1,19 @@
+# mist_api
+#
+# This file was automatically generated for Juniper Networks by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module MistApi
+  # Http response received.
+  class ApiResponse < CoreLibrary::ApiResponse
+    # The constructor
+    # @param [HttpResponse] http_response The original, raw response from the api.
+    # @param [Object] data The data field specified for the response.
+    # @param [Array<String>] errors Any errors returned by the server.
+    def initialize(http_response,
+                   data: nil,
+                   errors: nil)
+      super
+    end
+  end
+end

data/lib/mist_api/http/auth/api_token.rb

@@ -0,0 +1,52 @@
+# mist_api
+#
+# This file was automatically generated for Juniper Networks by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module MistApi
+  # Utility class for custom header authorization.
+  class ApiToken < CoreLibrary::HeaderAuth
+    # Display error message on occurrence of authentication failure.
+    # @returns [String] The oAuth error message.
+    def error_message
+      'ApiToken: authorization is undefined.'
+    end
+
+    # Initialization constructor.
+    def initialize(api_token_credentials)
+      auth_params = {}
+      auth_params['Authorization'] = api_token_credentials.authorization unless
+        api_token_credentials.nil? || api_token_credentials.authorization.nil?
+
+      super auth_params
+    end
+  end
+
+  # Data class for ApiTokenCredentials.
+  # Data class for ApiTokenCredentials.
+  class ApiTokenCredentials
+    attr_reader :authorization
+
+    def initialize(authorization:)
+      raise ArgumentError, 'authorization cannot be nil' if authorization.nil?
+
+      @authorization = authorization
+    end
+
+    def self.from_env
+      authorization = ENV['API_TOKEN_AUTHORIZATION']
+      all_nil = [
+        authorization
+      ].all?(&:nil?)
+      return nil if all_nil
+
+      new(authorization: authorization)
+    end
+
+    def clone_with(authorization: nil)
+      authorization ||= self.authorization
+
+      ApiTokenCredentials.new(authorization: authorization)
+    end
+  end
+end

data/lib/mist_api/http/auth/basic_auth.rb

@@ -0,0 +1,62 @@
+# mist_api
+#
+# This file was automatically generated for Juniper Networks by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module MistApi
+  # Utility class for basic authorization.
+  class BasicAuth < CoreLibrary::HeaderAuth
+    include CoreLibrary
+    # Display error message on occurrence of authentication failure.
+    # @returns [String] The oAuth error message.
+    def error_message
+      'BasicAuth: username or password is undefined.'
+    end
+
+    # Initialization constructor.
+    def initialize(basic_auth_credentials)
+      auth_params = {}
+      unless basic_auth_credentials.nil? ||
+             basic_auth_credentials.username.nil? ||
+             basic_auth_credentials.password.nil?
+        auth_params['Authorization'] =
+          "Basic #{AuthHelper.get_base64_encoded_value(basic_auth_credentials.username,
+                                                       basic_auth_credentials.password)}"
+      end
+
+      super auth_params
+    end
+  end
+
+  # Data class for BasicAuthCredentials.
+  class BasicAuthCredentials
+    attr_reader :username, :password
+
+    def initialize(username:, password:)
+      raise ArgumentError, 'username cannot be nil' if username.nil?
+      raise ArgumentError, 'password cannot be nil' if password.nil?
+
+      @username = username
+      @password = password
+    end
+
+    def self.from_env
+      username = ENV['BASIC_AUTH_USERNAME']
+      password = ENV['BASIC_AUTH_PASSWORD']
+      all_nil = [
+        username,
+        password
+      ].all?(&:nil?)
+      return nil if all_nil
+
+      new(username: username, password: password)
+    end
+
+    def clone_with(username: nil, password: nil)
+      username ||= self.username
+      password ||= self.password
+
+      BasicAuthCredentials.new(username: username, password: password)
+    end
+  end
+end

data/lib/mist_api/http/auth/csrf_token.rb

@@ -0,0 +1,52 @@
+# mist_api
+#
+# This file was automatically generated for Juniper Networks by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module MistApi
+  # Utility class for custom header authorization.
+  class CsrfToken < CoreLibrary::HeaderAuth
+    # Display error message on occurrence of authentication failure.
+    # @returns [String] The oAuth error message.
+    def error_message
+      'CsrfToken: x_csrf_token is undefined.'
+    end
+
+    # Initialization constructor.
+    def initialize(csrf_token_credentials)
+      auth_params = {}
+      auth_params['X-CSRFToken'] = csrf_token_credentials.x_csrf_token unless
+        csrf_token_credentials.nil? || csrf_token_credentials.x_csrf_token.nil?
+
+      super auth_params
+    end
+  end
+
+  # Data class for CsrfTokenCredentials.
+  # Data class for CsrfTokenCredentials.
+  class CsrfTokenCredentials
+    attr_reader :x_csrf_token
+
+    def initialize(x_csrf_token:)
+      raise ArgumentError, 'x_csrf_token cannot be nil' if x_csrf_token.nil?
+
+      @x_csrf_token = x_csrf_token
+    end
+
+    def self.from_env
+      x_csrf_token = ENV['CSRF_TOKEN_X_CSRF_TOKEN']
+      all_nil = [
+        x_csrf_token
+      ].all?(&:nil?)
+      return nil if all_nil
+
+      new(x_csrf_token: x_csrf_token)
+    end
+
+    def clone_with(x_csrf_token: nil)
+      x_csrf_token ||= self.x_csrf_token
+
+      CsrfTokenCredentials.new(x_csrf_token: x_csrf_token)
+    end
+  end
+end

data/lib/mist_api/http/http_call_back.rb

@@ -0,0 +1,10 @@
+# mist_api
+#
+# This file was automatically generated for Juniper Networks by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module MistApi
+  # HttpCallBack allows defining callables for pre and post API calls.
+  class HttpCallBack < CoreLibrary::HttpCallback
+  end
+end

data/lib/mist_api/http/http_method_enum.rb

@@ -0,0 +1,10 @@
+# mist_api
+#
+# This file was automatically generated for Juniper Networks by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module MistApi
+  # HTTP Methods Enumeration.
+  class HttpMethodEnum < CoreLibrary::HttpMethod
+  end
+end

data/lib/mist_api/http/http_request.rb

@@ -0,0 +1,10 @@
+# mist_api
+#
+# This file was automatically generated for Juniper Networks by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module MistApi
+  # Represents a single Http Request.
+  class HttpRequest < CoreLibrary::HttpRequest
+  end
+end

data/lib/mist_api/http/http_response.rb

@@ -0,0 +1,10 @@
+# mist_api
+#
+# This file was automatically generated for Juniper Networks by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module MistApi
+  # Http response received.
+  class HttpResponse < CoreLibrary::HttpResponse
+  end
+end

data/lib/mist_api/http/proxy_settings.rb

@@ -0,0 +1,22 @@
+# mist_api
+#
+# This file was automatically generated for Juniper Networks by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module MistApi
+  ##
+  # ProxySettings encapsulates HTTP proxy configuration for Faraday,
+  # including optional basic authentication.
+  #
+  class ProxySettings < CoreLibrary::ProxySettings
+    def self.from_env
+      address = ENV['PROXY_ADDRESS']
+      port = ENV['PROXY_PORT']
+      username = ENV['PROXY_USERNAME']
+      password = ENV['PROXY_PASSWORD']
+      return nil if address.nil? || address.strip.empty?
+
+      new(address: address, port: port, username: username, password: password)
+    end
+  end
+end