ruby-jss 1.6.4 → 2.0.0a10

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

@@ -0,0 +1,131 @@
+# 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: Security
+    #
+    #
+    #
+    # This class was automatically genereated from the api/schema
+    # URL path on a Jamf Pro server version 10.36.1-t1645562643
+    #
+    # 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::AndroidDetails
+    #  - 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 Security < Jamf::OAPIObject
+
+      
+
+      OAPI_PROPERTIES = {
+
+        # @!attribute isDataProtected
+        #   @return [Boolean]
+        isDataProtected: {
+          class: :boolean
+        },
+
+        # @!attribute isBlockLevelEncryptionCapable
+        #   @return [Boolean]
+        isBlockLevelEncryptionCapable: {
+          class: :boolean
+        },
+
+        # @!attribute isFileLevelEncryptionCapable
+        #   @return [Boolean]
+        isFileLevelEncryptionCapable: {
+          class: :boolean
+        },
+
+        # @!attribute isPasscodePresent
+        #   @return [Boolean]
+        isPasscodePresent: {
+          class: :boolean
+        },
+
+        # @!attribute isPasscodeCompliant
+        #   @return [Boolean]
+        isPasscodeCompliant: {
+          class: :boolean
+        },
+
+        # @!attribute isPasscodeCompliantWithProfile
+        #   @return [Boolean]
+        isPasscodeCompliantWithProfile: {
+          class: :boolean
+        },
+
+        # @!attribute hardwareEncryption
+        #   @return [Integer]
+        hardwareEncryption: {
+          class: :integer
+        },
+
+        # @!attribute isActivationLockEnabled
+        #   @return [Boolean]
+        isActivationLockEnabled: {
+          class: :boolean
+        },
+
+        # @!attribute isJailBreakDetected
+        #   @return [Boolean]
+        isJailBreakDetected: {
+          class: :boolean
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class Security
+
+  end # module OAPISchemas
+
+end # module Jamf

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

@@ -0,0 +1,130 @@
+# 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: SecurityV2
+    #
+    #
+    #
+    # This class was automatically genereated from the api/schema
+    # URL path on a Jamf Pro server version 10.36.1-t1645562643
+    #
+    # 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 SecurityV2 < Jamf::OAPIObject
+
+      
+
+      OAPI_PROPERTIES = {
+
+        # @!attribute dataProtected
+        #   @return [Boolean]
+        dataProtected: {
+          class: :boolean
+        },
+
+        # @!attribute blockLevelEncryptionCapable
+        #   @return [Boolean]
+        blockLevelEncryptionCapable: {
+          class: :boolean
+        },
+
+        # @!attribute fileLevelEncryptionCapable
+        #   @return [Boolean]
+        fileLevelEncryptionCapable: {
+          class: :boolean
+        },
+
+        # @!attribute passcodePresent
+        #   @return [Boolean]
+        passcodePresent: {
+          class: :boolean
+        },
+
+        # @!attribute passcodeCompliant
+        #   @return [Boolean]
+        passcodeCompliant: {
+          class: :boolean
+        },
+
+        # @!attribute passcodeCompliantWithProfile
+        #   @return [Boolean]
+        passcodeCompliantWithProfile: {
+          class: :boolean
+        },
+
+        # @!attribute hardwareEncryption
+        #   @return [Integer]
+        hardwareEncryption: {
+          class: :integer
+        },
+
+        # @!attribute activationLockEnabled
+        #   @return [Boolean]
+        activationLockEnabled: {
+          class: :boolean
+        },
+
+        # @!attribute jailBreakDetected
+        #   @return [Boolean]
+        jailBreakDetected: {
+          class: :boolean
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class SecurityV2
+
+  end # module OAPISchemas
+
+end # module Jamf

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

@@ -0,0 +1,93 @@
+# 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: SelfServiceInstallSettings
+    #
+    # Description of this class from the OAPI Schema:
+    #   object representation of Self Service settings regarding installation
+
+    #
+    # This class was automatically genereated from the api/schema
+    # URL path on a Jamf Pro server version 10.36.1-t1645562643
+    #
+    # 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::SelfServiceSettings
+    #
+    # 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 SelfServiceInstallSettings < Jamf::OAPIObject
+
+      
+
+      OAPI_PROPERTIES = {
+
+        # true if Self Service is insalled automatically, false if not
+        # @!attribute installAutomatically
+        #   @return [Boolean]
+        installAutomatically: {
+          class: :boolean
+        },
+
+        # path at which Self Service is installed
+        # @!attribute installLocation
+        #   @return [String]
+        installLocation: {
+          class: :string,
+          required: true
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class SelfServiceInstallSettings
+
+  end # module OAPISchemas
+
+end # module Jamf

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

@@ -0,0 +1,123 @@
+# 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: SelfServiceInteractionSettings
+    #
+    # Description of this class from the OAPI Schema:
+    #   object representation of Self Service settings regarding user interaction
+
+    #
+    # This class was automatically genereated from the api/schema
+    # URL path on a Jamf Pro server version 10.36.1-t1645562643
+    #
+    # 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::SelfServiceSettings
+    #
+    # 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 SelfServiceInteractionSettings < Jamf::OAPIObject
+
+      # Enums used by this class or others
+
+      DEFAULT_LANDING_PAGE_OPTIONS = [
+        'HOME',
+        'BROWSE',
+        'HISTORY',
+        'NOTIFICATIONS'
+      ]
+
+      OAPI_PROPERTIES = {
+
+        # global Self Service setting for if notifications are on or off
+        # @!attribute notificationsEnabled
+        #   @return [Boolean]
+        notificationsEnabled: {
+          class: :boolean
+        },
+
+        # whether users should be notified they need to approve organization's MDM profile
+        # @!attribute alertUserApprovedMdm
+        #   @return [Boolean]
+        alertUserApprovedMdm: {
+          class: :boolean
+        },
+
+        # the default landing page in Self Service
+        # @!attribute defaultLandingPage
+        #   @return [String]
+        defaultLandingPage: {
+          class: :string,
+          enum: DEFAULT_LANDING_PAGE_OPTIONS
+        },
+
+        # id for the default home category in Self Service
+        # @!attribute defaultHomeCategoryId
+        #   @return [Integer]
+        defaultHomeCategoryId: {
+          class: :integer,
+          format: 'int32'
+        },
+
+        # renamed string for bookmarks if the admin wishes
+        # @!attribute bookmarksName
+        #   @return [String]
+        bookmarksName: {
+          class: :string,
+          required: true
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class SelfServiceInteractionSettings
+
+  end # module OAPISchemas
+
+end # module Jamf

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

@@ -0,0 +1,114 @@
+# 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: SelfServiceLoginSettings
+    #
+    # Description of this class from the OAPI Schema:
+    #   object representation of Self Service settings regarding login
+
+    #
+    # This class was automatically genereated from the api/schema
+    # URL path on a Jamf Pro server version 10.36.1-t1645562643
+    #
+    # 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::SelfServiceSettings
+    #
+    # 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 SelfServiceLoginSettings < Jamf::OAPIObject
+
+      # Enums used by this class or others
+
+      USER_LOGIN_LEVEL_OPTIONS = [
+        'NotRequired',
+        'Anonymous',
+        'Required'
+      ]
+
+      AUTH_TYPE_OPTIONS = [
+        'Basic',
+        'Saml'
+      ]
+
+      OAPI_PROPERTIES = {
+
+        # login setting to tell clients how to let users log in
+        # @!attribute userLoginLevel
+        #   @return [String]
+        userLoginLevel: {
+          class: :string,
+          required: true,
+          enum: USER_LOGIN_LEVEL_OPTIONS
+        },
+
+        # true if remember me functionality is allowed, false if not
+        # @!attribute allowRememberMe
+        #   @return [Boolean]
+        allowRememberMe: {
+          class: :boolean
+        },
+
+        # login type to be used when asking users to log in
+        # @!attribute authType
+        #   @return [String]
+        authType: {
+          class: :string,
+          required: true,
+          enum: AUTH_TYPE_OPTIONS
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class SelfServiceLoginSettings
+
+  end # module OAPISchemas
+
+end # module Jamf

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

@@ -0,0 +1,101 @@
+# 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: SelfServiceSettings
+    #
+    # Description of this class from the OAPI Schema:
+    #   object representation of Self Service settings
+
+    #
+    # This class was automatically genereated from the api/schema
+    # URL path on a Jamf Pro server version 10.36.1-t1645562643
+    #
+    # 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::SelfServiceInstallSettings
+    #  - Jamf::OAPISchemas::SelfServiceLoginSettings
+    #  - Jamf::OAPISchemas::SelfServiceInteractionSettings
+    #
+    # Endpoints and Privileges:
+    # API endpoints and HTTP operations that use this object
+    # model, and the Jamf Pro privileges needed to access them.
+    #  - '/v1/self-service/settings:GET' needs permissions:
+    #    - Read Self Service
+    #  - '/v1/self-service/settings:PUT' needs permissions:
+    #    - Update Self Service
+    #
+    #
+    class SelfServiceSettings < Jamf::OAPIObject
+
+      
+
+      OAPI_PROPERTIES = {
+
+        # @!attribute installSettings
+        #   @return [Jamf::OAPISchemas::SelfServiceInstallSettings]
+        installSettings: {
+          class: Jamf::OAPISchemas::SelfServiceInstallSettings
+        },
+
+        # @!attribute loginSettings
+        #   @return [Jamf::OAPISchemas::SelfServiceLoginSettings]
+        loginSettings: {
+          class: Jamf::OAPISchemas::SelfServiceLoginSettings
+        },
+
+        # @!attribute configurationSettings
+        #   @return [Jamf::OAPISchemas::SelfServiceInteractionSettings]
+        configurationSettings: {
+          class: Jamf::OAPISchemas::SelfServiceInteractionSettings
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class SelfServiceSettings
+
+  end # module OAPISchemas
+
+end # module Jamf