specs-sdk 1.3.0

data/lib/verizon/controllers/sim_actions_controller.rb

@@ -0,0 +1,92 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # SIMActionsController
+  class SIMActionsController < BaseController
+    # Uses the profile to activate the SIM.
+    # @param [ESIMProfileRequest] body Required parameter: Device Profile
+    # Query
+    # @return [ESIMRequestResponse] response from the API call
+    def setactivate_using_post(body)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/m2m/v1/devices/profile/actions/activate',
+                                     Server::THINGSPACE)
+                   .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('thingspace_oauth')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(ESIMRequestResponse.method(:from_hash))
+                   .is_api_response(true)
+                   .local_error('400',
+                                'Bad request',
+                                ESIMRestErrorResponseException)
+                   .local_error('401',
+                                'Unauthorized',
+                                ESIMRestErrorResponseException)
+                   .local_error('403',
+                                'Forbidden',
+                                ESIMRestErrorResponseException)
+                   .local_error('404',
+                                'Not Found / Does not exist',
+                                ESIMRestErrorResponseException)
+                   .local_error('406',
+                                'Format / Request Unacceptable',
+                                ESIMRestErrorResponseException)
+                   .local_error('429',
+                                'Too many requests',
+                                ESIMRestErrorResponseException)
+                   .local_error('default',
+                                'Error response',
+                                ESIMRestErrorResponseException))
+        .execute
+    end
+
+    # Uses the profile to deactivate the SIM.
+    # @param [ProfileRequest2] body Required parameter: Device Profile Query
+    # @return [ESIMRequestResponse] response from the API call
+    def setdeactivate_using_post(body)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/m2m/v1/devices/profile/actions/deactivate',
+                                     Server::THINGSPACE)
+                   .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('thingspace_oauth')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(ESIMRequestResponse.method(:from_hash))
+                   .is_api_response(true)
+                   .local_error('400',
+                                'Bad request',
+                                ESIMRestErrorResponseException)
+                   .local_error('401',
+                                'Unauthorized',
+                                ESIMRestErrorResponseException)
+                   .local_error('403',
+                                'Forbidden',
+                                ESIMRestErrorResponseException)
+                   .local_error('404',
+                                'Not Found / Does not exist',
+                                ESIMRestErrorResponseException)
+                   .local_error('406',
+                                'Format / Request Unacceptable',
+                                ESIMRestErrorResponseException)
+                   .local_error('429',
+                                'Too many requests',
+                                ESIMRestErrorResponseException)
+                   .local_error('default',
+                                'Error response',
+                                ESIMRestErrorResponseException))
+        .execute
+    end
+  end
+end

data/lib/verizon/controllers/sim_secure_for_io_t_licenses_controller.rb

@@ -0,0 +1,94 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # SIMSecureForIoTLicensesController
+  class SIMSecureForIoTLicensesController < BaseController
+    # Assigns SIM-Secure for IoT licenses to SIMs.
+    # @param [AssignLicenseRequest] body Required parameter: Request to assign
+    # license to devices.
+    # @param [String] x_request_id Optional parameter: Transaction Id.
+    # @return [SecuritySuccessResult] response from the API call
+    def assign_license_to_devices(body,
+                                  x_request_id: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v1/devices/license/actions/assign',
+                                     Server::M2M)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter(x_request_id, key: 'X-Request-ID'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('oAuth2')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(SecuritySuccessResult.method(:from_hash))
+                   .is_api_response(true)
+                   .local_error('400',
+                                'Bad request.',
+                                SecurityResultException)
+                   .local_error('401',
+                                'Unauthorized request.',
+                                SecurityResultException)
+                   .local_error('403',
+                                'Request Forbidden.',
+                                SecurityResultException)
+                   .local_error('404',
+                                'Not Found / Does not exist.',
+                                SecurityResultException)
+                   .local_error('406',
+                                'Format / Request Unacceptable.',
+                                SecurityResultException)
+                   .local_error('429',
+                                'Too many requests.',
+                                SecurityResultException)
+                   .local_error('default',
+                                'Error response.',
+                                SecurityResultException))
+        .execute
+    end
+
+    # Unassigns SIM-Secure for IoT Flexible and Flexible Bundle license from
+    # SIMs.
+    # @param [String] x_request_id Required parameter: Transaction Id.
+    # @return [SecuritySuccessResult] response from the API call
+    def unassign_license_to_devices(x_request_id)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/v1/devices/license/actions/assign',
+                                     Server::M2M)
+                   .header_param(new_parameter(x_request_id, key: 'X-Request-ID'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('oAuth2')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(SecuritySuccessResult.method(:from_hash))
+                   .is_api_response(true)
+                   .local_error('400',
+                                'Bad request.',
+                                SecurityResultException)
+                   .local_error('401',
+                                'Unauthorized request.',
+                                SecurityResultException)
+                   .local_error('403',
+                                'Request forbidden.',
+                                SecurityResultException)
+                   .local_error('404',
+                                'Not Found / Does not exist.',
+                                SecurityResultException)
+                   .local_error('406',
+                                'Format / Request Unacceptable.',
+                                SecurityResultException)
+                   .local_error('429',
+                                'Too many requests.',
+                                SecurityResultException)
+                   .local_error('default',
+                                'Error response.',
+                                SecurityResultException))
+        .execute
+    end
+  end
+end

data/lib/verizon/controllers/sms_controller.rb

@@ -0,0 +1,88 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # SMSController
+  class SMSController < BaseController
+    # The messages are queued on the ThingSpace Platform and sent as soon as
+    # possible, but they may be delayed due to traffic and routing
+    # considerations.
+    # @param [SMSSendRequest] body Required parameter: Request to send SMS.
+    # @return [DeviceManagementResult] response from the API call
+    def send_sms_to_device(body)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/m2m/v1/sms',
+                                     Server::THINGSPACE)
+                   .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('thingspace_oauth')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(DeviceManagementResult.method(:from_hash))
+                   .is_api_response(true)
+                   .local_error('400',
+                                'Error response.',
+                                ConnectivityManagementResultException))
+        .execute
+    end
+
+    # When HTTP status is 202, a URL will be returned in the Location header of
+    # the form /sms/{aname}/history?next={token}. This URL can be used to
+    # request the next set of messages.
+    # @param [String] aname Required parameter: Account name.
+    # @param [Integer] mnext Optional parameter: Continue the previous query
+    # from the URL in Location Header.
+    # @return [SMSMessagesQueryResult] response from the API call
+    def list_devices_sms_messages(aname,
+                                  mnext: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/m2m/v1/sms/{aname}/history',
+                                     Server::THINGSPACE)
+                   .template_param(new_parameter(aname, key: 'aname')
+                                    .should_encode(true))
+                   .query_param(new_parameter(mnext, key: 'next'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('thingspace_oauth')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(SMSMessagesQueryResult.method(:from_hash))
+                   .is_api_response(true)
+                   .local_error('400',
+                                'Error response.',
+                                ConnectivityManagementResultException))
+        .execute
+    end
+
+    # Tells the ThingSpace Platform to start sending mobile-originated SMS
+    # messages through the EnhancedConnectivityService callback service. SMS
+    # messages from devices are queued until they are retrieved by your
+    # application, either by callback or synchronously with GET
+    # /sms/{accountName}/history.
+    # @param [String] aname Required parameter: Account name.
+    # @return [ConnectivityManagementSuccessResult] response from the API call
+    def start_queued_sms_delivery(aname)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/m2m/v1/sms/{aname}/startCallbacks',
+                                     Server::THINGSPACE)
+                   .template_param(new_parameter(aname, key: 'aname')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('thingspace_oauth')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(ConnectivityManagementSuccessResult.method(:from_hash))
+                   .is_api_response(true)
+                   .local_error('400',
+                                'Error response.',
+                                ConnectivityManagementResultException))
+        .execute
+    end
+  end
+end

data/lib/verizon/controllers/software_management_callbacks_v1_controller.rb

@@ -0,0 +1,93 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # SoftwareManagementCallbacksV1Controller
+  class SoftwareManagementCallbacksV1Controller < BaseController
+    # Returns the name and endpoint URL of the callback listening services
+    # registered for a given account.
+    # @param [String] account Required parameter: Account identifier in
+    # "##########-#####".
+    # @return [Array[RegisteredCallbacks]] response from the API call
+    def list_registered_callbacks(account)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/callbacks/{account}',
+                                     Server::SOFTWARE_MANAGEMENT_V1)
+                   .template_param(new_parameter(account, key: 'account')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('oAuth2')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(RegisteredCallbacks.method(:from_hash))
+                   .is_api_response(true)
+                   .is_response_array(true)
+                   .local_error('400',
+                                'Unexpected error.',
+                                FotaV1ResultException))
+        .execute
+    end
+
+    # Registers a URL to receive RESTful messages from a callback service when
+    # new firmware versions are available and when upgrades start and finish.
+    # @param [String] account Required parameter: Account identifier in
+    # "##########-#####".
+    # @param [FotaV1CallbackRegistrationRequest] body Required parameter:
+    # Callback details.
+    # @return [FotaV1CallbackRegistrationResult] response from the API call
+    def register_callback(account,
+                          body)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/callbacks/{account}',
+                                     Server::SOFTWARE_MANAGEMENT_V1)
+                   .template_param(new_parameter(account, key: 'account')
+                                    .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('oAuth2')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(FotaV1CallbackRegistrationResult.method(:from_hash))
+                   .is_api_response(true)
+                   .local_error('400',
+                                'Unexpected error.',
+                                FotaV1ResultException))
+        .execute
+    end
+
+    # Deregisters the callback endpoint and stops ThingSpace from sending FOTA
+    # callback messages for the specified account.
+    # @param [String] account Required parameter: Account identifier in
+    # "##########-#####".
+    # @param [CallbackServiceEnum] service Required parameter: Callback type.
+    # Must be 'Fota' for Software Management Services API.
+    # @return [FotaV1SuccessResult] response from the API call
+    def deregister_callback(account,
+                            service)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/callbacks/{account}/name/{service}',
+                                     Server::SOFTWARE_MANAGEMENT_V1)
+                   .template_param(new_parameter(account, key: 'account')
+                                    .should_encode(true))
+                   .template_param(new_parameter(service, key: 'service')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('oAuth2')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(FotaV1SuccessResult.method(:from_hash))
+                   .is_api_response(true)
+                   .local_error('400',
+                                'Unexpected error.',
+                                FotaV1ResultException))
+        .execute
+    end
+  end
+end

data/lib/verizon/controllers/software_management_callbacks_v2_controller.rb

@@ -0,0 +1,109 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # SoftwareManagementCallbacksV2Controller
+  class SoftwareManagementCallbacksV2Controller < BaseController
+    # This endpoint allows user to get the registered callback information.
+    # @param [String] account Required parameter: Account identifier.
+    # @return [CallbackSummary] response from the API call
+    def list_registered_callbacks(account)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/callbacks/{account}',
+                                     Server::SOFTWARE_MANAGEMENT_V2)
+                   .template_param(new_parameter(account, key: 'account')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('oAuth2')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(CallbackSummary.method(:from_hash))
+                   .is_api_response(true)
+                   .local_error('400',
+                                'Unexpected error.',
+                                FotaV2ResultException))
+        .execute
+    end
+
+    # This endpoint allows user to update the HTTPS callback address.
+    # @param [String] account Required parameter: Account identifier.
+    # @param [FotaV2CallbackRegistrationRequest] body Required parameter:
+    # Callback URL registration.
+    # @return [FotaV2CallbackRegistrationResult] response from the API call
+    def update_callback(account,
+                        body)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/callbacks/{account}',
+                                     Server::SOFTWARE_MANAGEMENT_V2)
+                   .template_param(new_parameter(account, key: 'account')
+                                    .should_encode(true))
+                   .header_param(new_parameter('*/*', 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('oAuth2')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(FotaV2CallbackRegistrationResult.method(:from_hash))
+                   .is_api_response(true)
+                   .local_error('400',
+                                'Unexpected error.',
+                                FotaV2ResultException))
+        .execute
+    end
+
+    # This endpoint allows user to create the HTTPS callback address.
+    # @param [String] account Required parameter: Account identifier.
+    # @param [FotaV2CallbackRegistrationRequest] body Required parameter:
+    # Callback URL registration.
+    # @return [FotaV2CallbackRegistrationResult] response from the API call
+    def register_callback(account,
+                          body)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/callbacks/{account}',
+                                     Server::SOFTWARE_MANAGEMENT_V2)
+                   .template_param(new_parameter(account, key: 'account')
+                                    .should_encode(true))
+                   .header_param(new_parameter('*/*', 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('oAuth2')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(FotaV2CallbackRegistrationResult.method(:from_hash))
+                   .is_api_response(true)
+                   .local_error('400',
+                                'Unexpected error.',
+                                FotaV2ResultException))
+        .execute
+    end
+
+    # This endpoint allows user to delete a previously registered callback URL.
+    # @param [String] account Required parameter: Account identifier.
+    # @return [FotaV2SuccessResult] response from the API call
+    def deregister_callback(account)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/callbacks/{account}',
+                                     Server::SOFTWARE_MANAGEMENT_V2)
+                   .template_param(new_parameter(account, key: 'account')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('oAuth2')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(FotaV2SuccessResult.method(:from_hash))
+                   .is_api_response(true)
+                   .local_error('400',
+                                'Unexpected error.',
+                                FotaV2ResultException))
+        .execute
+    end
+  end
+end

data/lib/verizon/controllers/software_management_callbacks_v3_controller.rb

@@ -0,0 +1,109 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # SoftwareManagementCallbacksV3Controller
+  class SoftwareManagementCallbacksV3Controller < BaseController
+    # This endpoint allows user to get the registered callback information.
+    # @param [String] acc Required parameter: Account identifier.
+    # @return [FotaV3CallbackSummary] response from the API call
+    def list_registered_callbacks(acc)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/callbacks/{acc}',
+                                     Server::SOFTWARE_MANAGEMENT_V3)
+                   .template_param(new_parameter(acc, key: 'acc')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('oAuth2')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(FotaV3CallbackSummary.method(:from_hash))
+                   .is_api_response(true)
+                   .local_error('400',
+                                'Unexpected error.',
+                                FotaV3ResultException))
+        .execute
+    end
+
+    # This endpoint allows the user to update the HTTPS callback address.
+    # @param [String] acc Required parameter: Account identifier.
+    # @param [FotaV3CallbackRegistrationRequest] body Required parameter:
+    # Callback URL registration.
+    # @return [FotaV3CallbackRegistrationResult] response from the API call
+    def update_callback(acc,
+                        body)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/callbacks/{acc}',
+                                     Server::SOFTWARE_MANAGEMENT_V3)
+                   .template_param(new_parameter(acc, key: 'acc')
+                                    .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('oAuth2')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(FotaV3CallbackRegistrationResult.method(:from_hash))
+                   .is_api_response(true)
+                   .local_error('400',
+                                'Unexpected error.',
+                                FotaV3ResultException))
+        .execute
+    end
+
+    # This endpoint allows the user to create the HTTPS callback address.
+    # @param [String] acc Required parameter: Account identifier.
+    # @param [FotaV3CallbackRegistrationRequest] body Required parameter:
+    # Callback URL registration.
+    # @return [FotaV3CallbackRegistrationResult] response from the API call
+    def register_callback(acc,
+                          body)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/callbacks/{acc}',
+                                     Server::SOFTWARE_MANAGEMENT_V3)
+                   .template_param(new_parameter(acc, key: 'acc')
+                                    .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('oAuth2')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(FotaV3CallbackRegistrationResult.method(:from_hash))
+                   .is_api_response(true)
+                   .local_error('400',
+                                'Unexpected error.',
+                                FotaV3ResultException))
+        .execute
+    end
+
+    # This endpoint allows user to delete a previously registered callback URL.
+    # @param [String] acc Required parameter: Account identifier.
+    # @return [FotaV3SuccessResult] response from the API call
+    def deregister_callback(acc)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/callbacks/{acc}',
+                                     Server::SOFTWARE_MANAGEMENT_V3)
+                   .template_param(new_parameter(acc, key: 'acc')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('oAuth2')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(FotaV3SuccessResult.method(:from_hash))
+                   .is_api_response(true)
+                   .local_error('400',
+                                'Unexpected error.',
+                                FotaV3ResultException))
+        .execute
+    end
+  end
+end