ruby-jss 4.1.0 → 4.1.1b2

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

@@ -1,4 +1,4 @@
-# Copyright 2023 Pixar
+# Copyright 2024 Pixar
 #
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")
 #    with the following modification; you may not use this file except in
@@ -34,8 +34,8 @@ module Jamf
     #
     #
     #
-    # This class was automatically genereated from the api/schema
-    # URL path on a Jamf Pro server version 10.50.0-t1693149930
+    # This class was automatically generated from the api/schema
+    # URL path on a Jamf Pro server version 11.6.1-t1718634702
     #
     # 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.
@@ -75,6 +75,8 @@ module Jamf
     #    - Update Engage Settings
     #  - '/v1/enrollment-customization/{id}/history:POST' needs permissions:
     #    - Update Enrollment Customizations
+    #  - '/v1/gsx-connection/history:POST' needs permissions:
+    #    - Update GSX Connection
     #  - '/v1/inventory-preload/history:POST' needs permissions:
     #    - Update Inventory Preload Records
     #  - '/v1/jamf-connect/history:POST' needs permissions:
@@ -85,6 +87,10 @@ module Jamf
     #    - Update Jamf Protect Settings
     #  - '/v1/mobile-device-prestages/{id}/history:POST' needs permissions:
     #    - Update Mobile Device PreStage Enrollments
+    #  - '/v1/onboarding/history:POST' needs permissions:
+    #    - Update Onboarding Configuration
+    #  - '/v1/packages/{id}/history:POST' needs permissions:
+    #    - Update Packages
     #  - '/v1/parent-app/history:POST' needs permissions:
     #    - Update Parent App Settings
     #  - '/v1/pki/venafi/{id}/history:POST' needs permissions:
@@ -93,14 +99,16 @@ module Jamf
     #    - Update Re-enrollment
     #  - '/v1/scripts/{id}/history:POST' needs permissions:
     #    - Update Scripts
+    #  - '/v1/smtp-server/history:POST' needs permissions:
+    #    - Update SMTP Server
     #  - '/v1/sso/history:POST' needs permissions:
     #    - Update SSO Settings
     #  - '/v1/teacher-app/history:POST' needs permissions:
     #    - Update Teacher App Settings
     #  - '/v1/volume-purchasing-locations/{id}/history:POST' needs permissions:
     #    - Update Volume Purchasing Locations
-    #  - '/v2/check-in/history:POST' needs permissions:
-    #    - Update Computer Check-In
+    #  - '/v1/volume-purchasing-subscriptions/{id}/history:POST' needs permissions:
+    #    - Update Volume Purchasing Locations
     #  - '/v2/engage/history:POST' needs permissions:
     #    - Update Engage Settings
     #  - '/v2/enrollment-customizations/{id}/history:POST' needs permissions:
@@ -113,6 +121,8 @@ module Jamf
     #    - Update Mobile Device PreStage Enrollments
     #  - '/v2/patch-software-title-configurations/{id}/history:POST' needs permissions:
     #    - Update Patch Management Software Titles
+    #  - '/v2/sso/history:POST' needs permissions:
+    #    - Update SSO Settings
     #  - '/v3/check-in/history:POST' needs permissions:
     #    - Update Computer Check-In
     #

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

@@ -1,4 +1,4 @@
-# Copyright 2023 Pixar
+# Copyright 2024 Pixar
 #
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")
 #    with the following modification; you may not use this file except in
@@ -34,8 +34,8 @@ module Jamf
     #
     #
     #
-    # This class was automatically genereated from the api/schema
-    # URL path on a Jamf Pro server version 10.50.0-t1693149930
+    # This class was automatically generated from the api/schema
+    # URL path on a Jamf Pro server version 11.6.1-t1718634702
     #
     # 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.

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

@@ -0,0 +1,101 @@
+# Copyright 2024 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: OnboardingConfiguration
+    #
+    #
+    #
+    # This class was automatically generated from the api/schema
+    # URL path on a Jamf Pro server version 11.6.1-t1718634702
+    #
+    # 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::OnboardingItem
+    #
+    # Endpoints and Privileges:
+    # API endpoints and HTTP operations that use this object
+    # model, and the Jamf Pro privileges needed to access them.
+    #  - '/v1/onboarding:GET' needs permissions:
+    #    - Read Onboarding Configuration
+    #  - '/v1/onboarding:PUT' needs permissions:
+    #    - Update Onboarding Configuration
+    #
+    #
+    class OnboardingConfiguration < Jamf::OAPIObject
+
+      
+
+      OAPI_PROPERTIES = {
+
+        # @!attribute [r] id
+        #   @return [String]
+        id: {
+          class: :j_id,
+          identifier: :primary,
+          readonly: true
+        },
+
+        # @!attribute enabled
+        #   @return [Boolean]
+        enabled: {
+          class: :boolean,
+          required: true
+        },
+
+        # @!attribute onboardingItems
+        #   @return [Array<Jamf::OAPISchemas::OnboardingItem>]
+        onboardingItems: {
+          class: Jamf::OAPISchemas::OnboardingItem,
+          required: true,
+          multi: true
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class OnboardingConfiguration
+
+  end # module OAPISchemas
+
+end # module Jamf

data/lib/jamf/api/jamf_pro/oapi_schemas/{extension_attribute.rb → onboarding_eligible_item.rb}

@@ -1,4 +1,4 @@
-# Copyright 2023 Pixar
+# Copyright 2024 Pixar
 #
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")
 #    with the following modification; you may not use this file except in
@@ -30,12 +30,12 @@ module Jamf
   module OAPISchemas
 
 
-    # OAPI Object Model and Enums for: ExtensionAttribute
+    # OAPI Object Model and Enums for: OnboardingEligibleItem
     #
     #
     #
-    # This class was automatically genereated from the api/schema
-    # URL path on a Jamf Pro server version 10.50.0-t1693149930
+    # This class was automatically generated from the api/schema
+    # URL path on a Jamf Pro server version 11.6.1-t1718634702
     #
     # 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.
@@ -48,8 +48,7 @@ module Jamf
     # Container Objects:
     # Other object models that use this model as the value in one
     # of their attributes.
-    #  - Jamf::OAPISchemas::MobileDeviceDetails
-    #  - Jamf::OAPISchemas::UpdateMobileDevice
+    #  - Jamf::OAPISchemas::OnboardingEligibleItemsSearchResult
     #
     # Sub Objects:
     # Other object models used by this model's attributes.
@@ -61,54 +60,44 @@ module Jamf
     #
     #
     #
-    class ExtensionAttribute < Jamf::OAPIObject
+    class OnboardingEligibleItem < Jamf::OAPIObject
 
-      # Enums used by this class or others
-
-      TYPE_OPTIONS = [
-        'STRING',
-        'INTEGER',
-        'DATE'
-      ]
+      
 
       OAPI_PROPERTIES = {
 
         # @!attribute id
-        #   @return [Integer]
+        #   @return [String]
         id: {
           class: :j_id,
+          required: true,
           identifier: :primary
         },
 
         # @!attribute name
         #   @return [String]
         name: {
-          class: :string
+          class: :string,
+          required: true
         },
 
-        # @!attribute type
+        # @!attribute scopeDescription
         #   @return [String]
-        type: {
+        scopeDescription: {
           class: :string,
-          enum: TYPE_OPTIONS
+          required: true
         },
 
-        # @!attribute value
-        #   @return [Array<String>]
-        value: {
+        # @!attribute siteDescription
+        #   @return [String]
+        siteDescription: {
           class: :string,
-          multi: true
-        },
-
-        # @!attribute isExtensionAttributeCollectionAllowed
-        #   @return [Boolean]
-        isExtensionAttributeCollectionAllowed: {
-          class: :boolean
+          required: true
         }
 
       } # end OAPI_PROPERTIES
 
-    end # class ExtensionAttribute
+    end # class OnboardingEligibleItem
 
   end # module OAPISchemas
 

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

@@ -0,0 +1,94 @@
+# Copyright 2024 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: OnboardingEligibleItemsSearchResult
+    #
+    # Description of this class from the OAPI Schema:
+    #   A list of onboarding eligible items
+    #
+    # This class was automatically generated from the api/schema
+    # URL path on a Jamf Pro server version 11.6.1-t1718634702
+    #
+    # 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::OnboardingEligibleItem
+    #
+    # Endpoints and Privileges:
+    # API endpoints and HTTP operations that use this object
+    # model, and the Jamf Pro privileges needed to access them.
+    #  - '/v1/onboarding/eligible-apps:GET' needs permissions:
+    #    - Read Onboarding Configuration
+    #  - '/v1/onboarding/eligible-configuration-profiles:GET' needs permissions:
+    #    - Read Onboarding Configuration
+    #  - '/v1/onboarding/eligible-policies:GET' needs permissions:
+    #    - Read Onboarding Configuration
+    #
+    #
+    class OnboardingEligibleItemsSearchResult < Jamf::OAPIObject
+
+      
+
+      OAPI_PROPERTIES = {
+
+        # @!attribute totalCount
+        #   @return [Integer]
+        totalCount: {
+          class: :integer
+        },
+
+        # @!attribute results
+        #   @return [Array<Jamf::OAPISchemas::OnboardingEligibleItem>]
+        results: {
+          class: Jamf::OAPISchemas::OnboardingEligibleItem,
+          multi: true
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class OnboardingEligibleItemsSearchResult
+
+  end # module OAPISchemas
+
+end # module Jamf

data/lib/jamf/api/jamf_pro/oapi_schemas/{mobile_device.rb → onboarding_item.rb}

@@ -1,4 +1,4 @@
-# Copyright 2023 Pixar
+# Copyright 2024 Pixar
 #
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")
 #    with the following modification; you may not use this file except in
@@ -30,12 +30,12 @@ module Jamf
   module OAPISchemas
 
 
-    # OAPI Object Model and Enums for: MobileDevice
+    # OAPI Object Model and Enums for: OnboardingItem
     #
     #
     #
-    # This class was automatically genereated from the api/schema
-    # URL path on a Jamf Pro server version 10.50.0-t1693149930
+    # This class was automatically generated from the api/schema
+    # URL path on a Jamf Pro server version 11.6.1-t1718634702
     #
     # 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.
@@ -48,7 +48,7 @@ module Jamf
     # Container Objects:
     # Other object models that use this model as the value in one
     # of their attributes.
-    #  - Jamf::OAPISchemas::MobileDeviceSearchResults
+    #  - Jamf::OAPISchemas::OnboardingConfiguration
     #
     # Sub Objects:
     # Other object models used by this model's attributes.
@@ -57,96 +57,83 @@ module Jamf
     # 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:GET' needs permissions:
-    #    - Read Mobile Devices
-    #  - '/v1/mobile-devices/{id}:GET' needs permissions:
-    #    - Read Mobile Devices
     #
     #
-    class MobileDevice < Jamf::OAPIObject
+    #
+    class OnboardingItem < Jamf::OAPIObject
 
       # Enums used by this class or others
 
-      TYPE_OPTIONS = [
-        'ios',
-        'appleTv',
-        'android',
-        'unknown'
+      SELF_SERVICE_ENTITY_TYPE_OPTIONS = [
+        'OS_X_POLICY',
+        'OS_X_CONFIG_PROFILE',
+        'OS_X_MAC_APP',
+        'OS_X_APP_INSTALLER',
+        'OS_X_EBOOK',
+        'OS_X_PATCH_POLICY',
+        'UNKNOWN'
       ]
 
       OAPI_PROPERTIES = {
 
         # @!attribute id
-        #   @return [Integer]
+        #   @return [String]
         id: {
           class: :j_id,
+          nil_ok: true,
           identifier: :primary
         },
 
-        # @!attribute name
-        #   @return [String]
-        name: {
-          class: :string
-        },
-
-        # @!attribute serialNumber
+        # The id of the Jamf Pro object that should be added to the onboarding workflow for end users.
+        # Use this in conjunction with the selfServiceEntityType. For example, if the policy with id 132
+        # should be added to onboarding, then entityId should be 132 and selfServiceEntityType should be 
+        # OS_X_POLICY.
+        # @!attribute entityId
         #   @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
+        entityId: {
+          class: :string,
+          required: true
         },
 
-        # @!attribute model
+        # @!attribute [r] entityName
         #   @return [String]
-        model: {
-          class: :string
+        entityName: {
+          class: :string,
+          readonly: true
         },
 
-        # @!attribute modelIdentifier
+        # @!attribute [r] scopeDescription
         #   @return [String]
-        modelIdentifier: {
-          class: :string
+        scopeDescription: {
+          class: :string,
+          readonly: true
         },
 
-        # @!attribute username
+        # @!attribute [r] siteDescription
         #   @return [String]
-        username: {
-          class: :string
+        siteDescription: {
+          class: :string,
+          readonly: true
         },
 
-        # @!attribute type
+        # @!attribute selfServiceEntityType
         #   @return [String]
-        type: {
+        selfServiceEntityType: {
           class: :string,
-          enum: TYPE_OPTIONS
+          required: true,
+          enum: SELF_SERVICE_ENTITY_TYPE_OPTIONS
         },
 
-        # @!attribute softwareUpdateDeviceId
-        #   @return [String]
-        softwareUpdateDeviceId: {
-          class: :string
+        # @!attribute priority
+        #   @return [Integer]
+        priority: {
+          class: :integer,
+          required: true
         }
 
       } # end OAPI_PROPERTIES
 
-    end # class MobileDevice
+    end # class OnboardingItem
 
   end # module OAPISchemas