thingspace-payments-sdk-sdk 1.3.0

data/lib/verizon/controllers/software_management_licenses_v2_controller.rb

@@ -0,0 +1,177 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # SoftwareManagementLicensesV2Controller
+  class SoftwareManagementLicensesV2Controller < BaseController
+    # The endpoint allows user to list license usage.
+    # @param [String] account Required parameter: Account identifier.
+    # @param [String] last_seen_device_id Optional parameter: Last seen device
+    # identifier.
+    # @return [V2LicenseSummary] response from the API call
+    def get_account_license_status(account,
+                                   last_seen_device_id: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/licenses/{account}',
+                                     Server::SOFTWARE_MANAGEMENT_V2)
+                   .template_param(new_parameter(account, key: 'account')
+                                    .should_encode(true))
+                   .query_param(new_parameter(last_seen_device_id, key: 'lastSeenDeviceId'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('oAuth2')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(V2LicenseSummary.method(:from_hash))
+                   .is_api_response(true)
+                   .local_error('400',
+                                'Unexpected error.',
+                                FotaV2ResultException))
+        .execute
+    end
+
+    # This endpoint allows user to assign licenses to a list of devices.
+    # @param [String] account Required parameter: Account identifier.
+    # @param [V2LicenseIMEI] body Required parameter: License assignment.
+    # @return [V2LicensesAssignedRemovedResult] response from the API call
+    def assign_licenses_to_devices(account,
+                                   body)
+      warn 'Endpoint assign_licenses_to_devices in SoftwareManagementLicensesV'\
+           '2Controller is deprecated'
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/licenses/{account}/assign',
+                                     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(V2LicensesAssignedRemovedResult.method(:from_hash))
+                   .is_api_response(true)
+                   .local_error('400',
+                                'Unexpected error.',
+                                FotaV2ResultException))
+        .execute
+    end
+
+    # This endpoint allows user to remove licenses from a list of devices.
+    # @param [String] account Required parameter: Account identifier.
+    # @param [V2LicenseIMEI] body Required parameter: License removal.
+    # @return [V2LicensesAssignedRemovedResult] response from the API call
+    def remove_licenses_from_devices(account,
+                                     body)
+      warn 'Endpoint remove_licenses_from_devices in SoftwareManagementLicense'\
+           'sV2Controller is deprecated'
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/licenses/{account}/remove',
+                                     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(V2LicensesAssignedRemovedResult.method(:from_hash))
+                   .is_api_response(true)
+                   .local_error('400',
+                                'Unexpected error.',
+                                FotaV2ResultException))
+        .execute
+    end
+
+    # The license cancel endpoint allows user to list registered license
+    # cancellation candidate devices.
+    # @param [String] account Required parameter: Account identifier.
+    # @param [String] start_index Optional parameter: Start index to retrieve.
+    # @return [V2ListOfLicensesToRemove] response from the API call
+    def list_licenses_to_remove(account,
+                                start_index: nil)
+      warn 'Endpoint list_licenses_to_remove in SoftwareManagementLicensesV2Co'\
+           'ntroller is deprecated'
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/licenses/{account}/cancel',
+                                     Server::SOFTWARE_MANAGEMENT_V2)
+                   .template_param(new_parameter(account, key: 'account')
+                                    .should_encode(true))
+                   .query_param(new_parameter(start_index, key: 'startIndex'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('oAuth2')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(V2ListOfLicensesToRemove.method(:from_hash))
+                   .is_api_response(true)
+                   .local_error('400',
+                                'Unexpected error.',
+                                FotaV2ResultException))
+        .execute
+    end
+
+    # The license cancel endpoint allows user to create a list of license
+    # cancellation candidate devices.
+    # @param [String] account Required parameter: Account identifier.
+    # @param [V2ListOfLicensesToRemoveRequest] body Required parameter: List of
+    # licensess to remove.
+    # @return [V2ListOfLicensesToRemoveResult] response from the API call
+    def create_list_of_licenses_to_remove(account,
+                                          body)
+      warn 'Endpoint create_list_of_licenses_to_remove in SoftwareManagementLi'\
+           'censesV2Controller is deprecated'
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/licenses/{account}/cancel',
+                                     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(V2ListOfLicensesToRemoveResult.method(:from_hash))
+                   .is_api_response(true)
+                   .local_error('400',
+                                'Unexpected error.',
+                                FotaV2ResultException))
+        .execute
+    end
+
+    # This endpoint allows user to delete a created cancel candidate device
+    # list.
+    # @param [String] account Required parameter: Account identifier.
+    # @return [FotaV2SuccessResult] response from the API call
+    def delete_list_of_licenses_to_remove(account)
+      warn 'Endpoint delete_list_of_licenses_to_remove in SoftwareManagementLi'\
+           'censesV2Controller is deprecated'
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/licenses/{account}/cancel',
+                                     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_licenses_v3_controller.rb

@@ -0,0 +1,89 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # SoftwareManagementLicensesV3Controller
+  class SoftwareManagementLicensesV3Controller < BaseController
+    # The endpoint allows user to list license usage.
+    # @param [String] acc Required parameter: Account identifier.
+    # @param [String] last_seen_device_id Optional parameter: Last seen device
+    # identifier.
+    # @return [V3LicenseSummary] response from the API call
+    def get_account_licenses_status(acc,
+                                    last_seen_device_id: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/licenses/{acc}',
+                                     Server::SOFTWARE_MANAGEMENT_V3)
+                   .template_param(new_parameter(acc, key: 'acc')
+                                    .should_encode(true))
+                   .query_param(new_parameter(last_seen_device_id, key: 'lastSeenDeviceId'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('oAuth2')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(V3LicenseSummary.method(:from_hash))
+                   .is_api_response(true)
+                   .local_error('400',
+                                'Unexpected error.',
+                                FotaV3ResultException))
+        .execute
+    end
+
+    # This endpoint allows user to assign licenses to a list of devices.
+    # @param [String] acc Required parameter: Account identifier.
+    # @param [V3LicenseIMEI] body Required parameter: License assignment.
+    # @return [V3LicenseAssignedRemovedResult] response from the API call
+    def assign_licenses_to_devices(acc,
+                                   body)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/licenses/{acc}/assign',
+                                     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(V3LicenseAssignedRemovedResult.method(:from_hash))
+                   .is_api_response(true)
+                   .local_error('400',
+                                'Unexpected error.',
+                                FotaV3ResultException))
+        .execute
+    end
+
+    # This endpoint allows user to remove licenses from a list of devices.
+    # @param [String] acc Required parameter: Account identifier.
+    # @param [V3LicenseIMEI] body Required parameter: License removal.
+    # @return [V3LicenseAssignedRemovedResult] response from the API call
+    def remove_licenses_from_devices(acc,
+                                     body)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/licenses/{acc}/remove',
+                                     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(V3LicenseAssignedRemovedResult.method(:from_hash))
+                   .is_api_response(true)
+                   .local_error('400',
+                                'Unexpected error.',
+                                FotaV3ResultException))
+        .execute
+    end
+  end
+end

data/lib/verizon/controllers/software_management_reports_v1_controller.rb

@@ -0,0 +1,105 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # SoftwareManagementReportsV1Controller
+  class SoftwareManagementReportsV1Controller < BaseController
+    # Returns an array of all devices in the specified account. Each device
+    # object includes information needed for managing firmware, including the
+    # device make and model, MDN and IMEI, and current firmware version.
+    # @param [String] account Required parameter: Account identifier in
+    # "##########-#####".
+    # @param [String] start_index Required parameter: Only return devices with
+    # IMEIs larger than this value. Use 0 for the first request. If
+    # `hasMoreData`=true in the response, use the `lastSeenDeviceId` value from
+    # the response as the startIndex in the next request.
+    # @return [DeviceListQueryResult] response from the API call
+    def list_account_devices(account,
+                             start_index)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/devices/{account}/index/{startIndex}',
+                                     Server::SOFTWARE_MANAGEMENT_V1)
+                   .template_param(new_parameter(account, key: 'account')
+                                    .should_encode(true))
+                   .template_param(new_parameter(start_index, key: 'startIndex')
+                                    .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(DeviceListQueryResult.method(:from_hash))
+                   .is_api_response(true)
+                   .local_error('400',
+                                'Unexpected error.',
+                                FotaV1ResultException))
+        .execute
+    end
+
+    # Returns a list of all upgrades with a specified status.
+    # @param [String] account Required parameter: Account identifier in
+    # "##########-#####".
+    # @param [UpgradeStatusEnum] upgrade_status Required parameter: The status
+    # of the upgrades that you want to retrieve.
+    # @param [String] start_index Required parameter: The zero-based number of
+    # the first record to return. Set startIndex=0 for the first request. If
+    # `hasMoreFlag`=true in the response, use the `lastSeenUpgradeId` value from
+    # the response as the startIndex in the next request.
+    # @return [UpgradeListQueryResult] response from the API call
+    def list_upgrades_for_specified_status(account,
+                                           upgrade_status,
+                                           start_index)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/reports/{account}/status/{upgradeStatus}/index/{startIndex}',
+                                     Server::SOFTWARE_MANAGEMENT_V1)
+                   .template_param(new_parameter(account, key: 'account')
+                                    .should_encode(true))
+                   .template_param(new_parameter(upgrade_status, key: 'upgradeStatus')
+                                    .should_encode(true))
+                   .template_param(new_parameter(start_index, key: 'startIndex')
+                                    .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(UpgradeListQueryResult.method(:from_hash))
+                   .is_api_response(true)
+                   .local_error('400',
+                                'Unexpected error.',
+                                FotaV1ResultException))
+        .execute
+    end
+
+    # Returns the upgrade history of the specified device from the previous six
+    # months.
+    # @param [String] account Required parameter: Account identifier in
+    # "##########-#####".
+    # @param [String] device_id Required parameter: The IMEI of the device.
+    # @return [Array[DeviceUpgradeHistory]] response from the API call
+    def get_device_firmware_upgrade_history(account,
+                                            device_id)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/reports/{account}/devices/{deviceId}',
+                                     Server::SOFTWARE_MANAGEMENT_V1)
+                   .template_param(new_parameter(account, key: 'account')
+                                    .should_encode(true))
+                   .template_param(new_parameter(device_id, key: 'deviceId')
+                                    .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(DeviceUpgradeHistory.method(:from_hash))
+                   .is_api_response(true)
+                   .is_response_array(true)
+                   .local_error('400',
+                                'Unexpected error.',
+                                FotaV1ResultException))
+        .execute
+    end
+  end
+end

data/lib/verizon/controllers/software_management_reports_v2_controller.rb

@@ -0,0 +1,159 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # SoftwareManagementReportsV2Controller
+  class SoftwareManagementReportsV2Controller < BaseController
+    # This endpoint allows user to list a certain type of software of an
+    # account.
+    # @param [String] account Required parameter: Account identifier.
+    # @param [String] distribution_type Optional parameter: Filter
+    # distributionType to get specific type of software. Value is LWM2M, OMD-DM
+    # or HTTP.
+    # @return [Array[SoftwarePackage]] response from the API call
+    def list_available_software(account,
+                                distribution_type: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/software/{account}',
+                                     Server::SOFTWARE_MANAGEMENT_V2)
+                   .template_param(new_parameter(account, key: 'account')
+                                    .should_encode(true))
+                   .query_param(new_parameter(distribution_type, key: 'distributionType'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('oAuth2')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(SoftwarePackage.method(:from_hash))
+                   .is_api_response(true)
+                   .is_response_array(true)
+                   .local_error('400',
+                                'Unexpected error.',
+                                FotaV2ResultException))
+        .execute
+    end
+
+    # The device endpoint gets devices information of an account.
+    # @param [String] account Required parameter: Account identifier.
+    # @param [String] last_seen_device_id Optional parameter: Last seen device
+    # identifier.
+    # @param [String] distribution_type Optional parameter: Filter
+    # distributionType to get specific type of devices. Values is LWM2M, OMD-DM
+    # or HTTP.
+    # @return [V2AccountDeviceList] response from the API call
+    def list_account_devices(account,
+                             last_seen_device_id: nil,
+                             distribution_type: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/devices/{account}',
+                                     Server::SOFTWARE_MANAGEMENT_V2)
+                   .template_param(new_parameter(account, key: 'account')
+                                    .should_encode(true))
+                   .query_param(new_parameter(last_seen_device_id, key: 'lastSeenDeviceId'))
+                   .query_param(new_parameter(distribution_type, key: 'distributionType'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('oAuth2')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(V2AccountDeviceList.method(:from_hash))
+                   .is_api_response(true)
+                   .local_error('400',
+                                'Unexpected error.',
+                                FotaV2ResultException))
+        .execute
+    end
+
+    # The endpoint allows user to get software upgrade history of a device based
+    # on device IMEI.
+    # @param [String] account Required parameter: Account identifier.
+    # @param [String] device_id Required parameter: Device IMEI identifier.
+    # @return [Array[DeviceSoftwareUpgrade]] response from the API call
+    def get_device_firmware_upgrade_history(account,
+                                            device_id)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/reports/{account}/devices/{deviceId}',
+                                     Server::SOFTWARE_MANAGEMENT_V2)
+                   .template_param(new_parameter(account, key: 'account')
+                                    .should_encode(true))
+                   .template_param(new_parameter(device_id, key: 'deviceId')
+                                    .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(DeviceSoftwareUpgrade.method(:from_hash))
+                   .is_api_response(true)
+                   .is_response_array(true)
+                   .local_error('400',
+                                'Unexpected error.',
+                                FotaV2ResultException))
+        .execute
+    end
+
+    # The report endpoint allows user to get campaign history of an account for
+    # specified status.
+    # @param [String] account Required parameter: Account identifier.
+    # @param [String] campaign_status Required parameter: Status of the
+    # campaign.
+    # @param [String] last_seen_campaign_id Optional parameter: Last seen
+    # campaign Id.
+    # @return [V2CampaignHistory] response from the API call
+    def get_campaign_history_by_status(account,
+                                       campaign_status,
+                                       last_seen_campaign_id: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/reports/{account}/campaigns',
+                                     Server::SOFTWARE_MANAGEMENT_V2)
+                   .template_param(new_parameter(account, key: 'account')
+                                    .should_encode(true))
+                   .query_param(new_parameter(campaign_status, key: 'campaignStatus'))
+                   .query_param(new_parameter(last_seen_campaign_id, key: 'lastSeenCampaignId'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('oAuth2')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(V2CampaignHistory.method(:from_hash))
+                   .is_api_response(true)
+                   .local_error('400',
+                                'Unexpected error.',
+                                FotaV2ResultException))
+        .execute
+    end
+
+    # The report endpoint allows user to get the full list of device of a
+    # campaign.
+    # @param [String] account Required parameter: Account identifier.
+    # @param [String] campaign_id Required parameter: Campaign identifier.
+    # @param [String] last_seen_device_id Optional parameter: Last seen device
+    # identifier.
+    # @return [V2CampaignDevice] response from the API call
+    def get_campaign_device_status(account,
+                                   campaign_id,
+                                   last_seen_device_id: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/reports/{account}/campaigns/{campaignId}/devices',
+                                     Server::SOFTWARE_MANAGEMENT_V2)
+                   .template_param(new_parameter(account, key: 'account')
+                                    .should_encode(true))
+                   .template_param(new_parameter(campaign_id, key: 'campaignId')
+                                    .should_encode(true))
+                   .query_param(new_parameter(last_seen_device_id, key: 'lastSeenDeviceId'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('oAuth2')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(V2CampaignDevice.method(:from_hash))
+                   .is_api_response(true)
+                   .local_error('400',
+                                'Unexpected error.',
+                                FotaV2ResultException))
+        .execute
+    end
+  end
+end

data/lib/verizon/controllers/software_management_reports_v3_controller.rb

@@ -0,0 +1,98 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # SoftwareManagementReportsV3Controller
+  class SoftwareManagementReportsV3Controller < BaseController
+    # Retrieve a list of campaigns for an account that have a specified campaign
+    # status.
+    # @param [String] acc Required parameter: Account identifier.
+    # @param [CampaignStatusEnum] campaign_status Required parameter: Campaign
+    # status.
+    # @param [String] last_seen_campaign_id Optional parameter: Last seen
+    # campaign Id.
+    # @return [V3CampaignHistory] response from the API call
+    def get_campaign_history_by_status(acc,
+                                       campaign_status,
+                                       last_seen_campaign_id: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/reports/{acc}/firmware/campaigns',
+                                     Server::SOFTWARE_MANAGEMENT_V3)
+                   .template_param(new_parameter(acc, key: 'acc')
+                                    .should_encode(true))
+                   .query_param(new_parameter(campaign_status, key: 'campaignStatus'))
+                   .query_param(new_parameter(last_seen_campaign_id, key: 'lastSeenCampaignId'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('oAuth2')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(V3CampaignHistory.method(:from_hash))
+                   .is_api_response(true)
+                   .local_error('400',
+                                'Unexpected error.',
+                                FotaV3ResultException))
+        .execute
+    end
+
+    # Retrieve campaign history for a specific device.
+    # @param [String] acc Required parameter: Account identifier.
+    # @param [String] device_id Required parameter: Device IMEI identifier.
+    # @return [Array[DeviceFirmwareUpgrade]] response from the API call
+    def get_device_firmware_upgrade_history(acc,
+                                            device_id)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/reports/{acc}/devices/{deviceId}',
+                                     Server::SOFTWARE_MANAGEMENT_V3)
+                   .template_param(new_parameter(acc, key: 'acc')
+                                    .should_encode(true))
+                   .template_param(new_parameter(device_id, key: 'deviceId')
+                                    .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(DeviceFirmwareUpgrade.method(:from_hash))
+                   .is_api_response(true)
+                   .is_response_array(true)
+                   .local_error('400',
+                                'Unexpected error.',
+                                FotaV3ResultException))
+        .execute
+    end
+
+    # Retrieve a list of all devices in a campaign and the status of each
+    # device.
+    # @param [String] acc Required parameter: Account identifier.
+    # @param [String] campaign_id Required parameter: Campaign identifier.
+    # @param [String] last_seen_device_id Optional parameter: Last seen device
+    # identifier.
+    # @return [V3CampaignDevice] response from the API call
+    def get_campaign_device_status(acc,
+                                   campaign_id,
+                                   last_seen_device_id: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/reports/{acc}/campaigns/{campaignId}/devices',
+                                     Server::SOFTWARE_MANAGEMENT_V3)
+                   .template_param(new_parameter(acc, key: 'acc')
+                                    .should_encode(true))
+                   .template_param(new_parameter(campaign_id, key: 'campaignId')
+                                    .should_encode(true))
+                   .query_param(new_parameter(last_seen_device_id, key: 'lastSeenDeviceId'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('oAuth2')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(V3CampaignDevice.method(:from_hash))
+                   .is_api_response(true)
+                   .local_error('400',
+                                'Unexpected error.',
+                                FotaV3ResultException))
+        .execute
+    end
+  end
+end