specs-sdk 1.3.0

data/lib/verizon/controllers/m_5g_edge_platforms_controller.rb

@@ -0,0 +1,87 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # M5gEdgePlatformsController
+  class M5gEdgePlatformsController < BaseController
+    # Returns a list of optimal MEC Platforms where you can register your
+    # deployed application. **Note:** If a query is sent with all of the
+    # parameters, it will fail with a "400" error. You can search based on the
+    # following parameter combinations - region plus Service Profile ID and
+    # subscriber density (density is optional but recommended), region plus
+    # UEIdentity(Including UEIdentity Type) or Service Profile ID plus
+    # UEIdentity(Including UEIdentity Type).
+    # @param [String] region Optional parameter: MEC region name. Current valid
+    # values are US_WEST_2 and US_EAST_1.
+    # @param [String] service_profile_id Optional parameter: Unique identifier
+    # of the service profile.
+    # @param [Integer] subscriber_density Optional parameter: Minimum number of
+    # 4G/5G subscribers per square kilometer.
+    # @param [UserEquipmentIdentityTypeEnum] ue_identity_type Optional
+    # parameter: Type of User Equipment identifier used in `UEIdentity`.
+    # @param [String] ue_identity Optional parameter: The identifier value for
+    # User Equipment. The type of identifier is defined by the 'UEIdentityType'
+    # parameter. The`IPAddress`format can be IPv4 or IPv6.
+    # @return [ListMECPlatformsResult] response from the API call
+    def list_mec_platforms(region: nil,
+                           service_profile_id: nil,
+                           subscriber_density: nil,
+                           ue_identity_type: nil,
+                           ue_identity: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/mecplatforms',
+                                     Server::EDGE_DISCOVERY)
+                   .query_param(new_parameter(region, key: 'region'))
+                   .query_param(new_parameter(service_profile_id, key: 'serviceProfileId'))
+                   .query_param(new_parameter(subscriber_density, key: 'subscriberDensity'))
+                   .query_param(new_parameter(ue_identity_type, key: 'UEIdentityType'))
+                   .query_param(new_parameter(ue_identity, key: 'UEIdentity'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('oAuth2')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(ListMECPlatformsResult.method(:from_hash))
+                   .is_api_response(true)
+                   .local_error('400',
+                                'HTTP 400 Bad Request.',
+                                EdgeDiscoveryResultException)
+                   .local_error('401',
+                                'HTTP 401 Unauthorized.',
+                                EdgeDiscoveryResultException)
+                   .local_error('default',
+                                'HTTP 500 Internal Server Error.',
+                                EdgeDiscoveryResultException))
+        .execute
+    end
+
+    # List the geographical regions available, based on the user's bearer token.
+    # **Note:** Country code, Metropolitan area, Area and Zone are future
+    # functionality and will currently return a "null" value.
+    # @return [ListRegionsResult] response from the API call
+    def list_regions
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/regions',
+                                     Server::EDGE_DISCOVERY)
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('oAuth2')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(ListRegionsResult.method(:from_hash))
+                   .is_api_response(true)
+                   .local_error('400',
+                                'HTTP 400 Bad Request.',
+                                EdgeDiscoveryResultException)
+                   .local_error('401',
+                                'HTTP 401 Unauthorized.',
+                                EdgeDiscoveryResultException)
+                   .local_error('default',
+                                'HTTP 500 Internal Server Error.',
+                                EdgeDiscoveryResultException))
+        .execute
+    end
+  end
+end

data/lib/verizon/controllers/managing_esim_profiles_controller.rb

@@ -0,0 +1,154 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # ManagingESIMProfilesController
+  class ManagingESIMProfilesController < BaseController
+    # Activate a device with either a lead or local profile.
+    # @param [GIOProfileRequest] body Required parameter: Device Profile Query
+    # @return [GIORequestResponse] response from the API call
+    def activate_a_device_profile(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(GIORequestResponse.method(:from_hash))
+                   .is_api_response(true)
+                   .local_error('default',
+                                'Error response',
+                                GIORestErrorResponseException))
+        .execute
+    end
+
+    # Enable a device lead or local profile.
+    # @param [DeviceProfileRequest] body Required parameter: Device Profile
+    # Query
+    # @return [GIORequestResponse] response from the API call
+    def enable_a_device_profile(body)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/m2m/v1/devices/profile/actions/enable',
+                                     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(GIORequestResponse.method(:from_hash))
+                   .is_api_response(true)
+                   .local_error('default',
+                                'Error response',
+                                GIORestErrorResponseException))
+        .execute
+    end
+
+    # Deactivate the lead or local profile. **Note:** to reactivate the profile,
+    # use the **Activate** endpoint above.
+    # @param [GIODeactivateDeviceProfileRequest] body Required parameter: Device
+    # Profile Query
+    # @return [GIORequestResponse] response from the API call
+    def deactivate_a_device_profile(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(GIORequestResponse.method(:from_hash))
+                   .is_api_response(true)
+                   .local_error('default',
+                                'Error response',
+                                GIORestErrorResponseException))
+        .execute
+    end
+
+    # Enable the Global IoT Orchestration device profile for download.
+    # @param [DeviceProfileRequest] body Required parameter: Device Profile
+    # Query
+    # @return [GIORequestResponse] response from the API call
+    def enable_a_device_profile_for_download(body)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/m2m/v1/devices/profile/actions/download_enable',
+                                     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(GIORequestResponse.method(:from_hash))
+                   .is_api_response(true)
+                   .local_error('default',
+                                'Error response',
+                                GIORestErrorResponseException))
+        .execute
+    end
+
+    # Download a Global IoT Orchestration device profile.
+    # @param [DeviceProfileRequest] body Required parameter: Device Profile
+    # Query
+    # @return [GIORequestResponse] response from the API call
+    def download_a_device_profile(body)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/m2m/v1/devices/profile/actions/download',
+                                     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(GIORequestResponse.method(:from_hash))
+                   .is_api_response(true)
+                   .local_error('default',
+                                'Error response',
+                                GIORestErrorResponseException))
+        .execute
+    end
+
+    # Delete a device profile for Global IoT Orchestration. **Note:** the
+    # profile must be deactivated first!
+    # @param [DeviceProfileRequest] body Required parameter: Device Profile
+    # Query
+    # @return [GIORequestResponse] response from the API call
+    def delete_a_device_profile(body)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/m2m/v1/devices/profile/actions/delete',
+                                     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(GIORequestResponse.method(:from_hash))
+                   .is_api_response(true)
+                   .local_error('default',
+                                'Error response',
+                                GIORestErrorResponseException))
+        .execute
+    end
+  end
+end

data/lib/verizon/controllers/mec_controller.rb

@@ -0,0 +1,150 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # MECController
+  class MECController < BaseController
+    # TODO: type endpoint description here
+    # @param [String] aname Required parameter: Account name.
+    # @return [KPIInfoList] response from the API call
+    def kpi_list(aname)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/m2m/v1/devices/mec/kpi/list/{aname}',
+                                     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(KPIInfoList.method(:from_hash))
+                   .is_api_response(true))
+        .execute
+    end
+
+    # TODO: type endpoint description here
+    # @param [String] aname Required parameter: Account name.
+    # @return [MECProfileList] response from the API call
+    def get_profile_list(aname)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/m2m/v1/devices/mec/profiles/list/{aname}',
+                                     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(MECProfileList.method(:from_hash))
+                   .is_api_response(true))
+        .execute
+    end
+
+    # TODO: type endpoint description here
+    # @param [ChangePmecDeviceStateActivateRequest] body Required parameter:
+    # Example:
+    # @return [ChangeMecDeviceStateResponse] response from the API call
+    def change_pmec_device_state_activate(body)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/m2m/v1/devices/mec/actions/state/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(ChangeMecDeviceStateResponse.method(:from_hash))
+                   .is_api_response(true))
+        .execute
+    end
+
+    # TODO: type endpoint description here
+    # @param [ChangePmecDeviceStateBulkDeactivateRequest] body Required
+    # parameter: Example:
+    # @return [ChangeMecDeviceStateResponse] response from the API call
+    def change_pmec_device_state_bulk_deactivate(body)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/m2m/v1/devices/mec/actions/state/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(ChangeMecDeviceStateResponse.method(:from_hash))
+                   .is_api_response(true))
+        .execute
+    end
+
+    # TODO: type endpoint description here
+    # @param [ChangePmecDeviceProfileRequest] body Required parameter:
+    # Example:
+    # @return [ChangeMecDeviceProfileResponse] response from the API call
+    def change_pmec_device_profile(body)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/m2m/v1/devices/mec/actions/profile',
+                                     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(ChangeMecDeviceProfileResponse.method(:from_hash))
+                   .is_api_response(true))
+        .execute
+    end
+
+    # TODO: type endpoint description here
+    # @param [ChangePmecDeviceStateBulkDeactivateRequest] body Required
+    # parameter: Example:
+    # @return [ChangeMecDeviceIPAddressResponse] response from the API call
+    def change_pmec_device_i_paddress_bulk(body)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/m2m/v1/devices/mec/actions/ipaddress',
+                                     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(ChangeMecDeviceIPAddressResponse.method(:from_hash))
+                   .is_api_response(true))
+        .execute
+    end
+
+    # TODO: type endpoint description here
+    # @param [String] aname Required parameter: Account name.
+    # @return [GetMECPerformanceConsentResponse] response from the API call
+    def get_mec_performance_consent(aname)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/m2m/v1/devices/mec/performance/consent/{aname}',
+                                     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(GetMECPerformanceConsentResponse.method(:from_hash))
+                   .is_api_response(true))
+        .execute
+    end
+  end
+end

data/lib/verizon/controllers/oauth_authorization_controller.rb

@@ -0,0 +1,77 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # OauthAuthorizationController
+  class OauthAuthorizationController < BaseController
+    # Create a new OAuth 2 token.
+    # @param [String] authorization Required parameter: Authorization header in
+    # Basic auth format
+    # @param [String] scope Optional parameter: Requested scopes as a
+    # space-delimited list.
+    # @param [Hash] _field_parameters Additional optional form parameters are
+    # supported by this endpoint.
+    # @return [OauthToken] response from the API call
+    def request_token_oauth_2(authorization,
+                              scope: nil,
+                              _field_parameters: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/oauth2/token',
+                                     Server::OAUTH_SERVER)
+                   .form_param(new_parameter('client_credentials', key: 'grant_type'))
+                   .header_param(new_parameter(authorization, key: 'Authorization'))
+                   .form_param(new_parameter(scope, key: 'scope'))
+                   .header_param(new_parameter('application/x-www-form-urlencoded', key: 'content-type'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .additional_form_params(_field_parameters))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(OauthToken.method(:from_hash))
+                   .is_api_response(true)
+                   .local_error('400',
+                                'OAuth 2 provider returned an error.',
+                                OauthProviderException)
+                   .local_error('401',
+                                'OAuth 2 provider says client authentication failed.',
+                                OauthProviderException))
+        .execute
+    end
+
+    # Create a new OAuth 2 token.
+    # @param [String] authorization Required parameter: Authorization header in
+    # Basic auth format
+    # @param [String] scope Optional parameter: Requested scopes as a
+    # space-delimited list.
+    # @param [Hash] _field_parameters Additional optional form parameters are
+    # supported by this endpoint.
+    # @return [OauthToken] response from the API call
+    def request_token_thingspace_oauth(authorization,
+                                       scope: nil,
+                                       _field_parameters: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/ts/v1/oauth2/token',
+                                     Server::THINGSPACE)
+                   .form_param(new_parameter('client_credentials', key: 'grant_type'))
+                   .header_param(new_parameter(authorization, key: 'Authorization'))
+                   .form_param(new_parameter(scope, key: 'scope'))
+                   .header_param(new_parameter('application/x-www-form-urlencoded', key: 'content-type'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .additional_form_params(_field_parameters))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(OauthToken.method(:from_hash))
+                   .is_api_response(true)
+                   .local_error('400',
+                                'OAuth 2 provider returned an error.',
+                                OauthProviderException)
+                   .local_error('401',
+                                'OAuth 2 provider says client authentication failed.',
+                                OauthProviderException))
+        .execute
+    end
+  end
+end

data/lib/verizon/controllers/performance_metrics_controller.rb

@@ -0,0 +1,49 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # PerformanceMetricsController
+  class PerformanceMetricsController < BaseController
+    # Query the most recent data for Key Performance Indicators (KPIs) like
+    # network availability, MEC hostnames and more.
+    # @param [QueryMECPerformanceMetricsRequest] body Optional parameter:
+    # Example:
+    # @return [MECPerformanceMetrics] response from the API call
+    def query_mec_performance_metrics(body: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/performance/device/network/metrics',
+                                     Server::PERFORMANCE)
+                   .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(MECPerformanceMetrics.method(:from_hash))
+                   .is_api_response(true)
+                   .local_error('400',
+                                'Bad Request.',
+                                EdgePerformanceResultException)
+                   .local_error('401',
+                                'Unauthorized request.',
+                                EdgePerformanceResultException)
+                   .local_error('403',
+                                'Request forbidden.',
+                                EdgePerformanceResultException)
+                   .local_error('404',
+                                'Resource Not Found.',
+                                EdgePerformanceResultException)
+                   .local_error('405',
+                                'Method Not Allowed.',
+                                EdgePerformanceResultException)
+                   .local_error('503',
+                                'Service Unavailable.',
+                                EdgePerformanceResultException))
+        .execute
+    end
+  end
+end

data/lib/verizon/controllers/promotion_period_information_controller.rb

@@ -0,0 +1,58 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # PromotionPeriodInformationController
+  class PromotionPeriodInformationController < BaseController
+    # Retrieves the usage history of a device during the promotion period.
+    # @param [RequestBodyForUsage1] body Required parameter: Retrieve Aggregate
+    # Usage
+    # @return [ResponseToUsageQuery] response from the API call
+    def get_promo_device_usage_history(body)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/m2m/v1/devices/usage/actions/promodeviceusage',
+                                     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(ResponseToUsageQuery.method(:from_hash))
+                   .is_api_response(true)
+                   .local_error('default',
+                                'All error responses will be in this format',
+                                ReadySimRestErrorResponseException))
+        .execute
+    end
+
+    # Retrieves the aggregate usage for an account using pseudo-MDN during the
+    # promotional period using a callback.
+    # @param [RequestBodyForUsage] body Required parameter: Retrieve Aggregate
+    # Usage
+    # @return [UsageRequestResponse] response from the API call
+    def get_promo_device_aggregate_usage_history(body)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/m2m/v1/devices/usage/actions/promoaggregateusage',
+                                     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(UsageRequestResponse.method(:from_hash))
+                   .is_api_response(true)
+                   .local_error('default',
+                                'Error response',
+                                ReadySimRestErrorResponseException))
+        .execute
+    end
+  end
+end