sdksio-verizon-apis-sdk 1.0.0 → 1.3.0

data/lib/verizon/models/create_device_group_request.rb

@@ -0,0 +1,91 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Create request for a new device group and optionally add devices to the
+  # group.
+  class CreateDeviceGroupRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The Verizon billing account that the device group will belong to. An
+    # account name is usually numeric, and must include any leading zeros.
+    # @return [String]
+    attr_accessor :account_name
+
+    # A description for the device group.
+    # @return [String]
+    attr_accessor :group_description
+
+    # The name for the new device group. This name must be unique within the
+    # specified account.
+    # @return [String]
+    attr_accessor :group_name
+
+    # Zero or more devices to add to the device group. You can use POST
+    # /devices/actions/list to get a list of all devices in the account.
+    # @return [Array[DeviceId]]
+    attr_accessor :devices_to_add
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_name'] = 'accountName'
+      @_hash['group_description'] = 'groupDescription'
+      @_hash['group_name'] = 'groupName'
+      @_hash['devices_to_add'] = 'devicesToAdd'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        devices_to_add
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_name = nil,
+                   group_description = nil,
+                   group_name = nil,
+                   devices_to_add = SKIP)
+      @account_name = account_name
+      @group_description = group_description
+      @group_name = group_name
+      @devices_to_add = devices_to_add unless devices_to_add == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      account_name = hash.key?('accountName') ? hash['accountName'] : nil
+      group_description =
+        hash.key?('groupDescription') ? hash['groupDescription'] : nil
+      group_name = hash.key?('groupName') ? hash['groupName'] : nil
+      # Parameter is an array, so we need to iterate through it
+      devices_to_add = nil
+      unless hash['devicesToAdd'].nil?
+        devices_to_add = []
+        hash['devicesToAdd'].each do |structure|
+          devices_to_add << (DeviceId.from_hash(structure) if structure)
+        end
+      end
+
+      devices_to_add = SKIP unless hash.key?('devicesToAdd')
+
+      # Create object from extracted values.
+      CreateDeviceGroupRequest.new(account_name,
+                                   group_description,
+                                   group_name,
+                                   devices_to_add)
+    end
+  end
+end

data/lib/verizon/models/create_io_t_application_request.rb

@@ -0,0 +1,135 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # The request body must include the UUID of the subscription that you want to
+  # update plus any properties that you want to change.
+  class CreateIoTApplicationRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A user defined name for the application being deployed in Azure IoT
+    # Central.
+    # @return [String]
+    attr_accessor :app_name
+
+    # The ThingSpace ID of the authenticating billing account
+    # @return [String]
+    attr_accessor :billing_account_id
+
+    # The Azure ClientID of the associated Azure target account
+    # @return [String]
+    attr_accessor :client_id
+
+    # The Azure Client Secret of the associated Azure target account
+    # @return [String]
+    attr_accessor :client_secret
+
+    # The “email IDs” to be added to/sent to with this API.
+    # @return [String]
+    attr_accessor :email_i_ds
+
+    # The Azure Resource group of the associated Azure target account
+    # @return [String]
+    attr_accessor :resourcegroup
+
+    # This is the reference Azure IoT Central application developed by Verizon.
+    # @return [String]
+    attr_accessor :sample_io_tc_app
+
+    # The Azure Subscription ID of the associated Azure target account
+    # @return [String]
+    attr_accessor :subscription_id
+
+    # The Azure Tenant ID of the associated Azure target account
+    # @return [String]
+    attr_accessor :tenant_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['app_name'] = 'appName'
+      @_hash['billing_account_id'] = 'billingAccountID'
+      @_hash['client_id'] = 'clientID'
+      @_hash['client_secret'] = 'clientSecret'
+      @_hash['email_i_ds'] = 'emailIDs'
+      @_hash['resourcegroup'] = 'resourcegroup'
+      @_hash['sample_io_tc_app'] = 'sampleIOTcApp'
+      @_hash['subscription_id'] = 'subscriptionID'
+      @_hash['tenant_id'] = 'tenantID'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        app_name
+        billing_account_id
+        client_id
+        client_secret
+        email_i_ds
+        resourcegroup
+        sample_io_tc_app
+        subscription_id
+        tenant_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(app_name = SKIP,
+                   billing_account_id = SKIP,
+                   client_id = SKIP,
+                   client_secret = SKIP,
+                   email_i_ds = SKIP,
+                   resourcegroup = SKIP,
+                   sample_io_tc_app = SKIP,
+                   subscription_id = SKIP,
+                   tenant_id = SKIP)
+      @app_name = app_name unless app_name == SKIP
+      @billing_account_id = billing_account_id unless billing_account_id == SKIP
+      @client_id = client_id unless client_id == SKIP
+      @client_secret = client_secret unless client_secret == SKIP
+      @email_i_ds = email_i_ds unless email_i_ds == SKIP
+      @resourcegroup = resourcegroup unless resourcegroup == SKIP
+      @sample_io_tc_app = sample_io_tc_app unless sample_io_tc_app == SKIP
+      @subscription_id = subscription_id unless subscription_id == SKIP
+      @tenant_id = tenant_id unless tenant_id == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      app_name = hash.key?('appName') ? hash['appName'] : SKIP
+      billing_account_id =
+        hash.key?('billingAccountID') ? hash['billingAccountID'] : SKIP
+      client_id = hash.key?('clientID') ? hash['clientID'] : SKIP
+      client_secret = hash.key?('clientSecret') ? hash['clientSecret'] : SKIP
+      email_i_ds = hash.key?('emailIDs') ? hash['emailIDs'] : SKIP
+      resourcegroup = hash.key?('resourcegroup') ? hash['resourcegroup'] : SKIP
+      sample_io_tc_app =
+        hash.key?('sampleIOTcApp') ? hash['sampleIOTcApp'] : SKIP
+      subscription_id =
+        hash.key?('subscriptionID') ? hash['subscriptionID'] : SKIP
+      tenant_id = hash.key?('tenantID') ? hash['tenantID'] : SKIP
+
+      # Create object from extracted values.
+      CreateIoTApplicationRequest.new(app_name,
+                                      billing_account_id,
+                                      client_id,
+                                      client_secret,
+                                      email_i_ds,
+                                      resourcegroup,
+                                      sample_io_tc_app,
+                                      subscription_id,
+                                      tenant_id)
+    end
+  end
+end

data/lib/verizon/models/create_io_t_application_response.rb

@@ -0,0 +1,74 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # A success response includes an array of all matching events. Each event
+  # includes the full event resource definition.
+  class CreateIoTApplicationResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # An application will be created under the user's Azure subscription with
+    # this name and of type IOT central.
+    # @return [String]
+    attr_accessor :app_name
+
+    # Part of the user credentials (from Azure) the user needs to use for
+    # calling further TS Core APIs for setting up Azure cloud connector.
+    # @return [String]
+    attr_accessor :shared_secret
+
+    # An IOT central endpoint the user can use to see the data that is being
+    # streamed.
+    # @return [String]
+    attr_accessor :url
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['app_name'] = 'appName'
+      @_hash['shared_secret'] = 'sharedSecret'
+      @_hash['url'] = 'url'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        app_name
+        shared_secret
+        url
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(app_name = SKIP,
+                   shared_secret = SKIP,
+                   url = SKIP)
+      @app_name = app_name unless app_name == SKIP
+      @shared_secret = shared_secret unless shared_secret == SKIP
+      @url = url unless url == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      app_name = hash.key?('appName') ? hash['appName'] : SKIP
+      shared_secret = hash.key?('sharedSecret') ? hash['sharedSecret'] : SKIP
+      url = hash.key?('url') ? hash['url'] : SKIP
+
+      # Create object from extracted values.
+      CreateIoTApplicationResponse.new(app_name,
+                                       shared_secret,
+                                       url)
+    end
+  end
+end

data/lib/verizon/models/create_service_profile_result.rb

@@ -0,0 +1,52 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # A successful request returns a serviceProfileId that you can use in
+  # subsequent requests.
+  class CreateServiceProfileResult < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique identifier for a service profile.
+    # @return [String]
+    attr_accessor :service_profile_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['service_profile_id'] = 'serviceProfileId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        service_profile_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(service_profile_id = SKIP)
+      @service_profile_id = service_profile_id unless service_profile_id == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      service_profile_id =
+        hash.key?('serviceProfileId') ? hash['serviceProfileId'] : SKIP
+
+      # Create object from extracted values.
+      CreateServiceProfileResult.new(service_profile_id)
+    end
+  end
+end

data/lib/verizon/models/create_subscription_request.rb

@@ -0,0 +1,154 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # The details of the subscription that you want to create.
+  class CreateSubscriptionRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The ID of the authenticating billing account, in the format
+    # `{"billingaccountid":"1234567890-12345"}`.
+    # @return [AccountIdentifier]
+    attr_accessor :accountidentifier
+
+    # Descriptive information about the subscription.
+    # @return [String]
+    attr_accessor :description
+
+    # Enable or disable the subscription. A disabled subscription will not send
+    # any data.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :disabled
+
+    # The address to which any error reports should be delivered.
+    # @return [String]
+    attr_accessor :email
+
+    # String containing a $filter object with a property and value to filter out
+    # non-matching events.
+    # @return [String]
+    attr_accessor :filter
+
+    # String containing a $filter object with a property and value to filter out
+    # non-matching events.
+    # @return [String]
+    attr_accessor :billingaccountid
+
+    # The type of event data to send via this subscription. This will be
+    # `ts.event` in most cases. Other event types are `ts.event.diagnostics` for
+    # device diagnostic data, `ts.event.configuration` for device configuration
+    # events, or `ts.event.security`. Note that the device ThingSpace client
+    # must support sending specific event types for anything other than
+    # `ts.event`.
+    # @return [String]
+    attr_accessor :streamkind
+
+    # The ID of the target resource to be used when dispatching events. The
+    # corresponding target should have a “stream” addressscheme.
+    # @return [String]
+    attr_accessor :targetid
+
+    # Name of the subscription.
+    # @return [String]
+    attr_accessor :name
+
+    # Setting this value to `false` prevents the data returned from being
+    # aggregated and makes the data easier to parse.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :allowaggregation
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['accountidentifier'] = 'accountidentifier'
+      @_hash['description'] = 'description'
+      @_hash['disabled'] = 'disabled'
+      @_hash['email'] = 'email'
+      @_hash['filter'] = 'filter'
+      @_hash['billingaccountid'] = 'billingaccountid'
+      @_hash['streamkind'] = 'streamkind'
+      @_hash['targetid'] = 'targetid'
+      @_hash['name'] = 'name'
+      @_hash['allowaggregation'] = 'allowaggregation'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        accountidentifier
+        description
+        disabled
+        email
+        filter
+        billingaccountid
+        streamkind
+        targetid
+        name
+        allowaggregation
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(accountidentifier = SKIP,
+                   description = SKIP,
+                   disabled = SKIP,
+                   email = SKIP,
+                   filter = SKIP,
+                   billingaccountid = SKIP,
+                   streamkind = SKIP,
+                   targetid = SKIP,
+                   name = SKIP,
+                   allowaggregation = SKIP)
+      @accountidentifier = accountidentifier unless accountidentifier == SKIP
+      @description = description unless description == SKIP
+      @disabled = disabled unless disabled == SKIP
+      @email = email unless email == SKIP
+      @filter = filter unless filter == SKIP
+      @billingaccountid = billingaccountid unless billingaccountid == SKIP
+      @streamkind = streamkind unless streamkind == SKIP
+      @targetid = targetid unless targetid == SKIP
+      @name = name unless name == SKIP
+      @allowaggregation = allowaggregation unless allowaggregation == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      accountidentifier = AccountIdentifier.from_hash(hash['accountidentifier']) if
+        hash['accountidentifier']
+      description = hash.key?('description') ? hash['description'] : SKIP
+      disabled = hash.key?('disabled') ? hash['disabled'] : SKIP
+      email = hash.key?('email') ? hash['email'] : SKIP
+      filter = hash.key?('filter') ? hash['filter'] : SKIP
+      billingaccountid =
+        hash.key?('billingaccountid') ? hash['billingaccountid'] : SKIP
+      streamkind = hash.key?('streamkind') ? hash['streamkind'] : SKIP
+      targetid = hash.key?('targetid') ? hash['targetid'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+      allowaggregation =
+        hash.key?('allowaggregation') ? hash['allowaggregation'] : SKIP
+
+      # Create object from extracted values.
+      CreateSubscriptionRequest.new(accountidentifier,
+                                    description,
+                                    disabled,
+                                    email,
+                                    filter,
+                                    billingaccountid,
+                                    streamkind,
+                                    targetid,
+                                    name,
+                                    allowaggregation)
+    end
+  end
+end

data/lib/verizon/models/create_target_request.rb

@@ -0,0 +1,170 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Details of the target that you want to create.
+  class CreateTargetRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The ID of the authenticating billing account, in the format
+    # `{"billingaccountid":"1234567890-12345"}`.
+    # @return [AccountIdentifier]
+    attr_accessor :accountidentifier
+
+    # The ID of the authenticating billing account.
+    # @return [String]
+    attr_accessor :billingaccountid
+
+    # Identifies the resource kind. Targets are ts.target.
+    # @return [String]
+    attr_accessor :kind
+
+    # The endpoint for notifications or data streams. The format depends on the
+    # selected `addressscheme`.<br />`streamrest` requires a `host:port` value
+    # <br />`streamawsiot` requres a valid ARN.
+    # @return [String]
+    attr_accessor :address
+
+    # The transport format. Valid values are: <br />streamawsiot - streamed data
+    # to an AWS account <br />streamrest - streamed REST data to a defined
+    # endpoint.
+    # @return [String]
+    attr_accessor :addressscheme
+
+    # The transport format. Valid values are: <br />streamawsiot - streamed data
+    # to an AWS account <br />streamrest - streamed REST data to a defined
+    # endpoint.
+    # @return [CreateTargetRequestFields]
+    attr_accessor :fields
+
+    # Descriptive information about the target.
+    # @return [String]
+    attr_accessor :description
+
+    # Security identification string created by a POST /targets/actions/newextid
+    # request.
+    # @return [String]
+    attr_accessor :externalid
+
+    # Name of the target.
+    # @return [String]
+    attr_accessor :name
+
+    # AWS region value.
+    # @return [String]
+    attr_accessor :region
+
+    # OAuth 2.0 bearer token.
+    # @return [String]
+    attr_accessor :key1
+
+    # OAuth 2 token and refresh token for TS to stream events to Target.
+    # @return [TargetAuthentication]
+    attr_accessor :oauth
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['accountidentifier'] = 'accountidentifier'
+      @_hash['billingaccountid'] = 'billingaccountid'
+      @_hash['kind'] = 'kind'
+      @_hash['address'] = 'address'
+      @_hash['addressscheme'] = 'addressscheme'
+      @_hash['fields'] = 'fields'
+      @_hash['description'] = 'description'
+      @_hash['externalid'] = 'externalid'
+      @_hash['name'] = 'name'
+      @_hash['region'] = 'region'
+      @_hash['key1'] = 'key1'
+      @_hash['oauth'] = 'oauth'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        accountidentifier
+        billingaccountid
+        kind
+        address
+        addressscheme
+        fields
+        description
+        externalid
+        name
+        region
+        key1
+        oauth
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(accountidentifier = SKIP,
+                   billingaccountid = SKIP,
+                   kind = SKIP,
+                   address = SKIP,
+                   addressscheme = SKIP,
+                   fields = SKIP,
+                   description = SKIP,
+                   externalid = SKIP,
+                   name = SKIP,
+                   region = SKIP,
+                   key1 = SKIP,
+                   oauth = SKIP)
+      @accountidentifier = accountidentifier unless accountidentifier == SKIP
+      @billingaccountid = billingaccountid unless billingaccountid == SKIP
+      @kind = kind unless kind == SKIP
+      @address = address unless address == SKIP
+      @addressscheme = addressscheme unless addressscheme == SKIP
+      @fields = fields unless fields == SKIP
+      @description = description unless description == SKIP
+      @externalid = externalid unless externalid == SKIP
+      @name = name unless name == SKIP
+      @region = region unless region == SKIP
+      @key1 = key1 unless key1 == SKIP
+      @oauth = oauth unless oauth == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      accountidentifier = AccountIdentifier.from_hash(hash['accountidentifier']) if
+        hash['accountidentifier']
+      billingaccountid =
+        hash.key?('billingaccountid') ? hash['billingaccountid'] : SKIP
+      kind = hash.key?('kind') ? hash['kind'] : SKIP
+      address = hash.key?('address') ? hash['address'] : SKIP
+      addressscheme = hash.key?('addressscheme') ? hash['addressscheme'] : SKIP
+      fields = CreateTargetRequestFields.from_hash(hash['fields']) if hash['fields']
+      description = hash.key?('description') ? hash['description'] : SKIP
+      externalid = hash.key?('externalid') ? hash['externalid'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+      region = hash.key?('region') ? hash['region'] : SKIP
+      key1 = hash.key?('key1') ? hash['key1'] : SKIP
+      oauth = TargetAuthentication.from_hash(hash['oauth']) if hash['oauth']
+
+      # Create object from extracted values.
+      CreateTargetRequest.new(accountidentifier,
+                              billingaccountid,
+                              kind,
+                              address,
+                              addressscheme,
+                              fields,
+                              description,
+                              externalid,
+                              name,
+                              region,
+                              key1,
+                              oauth)
+    end
+  end
+end