ruby-jss 1.6.4 → 2.0.0b1

data/lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_search_results_v2.rb

@@ -0,0 +1,89 @@
+# Copyright 2022 Pixar
+#
+#    Licensed under the Apache License, Version 2.0 (the "Apache License")
+#    with the following modification; you may not use this file except in
+#    compliance with the Apache License and the following modification to it:
+#    Section 6. Trademarks. is deleted and replaced with:
+#
+#    6. Trademarks. This License does not grant permission to use the trade
+#       names, trademarks, service marks, or product names of the Licensor
+#       and its affiliates, except as required to comply with Section 4(c) of
+#       the License and to reproduce the content of the NOTICE file.
+#
+#    You may obtain a copy of the Apache License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the Apache License with the above modification is
+#    distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+#    KIND, either express or implied. See the Apache License for the specific
+#    language governing permissions and limitations under the Apache License.
+#
+
+
+module Jamf
+
+  # This module is the namespace for all objects defined
+  # in the OAPI JSON schema under the components => schemas key
+  #
+  module OAPISchemas
+
+
+    # OAPI Object Model and Enums for: MobileDeviceSearchResultsV2
+    #
+    #
+    #
+    # This class was automatically genereated from the api/schema
+    # URL path on a Jamf Pro server version 10.40.0-t1657115323
+    #
+    # This class may be used directly, e.g instances of other classes may
+    # use instances of this class as one of their own properties/attributes.
+    #
+    # It may also be used as a superclass when implementing Jamf Pro API
+    # Resources in ruby-jss. The subclasses include appropriate mixins, and
+    # should expand on the basic functionality provided here.
+    #
+    #
+    # Container Objects:
+    # Other object models that use this model as the value in one
+    # of their attributes.
+    #  
+    #
+    # Sub Objects:
+    # Other object models used by this model's attributes.
+    #  - Jamf::OAPISchemas::MobileDeviceV2
+    #
+    # Endpoints and Privileges:
+    # API endpoints and HTTP operations that use this object
+    # model, and the Jamf Pro privileges needed to access them.
+    #  - '/v2/mobile-devices:GET' needs permissions:
+    #    - Read Mobile Devices
+    #
+    #
+    class MobileDeviceSearchResultsV2 < Jamf::OAPIObject
+
+      
+
+      OAPI_PROPERTIES = {
+
+        # @!attribute totalCount
+        #   @return [Integer]
+        totalCount: {
+          class: :integer
+        },
+
+        # @!attribute results
+        #   @return [Array<Jamf::OAPISchemas::MobileDeviceV2>]
+        results: {
+          class: Jamf::OAPISchemas::MobileDeviceV2,
+          multi: true
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class MobileDeviceSearchResultsV2
+
+  end # module OAPISchemas
+
+end # module Jamf

data/lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_v2.rb

@@ -0,0 +1,158 @@
+# Copyright 2022 Pixar
+#
+#    Licensed under the Apache License, Version 2.0 (the "Apache License")
+#    with the following modification; you may not use this file except in
+#    compliance with the Apache License and the following modification to it:
+#    Section 6. Trademarks. is deleted and replaced with:
+#
+#    6. Trademarks. This License does not grant permission to use the trade
+#       names, trademarks, service marks, or product names of the Licensor
+#       and its affiliates, except as required to comply with Section 4(c) of
+#       the License and to reproduce the content of the NOTICE file.
+#
+#    You may obtain a copy of the Apache License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the Apache License with the above modification is
+#    distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+#    KIND, either express or implied. See the Apache License for the specific
+#    language governing permissions and limitations under the Apache License.
+#
+
+
+module Jamf
+
+  # This module is the namespace for all objects defined
+  # in the OAPI JSON schema under the components => schemas key
+  #
+  module OAPISchemas
+
+
+    # OAPI Object Model and Enums for: MobileDeviceV2
+    #
+    #
+    #
+    # This class was automatically genereated from the api/schema
+    # URL path on a Jamf Pro server version 10.40.0-t1657115323
+    #
+    # This class may be used directly, e.g instances of other classes may
+    # use instances of this class as one of their own properties/attributes.
+    #
+    # It may also be used as a superclass when implementing Jamf Pro API
+    # Resources in ruby-jss. The subclasses include appropriate mixins, and
+    # should expand on the basic functionality provided here.
+    #
+    #
+    # Container Objects:
+    # Other object models that use this model as the value in one
+    # of their attributes.
+    #  - Jamf::OAPISchemas::MobileDeviceSearchResultsV2
+    #
+    # Sub Objects:
+    # Other object models used by this model's attributes.
+    #  
+    #
+    # Endpoints and Privileges:
+    # API endpoints and HTTP operations that use this object
+    # model, and the Jamf Pro privileges needed to access them.
+    #  - '/v2/mobile-devices/{id}:GET' needs permissions:
+    #    - Read Mobile Devices
+    #
+    #
+    class MobileDeviceV2 < Jamf::OAPIObject
+
+      # Enums used by this class or others
+
+      TYPE_OPTIONS = [
+        'ios',
+        'tvos',
+        'unknown'
+      ]
+
+      OAPI_PROPERTIES = {
+
+        # @!attribute [r] id
+        #   @return [String]
+        id: {
+          class: :j_id,
+          identifier: :primary,
+          readonly: true
+        },
+
+        # @!attribute name
+        #   @return [String]
+        name: {
+          class: :string
+        },
+
+        # @!attribute serialNumber
+        #   @return [String]
+        serialNumber: {
+          class: :string
+        },
+
+        # @!attribute wifiMacAddress
+        #   @return [String]
+        wifiMacAddress: {
+          class: :string
+        },
+
+        # @!attribute udid
+        #   @return [String]
+        udid: {
+          class: :string
+        },
+
+        # @!attribute phoneNumber
+        #   @return [String]
+        phoneNumber: {
+          class: :string
+        },
+
+        # @!attribute model
+        #   @return [String]
+        model: {
+          class: :string
+        },
+
+        # @!attribute modelIdentifier
+        #   @return [String]
+        modelIdentifier: {
+          class: :string
+        },
+
+        # @!attribute username
+        #   @return [String]
+        username: {
+          class: :string
+        },
+
+        # @!attribute type
+        #   @return [String]
+        type: {
+          class: :string,
+          enum: TYPE_OPTIONS
+        },
+
+        # @!attribute [r] managementId
+        #   @return [String]
+        managementId: {
+          class: :string,
+          readonly: true
+        },
+
+        # @!attribute softwareUpdateDeviceId
+        #   @return [String]
+        softwareUpdateDeviceId: {
+          class: :string
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class MobileDeviceV2
+
+  end # module OAPISchemas
+
+end # module Jamf

data/lib/jamf/api/jamf_pro/oapi_schemas/network.rb

@@ -0,0 +1,171 @@
+# Copyright 2022 Pixar
+#
+#    Licensed under the Apache License, Version 2.0 (the "Apache License")
+#    with the following modification; you may not use this file except in
+#    compliance with the Apache License and the following modification to it:
+#    Section 6. Trademarks. is deleted and replaced with:
+#
+#    6. Trademarks. This License does not grant permission to use the trade
+#       names, trademarks, service marks, or product names of the Licensor
+#       and its affiliates, except as required to comply with Section 4(c) of
+#       the License and to reproduce the content of the NOTICE file.
+#
+#    You may obtain a copy of the Apache License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the Apache License with the above modification is
+#    distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+#    KIND, either express or implied. See the Apache License for the specific
+#    language governing permissions and limitations under the Apache License.
+#
+
+
+module Jamf
+
+  # This module is the namespace for all objects defined
+  # in the OAPI JSON schema under the components => schemas key
+  #
+  module OAPISchemas
+
+
+    # OAPI Object Model and Enums for: Network
+    #
+    #
+    #
+    # This class was automatically genereated from the api/schema
+    # URL path on a Jamf Pro server version 10.40.0-t1657115323
+    #
+    # This class may be used directly, e.g instances of other classes may
+    # use instances of this class as one of their own properties/attributes.
+    #
+    # It may also be used as a superclass when implementing Jamf Pro API
+    # Resources in ruby-jss. The subclasses include appropriate mixins, and
+    # should expand on the basic functionality provided here.
+    #
+    #
+    # Container Objects:
+    # Other object models that use this model as the value in one
+    # of their attributes.
+    #  - Jamf::OAPISchemas::IosDetails
+    #
+    # Sub Objects:
+    # Other object models used by this model's attributes.
+    #  
+    #
+    # Endpoints and Privileges:
+    # API endpoints and HTTP operations that use this object
+    # model, and the Jamf Pro privileges needed to access them.
+    #
+    #
+    #
+    class Network < Jamf::OAPIObject
+
+      
+
+      OAPI_PROPERTIES = {
+
+        # @!attribute cellularTechnology
+        #   @return [String]
+        cellularTechnology: {
+          class: :string
+        },
+
+        # @!attribute isVoiceRoamingEnabled
+        #   @return [Boolean]
+        isVoiceRoamingEnabled: {
+          class: :boolean
+        },
+
+        # @!attribute imei
+        #   @return [String]
+        imei: {
+          class: :string
+        },
+
+        # @!attribute iccid
+        #   @return [String]
+        iccid: {
+          class: :string
+        },
+
+        # @!attribute meid
+        #   @return [String]
+        meid: {
+          class: :string
+        },
+
+        # @!attribute carrierSettingsVersion
+        #   @return [String]
+        carrierSettingsVersion: {
+          class: :string
+        },
+
+        # @!attribute currentCarrierNetwork
+        #   @return [String]
+        currentCarrierNetwork: {
+          class: :string
+        },
+
+        # @!attribute currentMobileCountryCode
+        #   @return [String]
+        currentMobileCountryCode: {
+          class: :string
+        },
+
+        # @!attribute currentMobileNetworkCode
+        #   @return [String]
+        currentMobileNetworkCode: {
+          class: :string
+        },
+
+        # @!attribute homeCarrierNetwork
+        #   @return [String]
+        homeCarrierNetwork: {
+          class: :string
+        },
+
+        # @!attribute homeMobileCountryCode
+        #   @return [String]
+        homeMobileCountryCode: {
+          class: :string
+        },
+
+        # @!attribute homeMobileNetworkCode
+        #   @return [String]
+        homeMobileNetworkCode: {
+          class: :string
+        },
+
+        # @!attribute isDataRoamingEnabled
+        #   @return [Boolean]
+        isDataRoamingEnabled: {
+          class: :boolean
+        },
+
+        # @!attribute isRoaming
+        #   @return [Boolean]
+        isRoaming: {
+          class: :boolean
+        },
+
+        # @!attribute isPersonalHotspotEnabled
+        #   @return [Boolean]
+        isPersonalHotspotEnabled: {
+          class: :boolean
+        },
+
+        # @!attribute phoneNumber
+        #   @return [String]
+        phoneNumber: {
+          class: :string
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class Network
+
+  end # module OAPISchemas
+
+end # module Jamf

data/lib/jamf/api/jamf_pro/oapi_schemas/network_v2.rb

@@ -0,0 +1,179 @@
+# Copyright 2022 Pixar
+#
+#    Licensed under the Apache License, Version 2.0 (the "Apache License")
+#    with the following modification; you may not use this file except in
+#    compliance with the Apache License and the following modification to it:
+#    Section 6. Trademarks. is deleted and replaced with:
+#
+#    6. Trademarks. This License does not grant permission to use the trade
+#       names, trademarks, service marks, or product names of the Licensor
+#       and its affiliates, except as required to comply with Section 4(c) of
+#       the License and to reproduce the content of the NOTICE file.
+#
+#    You may obtain a copy of the Apache License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the Apache License with the above modification is
+#    distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+#    KIND, either express or implied. See the Apache License for the specific
+#    language governing permissions and limitations under the Apache License.
+#
+
+
+module Jamf
+
+  # This module is the namespace for all objects defined
+  # in the OAPI JSON schema under the components => schemas key
+  #
+  module OAPISchemas
+
+
+    # OAPI Object Model and Enums for: NetworkV2
+    #
+    #
+    #
+    # This class was automatically genereated from the api/schema
+    # URL path on a Jamf Pro server version 10.40.0-t1657115323
+    #
+    # This class may be used directly, e.g instances of other classes may
+    # use instances of this class as one of their own properties/attributes.
+    #
+    # It may also be used as a superclass when implementing Jamf Pro API
+    # Resources in ruby-jss. The subclasses include appropriate mixins, and
+    # should expand on the basic functionality provided here.
+    #
+    #
+    # Container Objects:
+    # Other object models that use this model as the value in one
+    # of their attributes.
+    #  - Jamf::OAPISchemas::IosDetailsV2
+    #
+    # Sub Objects:
+    # Other object models used by this model's attributes.
+    #  
+    #
+    # Endpoints and Privileges:
+    # API endpoints and HTTP operations that use this object
+    # model, and the Jamf Pro privileges needed to access them.
+    #
+    #
+    #
+    class NetworkV2 < Jamf::OAPIObject
+
+      
+
+      OAPI_PROPERTIES = {
+
+        # @!attribute cellularTechnology
+        #   @return [String]
+        cellularTechnology: {
+          class: :string
+        },
+
+        # @!attribute voiceRoamingEnabled
+        #   @return [Boolean]
+        voiceRoamingEnabled: {
+          class: :boolean
+        },
+
+        # @!attribute imei
+        #   @return [String]
+        imei: {
+          class: :string
+        },
+
+        # @!attribute iccid
+        #   @return [String]
+        iccid: {
+          class: :string
+        },
+
+        # @!attribute meid
+        #   @return [String]
+        meid: {
+          class: :string
+        },
+
+        # EID or "embedded identity document" is a number associated with the eSIM on a device
+        # @!attribute [r] eid
+        #   @return [String]
+        eid: {
+          class: :string,
+          readonly: true
+        },
+
+        # @!attribute carrierSettingsVersion
+        #   @return [String]
+        carrierSettingsVersion: {
+          class: :string
+        },
+
+        # @!attribute currentCarrierNetwork
+        #   @return [String]
+        currentCarrierNetwork: {
+          class: :string
+        },
+
+        # @!attribute currentMobileCountryCode
+        #   @return [String]
+        currentMobileCountryCode: {
+          class: :string
+        },
+
+        # @!attribute currentMobileNetworkCode
+        #   @return [String]
+        currentMobileNetworkCode: {
+          class: :string
+        },
+
+        # @!attribute homeCarrierNetwork
+        #   @return [String]
+        homeCarrierNetwork: {
+          class: :string
+        },
+
+        # @!attribute homeMobileCountryCode
+        #   @return [String]
+        homeMobileCountryCode: {
+          class: :string
+        },
+
+        # @!attribute homeMobileNetworkCode
+        #   @return [String]
+        homeMobileNetworkCode: {
+          class: :string
+        },
+
+        # @!attribute dataRoamingEnabled
+        #   @return [Boolean]
+        dataRoamingEnabled: {
+          class: :boolean
+        },
+
+        # @!attribute roaming
+        #   @return [Boolean]
+        roaming: {
+          class: :boolean
+        },
+
+        # @!attribute personalHotspotEnabled
+        #   @return [Boolean]
+        personalHotspotEnabled: {
+          class: :boolean
+        },
+
+        # @!attribute phoneNumber
+        #   @return [String]
+        phoneNumber: {
+          class: :string
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class NetworkV2
+
+  end # module OAPISchemas
+
+end # module Jamf

data/lib/jamf/api/jamf_pro/oapi_schemas/notification.rb

@@ -0,0 +1,96 @@
+# Copyright 2022 Pixar
+#
+#    Licensed under the Apache License, Version 2.0 (the "Apache License")
+#    with the following modification; you may not use this file except in
+#    compliance with the Apache License and the following modification to it:
+#    Section 6. Trademarks. is deleted and replaced with:
+#
+#    6. Trademarks. This License does not grant permission to use the trade
+#       names, trademarks, service marks, or product names of the Licensor
+#       and its affiliates, except as required to comply with Section 4(c) of
+#       the License and to reproduce the content of the NOTICE file.
+#
+#    You may obtain a copy of the Apache License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the Apache License with the above modification is
+#    distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+#    KIND, either express or implied. See the Apache License for the specific
+#    language governing permissions and limitations under the Apache License.
+#
+
+
+module Jamf
+
+  # This module is the namespace for all objects defined
+  # in the OAPI JSON schema under the components => schemas key
+  #
+  module OAPISchemas
+
+
+    # OAPI Object Model and Enums for: Notification
+    #
+    # Description of this class from the OAPI Schema:
+    #   Jamf Pro notification used for important alerts.
+    #
+    # This class was automatically genereated from the api/schema
+    # URL path on a Jamf Pro server version 10.40.0-t1657115323
+    #
+    # This class may be used directly, e.g instances of other classes may
+    # use instances of this class as one of their own properties/attributes.
+    #
+    # It may also be used as a superclass when implementing Jamf Pro API
+    # Resources in ruby-jss. The subclasses include appropriate mixins, and
+    # should expand on the basic functionality provided here.
+    #
+    #
+    # Container Objects:
+    # Other object models that use this model as the value in one
+    # of their attributes.
+    #  
+    #
+    # Sub Objects:
+    # Other object models used by this model's attributes.
+    #  
+    #
+    # Endpoints and Privileges:
+    # API endpoints and HTTP operations that use this object
+    # model, and the Jamf Pro privileges needed to access them.
+    #  - '/notifications/alerts:GET' needs permissions:
+    #    - Unknown
+    #
+    #
+    class Notification < Jamf::OAPIObject
+
+      
+
+      OAPI_PROPERTIES = {
+
+        # @!attribute type
+        #   @return [String]
+        type: {
+          class: :string
+        },
+
+        # @!attribute id
+        #   @return [Integer]
+        id: {
+          class: :j_id,
+          identifier: :primary
+        },
+
+        # @!attribute params
+        #   @return [Hash{Symbol: Hash{Symbol: Object} }]
+        params: {
+          class: :hash
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class Notification
+
+  end # module OAPISchemas
+
+end # module Jamf