ruby-jss 1.6.4 → 2.0.0b1

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

@@ -0,0 +1,122 @@
+# 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: UpdateMobileDevice
+    #
+    #
+    #
+    # 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::Location
+    #  - Jamf::OAPISchemas::ExtensionAttribute
+    #  - Jamf::OAPISchemas::UpdateIos
+    #  - Jamf::OAPISchemas::UpdateAppleTv
+    #
+    # Endpoints and Privileges:
+    # API endpoints and HTTP operations that use this object
+    # model, and the Jamf Pro privileges needed to access them.
+    #  - '/v1/mobile-devices/{id}:PATCH' needs permissions:
+    #    - Update Mobile Devices
+    #
+    #
+    class UpdateMobileDevice < Jamf::OAPIObject
+
+      
+
+      OAPI_PROPERTIES = {
+
+        # @!attribute name
+        #   @return [String]
+        name: {
+          class: :string
+        },
+
+        # @!attribute assetTag
+        #   @return [String]
+        assetTag: {
+          class: :string
+        },
+
+        # @!attribute siteId
+        #   @return [Integer]
+        siteId: {
+          class: :integer
+        },
+
+        # @!attribute location
+        #   @return [Jamf::OAPISchemas::Location]
+        location: {
+          class: Jamf::OAPISchemas::Location
+        },
+
+        # @!attribute updatedExtensionAttributes
+        #   @return [Array<Jamf::OAPISchemas::ExtensionAttribute>]
+        updatedExtensionAttributes: {
+          class: Jamf::OAPISchemas::ExtensionAttribute,
+          multi: true
+        },
+
+        # @!attribute ios
+        #   @return [Jamf::OAPISchemas::UpdateIos]
+        ios: {
+          class: Jamf::OAPISchemas::UpdateIos
+        },
+
+        # @!attribute appleTv
+        #   @return [Jamf::OAPISchemas::UpdateAppleTv]
+        appleTv: {
+          class: Jamf::OAPISchemas::UpdateAppleTv
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class UpdateMobileDevice
+
+  end # module OAPISchemas
+
+end # module Jamf

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

@@ -0,0 +1,137 @@
+# 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: UpdateMobileDeviceV2
+    #
+    #
+    #
+    # 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::LocationV2
+    #  - Jamf::OAPISchemas::ExtensionAttributeV2
+    #  - Jamf::OAPISchemas::UpdateIosV2
+    #  - Jamf::OAPISchemas::UpdateTvOs
+    #
+    # 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}:PATCH' needs permissions:
+    #    - Update Mobile Devices
+    #
+    #
+    class UpdateMobileDeviceV2 < Jamf::OAPIObject
+
+      
+
+      OAPI_PROPERTIES = {
+
+        # Mobile Device Name. When updated, Jamf Pro sends an MDM settings command to the device (device must be supervised).
+        # @!attribute name
+        #   @return [String]
+        name: {
+          class: :string
+        },
+
+        # Enforce the mobile device name. Device must be supervised. If set to true, Jamf Pro will revert the Mobile Device Name to the ‘name’ value each time the device checks in.
+        # @!attribute enforceName
+        #   @return [Boolean]
+        enforceName: {
+          class: :boolean
+        },
+
+        # @!attribute assetTag
+        #   @return [String]
+        assetTag: {
+          class: :string
+        },
+
+        # @!attribute siteId
+        #   @return [String]
+        siteId: {
+          class: :string
+        },
+
+        # IANA time zone database name
+        # @!attribute timeZone
+        #   @return [String]
+        timeZone: {
+          class: :string
+        },
+
+        # @!attribute location
+        #   @return [Jamf::OAPISchemas::LocationV2]
+        location: {
+          class: Jamf::OAPISchemas::LocationV2
+        },
+
+        # @!attribute updatedExtensionAttributes
+        #   @return [Array<Jamf::OAPISchemas::ExtensionAttributeV2>]
+        updatedExtensionAttributes: {
+          class: Jamf::OAPISchemas::ExtensionAttributeV2,
+          multi: true
+        },
+
+        # @!attribute ios
+        #   @return [Jamf::OAPISchemas::UpdateIosV2]
+        ios: {
+          class: Jamf::OAPISchemas::UpdateIosV2
+        },
+
+        # @!attribute tvos
+        #   @return [Jamf::OAPISchemas::UpdateTvOs]
+        tvos: {
+          class: Jamf::OAPISchemas::UpdateTvOs
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class UpdateMobileDeviceV2
+
+  end # module OAPISchemas
+
+end # module Jamf

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

@@ -0,0 +1,87 @@
+# 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: UpdateTvOs
+    #
+    #
+    #
+    # 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::UpdateMobileDeviceV2
+    #
+    # Sub Objects:
+    # Other object models used by this model's attributes.
+    #  - Jamf::OAPISchemas::PurchasingV2
+    #
+    # Endpoints and Privileges:
+    # API endpoints and HTTP operations that use this object
+    # model, and the Jamf Pro privileges needed to access them.
+    #
+    #
+    #
+    class UpdateTvOs < Jamf::OAPIObject
+
+      
+
+      OAPI_PROPERTIES = {
+
+        # @!attribute airplayPassword
+        #   @return [String]
+        airplayPassword: {
+          class: :string
+        },
+
+        # @!attribute purchasing
+        #   @return [Jamf::OAPISchemas::PurchasingV2]
+        purchasing: {
+          class: Jamf::OAPISchemas::PurchasingV2
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class UpdateTvOs
+
+  end # module OAPISchemas
+
+end # module Jamf

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

@@ -0,0 +1,117 @@
+# 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: UserAttributes
+    #
+    #
+    #
+    # 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::UserTestSearch
+    #
+    # 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 UserAttributes < Jamf::OAPIObject
+
+      
+
+      OAPI_PROPERTIES = {
+
+        # @!attribute fullName
+        #   @return [String]
+        fullName: {
+          class: :string
+        },
+
+        # @!attribute emailAddress
+        #   @return [String]
+        emailAddress: {
+          class: :string
+        },
+
+        # @!attribute phoneNumber
+        #   @return [String]
+        phoneNumber: {
+          class: :string
+        },
+
+        # @!attribute position
+        #   @return [String]
+        position: {
+          class: :string
+        },
+
+        # @!attribute room
+        #   @return [String]
+        room: {
+          class: :string
+        },
+
+        # @!attribute buildingId
+        #   @return [String]
+        buildingId: {
+          class: :string
+        },
+
+        # @!attribute departmentId
+        #   @return [String]
+        departmentId: {
+          class: :string
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class UserAttributes
+
+  end # module OAPISchemas
+
+end # module Jamf

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

@@ -0,0 +1,193 @@
+# 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: UserMappings
+    #
+    # Description of this class from the OAPI Schema:
+    #   Cloud Identity Provider user mappings configuration
+    #
+    # 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::CloudLdapMappingsRequest
+    #  - Jamf::OAPISchemas::CloudLdapMappingsResponse
+    #
+    # 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 UserMappings < Jamf::OAPIObject
+
+      # Enums used by this class or others
+
+      OBJECT_CLASS_LIMITATION_OPTIONS = [
+        'ANY_OBJECT_CLASSES',
+        'ALL_OBJECT_CLASSES'
+      ]
+
+      SEARCH_SCOPE_OPTIONS = [
+        'ALL_SUBTREES',
+        'FIRST_LEVEL_ONLY'
+      ]
+
+      OAPI_PROPERTIES = {
+
+        # @!attribute objectClassLimitation
+        #   @return [String]
+        objectClassLimitation: {
+          class: :string,
+          required: true,
+          enum: OBJECT_CLASS_LIMITATION_OPTIONS
+        },
+
+        # @!attribute objectClasses
+        #   @return [String]
+        objectClasses: {
+          class: :string,
+          required: true
+        },
+
+        # @!attribute searchBase
+        #   @return [String]
+        searchBase: {
+          class: :string,
+          required: true
+        },
+
+        # @!attribute searchScope
+        #   @return [String]
+        searchScope: {
+          class: :string,
+          required: true,
+          enum: SEARCH_SCOPE_OPTIONS
+        },
+
+        # @!attribute additionalSearchBase
+        #   @return [String]
+        additionalSearchBase: {
+          class: :string
+        },
+
+        # @!attribute userID
+        #   @return [String]
+        userID: {
+          class: :string,
+          required: true
+        },
+
+        # @!attribute username
+        #   @return [String]
+        username: {
+          class: :string,
+          required: true
+        },
+
+        # @!attribute realName
+        #   @return [String]
+        realName: {
+          class: :string,
+          required: true
+        },
+
+        # @!attribute emailAddress
+        #   @return [String]
+        emailAddress: {
+          class: :string,
+          required: true
+        },
+
+        # @!attribute department
+        #   @return [String]
+        department: {
+          class: :string,
+          required: true
+        },
+
+        # @!attribute building
+        #   @return [String]
+        building: {
+          class: :string,
+          required: true
+        },
+
+        # @!attribute room
+        #   @return [String]
+        room: {
+          class: :string,
+          required: true
+        },
+
+        # @!attribute phone
+        #   @return [String]
+        phone: {
+          class: :string,
+          required: true
+        },
+
+        # @!attribute position
+        #   @return [String]
+        position: {
+          class: :string,
+          required: true
+        },
+
+        # @!attribute userUuid
+        #   @return [String]
+        userUuid: {
+          class: :string,
+          required: true
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class UserMappings
+
+  end # module OAPISchemas
+
+end # module Jamf