ruby-jss 1.6.4 → 2.0.0b1

data/lib/jamf/api/jamf_pro/oapi_schemas/self_service_interaction_settings.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: 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.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::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,113 @@
+# 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.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::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,100 @@
+# 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.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::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

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

@@ -0,0 +1,82 @@
+# 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: Session
+    #
+    #
+    #
+    # 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.
+    #  - '/user/updateSession:POST' needs permissions:
+    #    - Unknown
+    #
+    #
+    class Session < Jamf::OAPIObject
+
+      
+
+      OAPI_PROPERTIES = {
+
+        # @!attribute currentSiteId
+        #   @return [Integer]
+        currentSiteId: {
+          class: :integer
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class Session
+
+  end # module OAPISchemas
+
+end # module Jamf

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

@@ -0,0 +1,108 @@
+# 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: SessionCandidateRequest
+    #
+    # Description of this class from the OAPI Schema:
+    #   Request to crate new remote session. Ultimately this allows connection between an admin and an end-user
+    #
+    # 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.
+    #  - '/preview/remote-administration-configurations/team-viewer/{configurationId}/sessions:POST' needs permissions:
+    #    - Create Remote Administration
+    #
+    #
+    class SessionCandidateRequest < Jamf::OAPIObject
+
+      # Enums used by this class or others
+
+      DEVICE_TYPE_OPTIONS = [
+        'COMPUTER'
+      ]
+
+      OAPI_PROPERTIES = {
+
+        # Device identifier
+        # @!attribute deviceId
+        #   @return [String]
+        deviceId: {
+          class: :string,
+          required: true
+        },
+
+        # Device type
+        # @!attribute deviceType
+        #   @return [String]
+        deviceType: {
+          class: :string,
+          required: true,
+          enum: DEVICE_TYPE_OPTIONS
+        },
+
+        # Session description. To be used for additional context on the reason of the session
+        # @!attribute description
+        #   @return [String]
+        description: {
+          class: :string,
+          required: true,
+          min_length: 0,
+          max_length: 255
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class SessionCandidateRequest
+
+  end # module OAPISchemas
+
+end # module Jamf

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

@@ -0,0 +1,175 @@
+# 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: SessionDetails
+    #
+    # Description of this class from the OAPI Schema:
+    #   Session details
+    #
+    # 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::SessionDetailsSearchResults
+    #
+    # 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.
+    #  - '/preview/remote-administration-configurations/team-viewer/{configurationId}/sessions/{sessionId}:GET' needs permissions:
+    #    - Read Remote Administration
+    #
+    #
+    class SessionDetails < Jamf::OAPIObject
+
+      # Enums used by this class or others
+
+      DEVICE_TYPE_OPTIONS = [
+        'COMPUTER'
+      ]
+
+      STATE_OPTIONS = [
+        'OPEN',
+        'CLOSED',
+        'UNKNOWN'
+      ]
+
+      OAPI_PROPERTIES = {
+
+        # Session identifier
+        # @!attribute id
+        #   @return [String]
+        id: {
+          class: :j_id,
+          identifier: :primary
+        },
+
+        # Sessions code
+        # @!attribute code
+        #   @return [String]
+        code: {
+          class: :string
+        },
+
+        # Session description. To be used for additional context on the reason of the session
+        # @!attribute description
+        #   @return [String]
+        description: {
+          class: :string
+        },
+
+        # Supporter session URL
+        # @!attribute supporterLink
+        #   @return [String]
+        supporterLink: {
+          class: :string
+        },
+
+        # End user session URL
+        # @!attribute endUserLink
+        #   @return [String]
+        endUserLink: {
+          class: :string
+        },
+
+        # Device identifier
+        # @!attribute deviceId
+        #   @return [String]
+        deviceId: {
+          class: :string
+        },
+
+        # Device name if found - null otherwise
+        # @!attribute deviceName
+        #   @return [String]
+        deviceName: {
+          class: :string
+        },
+
+        # Device type
+        # @!attribute deviceType
+        #   @return [String]
+        deviceType: {
+          class: :string,
+          enum: DEVICE_TYPE_OPTIONS
+        },
+
+        # Session state
+        # @!attribute state
+        #   @return [String]
+        state: {
+          class: :string,
+          enum: STATE_OPTIONS
+        },
+
+        # ID of session creator if session created by Jamf Pro local user, null otherwise
+        # @!attribute creatorId
+        #   @return [String]
+        creatorId: {
+          class: :string
+        },
+
+        # Username of the session creator
+        # @!attribute creatorName
+        #   @return [String]
+        creatorName: {
+          class: :string
+        },
+
+        # Session creation time
+        # @!attribute createdAt
+        #   @return [Jamf::Timestamp]
+        createdAt: {
+          class: Jamf::Timestamp,
+          format: 'date-time'
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class SessionDetails
+
+  end # module OAPISchemas
+
+end # module Jamf