sdksio-verizon-apis-sdk 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 303a35540fc884f9766180d715337f8fb51e0f88da04fc400bdb3e74430d1d05
-  data.tar.gz: 719753729a95a1c0f6a99a0700413b98174e9ea94925651d1c0ff6b7e7a97739
+  metadata.gz: 5ecca227e0ea0d2db2d9e3170bb5a8f7b60d28c1d7c63532c151de7589305be6
+  data.tar.gz: '09486fca309108152271d4955099dd8aa528a3f21ccd6aee0b662da985f1989e'
 SHA512:
-  metadata.gz: 65216c50bb05331957ca9c78d9d43458cf5983ace09055ffdcd289b84a18646d85a4a9d0d0e8e3091ecda70fba462eb7a6850ca4f897841a54635675daf2f92f
-  data.tar.gz: 1e009853157d53b1e9f93d91b69652345216e4e10c8058d494fb39c9ee87a62cee1753d2c429f7491b0d380b1ee678ef0491fb41a67e3e11a8ac2696102ff046
+  metadata.gz: bc103f0b4a0c9fdc4f0a198bf44fdd8265788500cf3005e3d3b843e1d04d9c549066dd7f197bdc4dc015fa4f3e28c2580cacb8c6b43843d1ee9d331ae3c08040
+  data.tar.gz: 475d8cb0d25b75d1591e9bc37b5ef37e2036119ca3e4e76e728274177e26dd44e0ee62093c0215a7e852b42d7a766d3f8ecc47dfa95d1cb5849a0c4443b4ff34

data/LICENSE

@@ -1,9 +1,11 @@
-License: 
+This SDK was generated by APIMATIC for Verizon.
+
+License:
 ========
 The MIT License (MIT)
 http://opensource.org/licenses/MIT
 
-Copyright (c) 2014 - 2024 APIMATIC Limited
+Copyright (c) 2014 - 2023 APIMATIC Limited
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,43 +1,36 @@
 
-# Getting Started with Verizon ThingSpace Quality of Service API endpoints
+# Getting Started with Verizon
 
 ## Introduction
 
-These are the endpoints to subscribe to and end the subscription for Verizon's ThingSpace Quality of Service API. These endpoints use Service Capability Exposure Function or SCEF, and rely on callbacks for asynchronous requests. **Note:** This example is in YAML and will need to be converted to JSON to use as a spec file.
+The Verizon Edge Discovery Service API can direct your application clients to connect to the optimal service endpoints for your Multi-access Edge Computing (MEC) applications for every session. The Edge Discovery Service takes into account the current location of a device, its IP anchor location, current network traffic and other factors to determine which 5G Edge platform a device should connect to.
+
+Verizon Terms of Service: [https://www.verizon.com/business/5g-edge-portal/legal.html](https://www.verizon.com/business/5g-edge-portal/legal.html)
 
 ## Install the Package
 
 Install the gem from the command line:
 
 ```ruby
-gem install sdksio-verizon-apis-sdk -v 1.6.0
+gem install sdksio-verizon-apis-sdk -v 1.7.0
 ```
 
 Or add the gem to your Gemfile and run `bundle`:
 
 ```ruby
-gem 'sdksio-verizon-apis-sdk', '1.6.0'
+gem 'sdksio-verizon-apis-sdk', '1.7.0'
 ```
 
-For additional gem details, see the [RubyGems page for the sdksio-verizon-apis-sdk gem](https://rubygems.org/gems/sdksio-verizon-apis-sdk/versions/1.6.0).
-
-## Test the SDK
-
-To run the tests, navigate to the root directory of the SDK in your terminal and execute the following command:
-
-```
-rake
-```
+For additional gem details, see the [RubyGems page for the sdksio-verizon-apis-sdk gem](https://rubygems.org/gems/sdksio-verizon-apis-sdk/versions/1.7.0).
 
 ## Initialize the API Client
 
-**_Note:_** Documentation for the client can be found [here.](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.6.0/doc/client.md)
+**_Note:_** Documentation for the client can be found [here.](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.7.0/doc/client.md)
 
 The following parameters are configurable for the API Client:
 
 | Parameter | Type | Description |
 |  --- | --- | --- |
-| `vz_m_2_m_token` | `String` | The VZ-M2M session token from [Getting Started](/content/thingspace-portal/documentation/apis/connectivity-management/get-started.html) |
 | `environment` | `Environment` | The API environment. <br> **Default: `Environment.PRODUCTION`** |
 | `connection` | `Faraday::Connection` | The Faraday connection object passed by the SDK user for making requests |
 | `adapter` | `Faraday::Adapter` | The Faraday adapter object passed by the SDK user for performing http requests |
@@ -48,25 +41,40 @@ The following parameters are configurable for the API Client:
 | `retry_statuses` | `Array` | A list of HTTP statuses to retry. <br> **Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]** |
 | `retry_methods` | `Array` | A list of HTTP methods to retry. <br> **Default: %i[get put]** |
 | `http_callback` | `HttpCallBack` | The Http CallBack allows defining callables for pre and post API calls. |
-| `thingspace_oauth_credentials` | [`ThingspaceOauthCredentials`](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.6.0/doc/auth/oauth-2-client-credentials-grant.md) | The credential object for OAuth 2 Client Credentials Grant |
-| `vz_m_2_m_session_token_credentials` | [`VzM2mSessionTokenCredentials`](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.6.0/doc/auth/custom-header-signature.md) | The credential object for Custom Header Signature |
+| `thingspace_oauth_credentials` | [`ThingspaceOauthCredentials`](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.7.0/doc/auth/oauth-2-client-credentials-grant.md) | The credential object for OAuth 2 Client Credentials Grant |
+| `vz_m2m_token_credentials` | [`VZM2mTokenCredentials`](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.7.0/doc/auth/custom-header-signature.md) | The credential object for Custom Header Signature |
 
 The API client can be initialized as follows:
 
 ```ruby
-client = VerizonThingSpaceQualityOfServiceApiEndpoints::Client.new(
-  vz_m2_m_token: 'VZ-M2M-Token',
+client = Verizon::Client.new(
   thingspace_oauth_credentials: ThingspaceOauthCredentials.new(
-    o_auth_client_id: 'OAuthClientId',
-    o_auth_client_secret: 'OAuthClientSecret'
+    oauth_client_id: 'OAuthClientId',
+    oauth_client_secret: 'OAuthClientSecret',
+    oauth_scopes: [
+      OauthScopeThingspaceOauthEnum::DISCOVERYREAD,
+      OauthScopeThingspaceOauthEnum::SERVICEPROFILEREAD
+    ]
   ),
-  vz_m2m_session_token_credentials: VzM2mSessionTokenCredentials.new(
-    vz_m2_m_token: 'VZ-M2M-Token'
+  vz_m2m_token_credentials: VZM2mTokenCredentials.new(
+    vz_m2m_token: 'VZ-M2M-Token'
   ),
   environment: Environment::PRODUCTION
 )
 ```
 
+API calls return an `ApiResponse` object that includes the following fields:
+
+| Field | Description |
+|  --- | --- |
+| `status_code` | Status code of the HTTP response |
+| `reason_phrase` | Reason phrase of the HTTP response |
+| `headers` | Headers of the HTTP response as a Hash |
+| `raw_body` | The body of the HTTP response as a String |
+| `request` | HTTP request info |
+| `errors` | Errors, if they exist |
+| `data` | The deserialized body of the HTTP response |
+
 ## Environments
 
 The SDK can be configured to use a different environment for making API calls. Available environments are:
@@ -76,23 +84,94 @@ The SDK can be configured to use a different environment for making API calls. A
 | Name | Description |
 |  --- | --- |
 | Production | **Default** |
-| Staging | - |
+| Mock server for limited availability, see quick start | - |
 
 ## Authorization
 
 This API uses the following authentication schemes.
 
-* [`thingspace_oauth (OAuth 2 Client Credentials Grant)`](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.6.0/doc/auth/oauth-2-client-credentials-grant.md)
-* [`vz-m2m-session_token (Custom Header Signature)`](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.6.0/doc/auth/custom-header-signature.md)
+* [`thingspace_oauth (OAuth 2 Client Credentials Grant)`](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.7.0/doc/auth/oauth-2-client-credentials-grant.md)
+* [`VZ-M2M-Token (Custom Header Signature)`](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.7.0/doc/auth/custom-header-signature.md)
 
 ## List of APIs
 
-* [Thing Space Qualityof Service API Actions](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.6.0/doc/controllers/thing-space-qualityof-service-api-actions.md)
-* [Exclusions](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.6.0/doc/controllers/exclusions.md)
+* [5G Edge Platforms](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.7.0/doc/controllers/5g-edge-platforms.md)
+* [Service Endpoints](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.7.0/doc/controllers/service-endpoints.md)
+* [Service Profiles](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.7.0/doc/controllers/service-profiles.md)
+* [Device Management](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.7.0/doc/controllers/device-management.md)
+* [Device Groups](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.7.0/doc/controllers/device-groups.md)
+* [Session Management](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.7.0/doc/controllers/session-management.md)
+* [Connectivity Callbacks](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.7.0/doc/controllers/connectivity-callbacks.md)
+* [Account Requests](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.7.0/doc/controllers/account-requests.md)
+* [Service Plans](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.7.0/doc/controllers/service-plans.md)
+* [Device Diagnostics](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.7.0/doc/controllers/device-diagnostics.md)
+* [Device Profile Management](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.7.0/doc/controllers/device-profile-management.md)
+* [Device Monitoring](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.7.0/doc/controllers/device-monitoring.md)
+* [E UICC Device Profile Management](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.7.0/doc/controllers/e-uicc-device-profile-management.md)
+* [Devices Locations](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.7.0/doc/controllers/devices-locations.md)
+* [Devices Location Subscriptions](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.7.0/doc/controllers/devices-location-subscriptions.md)
+* [Device Location Callbacks](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.7.0/doc/controllers/device-location-callbacks.md)
+* [Usage Trigger Management](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.7.0/doc/controllers/usage-trigger-management.md)
+* [Software Management Subscriptions V1](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.7.0/doc/controllers/software-management-subscriptions-v1.md)
+* [Software Management Licenses V1](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.7.0/doc/controllers/software-management-licenses-v1.md)
+* [Firmware V1](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.7.0/doc/controllers/firmware-v1.md)
+* [Software Management Callbacks V1](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.7.0/doc/controllers/software-management-callbacks-v1.md)
+* [Software Management Reports V1](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.7.0/doc/controllers/software-management-reports-v1.md)
+* [Software Management Subscriptions V2](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.7.0/doc/controllers/software-management-subscriptions-v2.md)
+* [Software Management Licenses V2](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.7.0/doc/controllers/software-management-licenses-v2.md)
+* [Campaigns V2](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.7.0/doc/controllers/campaigns-v2.md)
+* [Software Management Callbacks V2](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.7.0/doc/controllers/software-management-callbacks-v2.md)
+* [Software Management Reports V2](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.7.0/doc/controllers/software-management-reports-v2.md)
+* [Client Logging](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.7.0/doc/controllers/client-logging.md)
+* [Server Logging](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.7.0/doc/controllers/server-logging.md)
+* [Configuration Files](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.7.0/doc/controllers/configuration-files.md)
+* [Software Management Subscriptions V3](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.7.0/doc/controllers/software-management-subscriptions-v3.md)
+* [Software Management Licenses V3](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.7.0/doc/controllers/software-management-licenses-v3.md)
+* [Campaigns V3](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.7.0/doc/controllers/campaigns-v3.md)
+* [Software Management Reports V3](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.7.0/doc/controllers/software-management-reports-v3.md)
+* [Firmware V3](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.7.0/doc/controllers/firmware-v3.md)
+* [Account Devices](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.7.0/doc/controllers/account-devices.md)
+* [Software Management Callbacks V3](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.7.0/doc/controllers/software-management-callbacks-v3.md)
+* [SIM Securefor Io T Licenses](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.7.0/doc/controllers/sim-securefor-io-t-licenses.md)
+* [Account Subscriptions](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.7.0/doc/controllers/account-subscriptions.md)
+* [Performance Metrics](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.7.0/doc/controllers/performance-metrics.md)
+* [Diagnostics Subscriptions](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.7.0/doc/controllers/diagnostics-subscriptions.md)
+* [Diagnostics Observations](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.7.0/doc/controllers/diagnostics-observations.md)
+* [Diagnostics History](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.7.0/doc/controllers/diagnostics-history.md)
+* [Diagnostics Settings](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.7.0/doc/controllers/diagnostics-settings.md)
+* [Diagnostics Callbacks](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.7.0/doc/controllers/diagnostics-callbacks.md)
+* [Diagnostics Factory Reset](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.7.0/doc/controllers/diagnostics-factory-reset.md)
+* [Cloud Connector Subscriptions](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.7.0/doc/controllers/cloud-connector-subscriptions.md)
+* [Cloud Connector Devices](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.7.0/doc/controllers/cloud-connector-devices.md)
+* [Device Service Management](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.7.0/doc/controllers/device-service-management.md)
+* [Device Reports](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.7.0/doc/controllers/device-reports.md)
+* [Hyper Precise Location Callbacks](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.7.0/doc/controllers/hyper-precise-location-callbacks.md)
+* [Anomaly Settings](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.7.0/doc/controllers/anomaly-settings.md)
+* [Anomaly Triggers](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.7.0/doc/controllers/anomaly-triggers.md)
+* [Anomaly Triggers V2](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.7.0/doc/controllers/anomaly-triggers-v2.md)
+* [Wireless Network Performance](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.7.0/doc/controllers/wireless-network-performance.md)
+* [Fixed Wireless Qualification](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.7.0/doc/controllers/fixed-wireless-qualification.md)
+* [Managinge SIM Profiles](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.7.0/doc/controllers/managinge-sim-profiles.md)
+* [Device SMS Messaging](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.7.0/doc/controllers/device-sms-messaging.md)
+* [Device Actions](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.7.0/doc/controllers/device-actions.md)
+* [Thing Space Qualityof Service API Actions](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.7.0/doc/controllers/thing-space-qualityof-service-api-actions.md)
+* [Promotion Period Information](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.7.0/doc/controllers/promotion-period-information.md)
+* [Retrievethe Triggers](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.7.0/doc/controllers/retrievethe-triggers.md)
+* [Update Triggers](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.7.0/doc/controllers/update-triggers.md)
+* [SIM Actions](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.7.0/doc/controllers/sim-actions.md)
+* [Global Reporting](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.7.0/doc/controllers/global-reporting.md)
+* [5G BI Device Actions](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.7.0/doc/controllers/5g-bi-device-actions.md)
+* [Accounts](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.7.0/doc/controllers/accounts.md)
+* [SMS](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.7.0/doc/controllers/sms.md)
+* [Exclusions](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.7.0/doc/controllers/exclusions.md)
+* [Billing](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.7.0/doc/controllers/billing.md)
+* [Targets](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.7.0/doc/controllers/targets.md)
+* [PWN](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.7.0/doc/controllers/pwn.md)
+* [V2 Triggers](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.7.0/doc/controllers/v2-triggers.md)
 
 ## Classes Documentation
 
-* [Utility Classes](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.6.0/doc/utility-classes.md)
-* [HttpResponse](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.6.0/doc/http-response.md)
-* [HttpRequest](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.6.0/doc/http-request.md)
+* [Utility Classes](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.7.0/doc/utility-classes.md)
+* [HttpResponse](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.7.0/doc/http-response.md)
+* [HttpRequest](https://www.github.com/sdks-io/verizon-apis-ruby-sdk/tree/1.7.0/doc/http-request.md)
 

data/lib/{verizon_thing_space_quality_of_service_api_endpoints → verizon}/api_helper.rb

@@ -1,9 +1,9 @@
-# verizon_thing_space_quality_of_service_api_endpoints
+# verizon
 #
 # This file was automatically generated by APIMATIC v2.0
 # ( https://apimatic.io ).
 
-module VerizonThingSpaceQualityOfServiceApiEndpoints
+module Verizon
   # API utility class
   class APIHelper < CoreLibrary::ApiHelper
   end