ruby-jss 1.6.4 → 2.0.0a10

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

@@ -0,0 +1,107 @@
+# 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: ComputerPrestage
+    #
+    #
+    #
+    # 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.
+    #
+    #
+    # Endpoints and Privileges:
+    # API endpoints and HTTP operations that use this object
+    # model, and the Jamf Pro privileges needed to access them.
+    #  - '/v1/computer-prestages:POST' needs permissions:
+    #    - Create Computer PreStage Enrollments
+    #
+    #
+    class ComputerPrestage < Jamf::OAPIObject
+
+      
+
+      OAPI_PROPERTIES = {
+
+        # @!attribute isInstallProfilesDuringSetup
+        #   @return [Boolean]
+        isInstallProfilesDuringSetup: {
+          class: :boolean,
+          required: true
+        },
+
+        # @!attribute prestageInstalledProfileIds
+        #   @return [Array<Integer>]
+        prestageInstalledProfileIds: {
+          class: :integer,
+          required: true,
+          multi: true
+        },
+
+        # @!attribute customPackageIds
+        #   @return [Array<Integer>]
+        customPackageIds: {
+          class: :integer,
+          required: true,
+          multi: true
+        },
+
+        # @!attribute customPackageDistributionPointId
+        #   @return [Integer]
+        customPackageDistributionPointId: {
+          class: :integer,
+          required: true
+        }
+
+      }.merge(Jamf::OAPISchemas::DeviceEnrollmentPrestage::OAPI_PROPERTIES) # end OAPI_PROPERTIES
+
+    end # class ComputerPrestage
+
+  end # module OAPISchemas
+
+end # module Jamf

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

@@ -0,0 +1,90 @@
+# 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: ComputerPrestageSearchResults
+    #
+    #
+    #
+    # 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::GetComputerPrestage
+    #
+    # Endpoints and Privileges:
+    # API endpoints and HTTP operations that use this object
+    # model, and the Jamf Pro privileges needed to access them.
+    #  - '/v1/computer-prestages:GET' needs permissions:
+    #    - Read Computer PreStage Enrollments
+    #
+    #
+    class ComputerPrestageSearchResults < Jamf::OAPIObject
+
+      
+
+      OAPI_PROPERTIES = {
+
+        # @!attribute totalCount
+        #   @return [Integer]
+        totalCount: {
+          class: :integer
+        },
+
+        # @!attribute results
+        #   @return [Array<Jamf::OAPISchemas::GetComputerPrestage>]
+        results: {
+          class: Jamf::OAPISchemas::GetComputerPrestage,
+          multi: true
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class ComputerPrestageSearchResults
+
+  end # module OAPISchemas
+
+end # module Jamf

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

@@ -0,0 +1,90 @@
+# 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: ComputerPrestageSearchResultsV2
+    #
+    #
+    #
+    # 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::GetComputerPrestageV2
+    #
+    # Endpoints and Privileges:
+    # API endpoints and HTTP operations that use this object
+    # model, and the Jamf Pro privileges needed to access them.
+    #  - '/v2/computer-prestages:GET' needs permissions:
+    #    - Read Computer PreStage Enrollments
+    #
+    #
+    class ComputerPrestageSearchResultsV2 < Jamf::OAPIObject
+
+      
+
+      OAPI_PROPERTIES = {
+
+        # @!attribute totalCount
+        #   @return [Integer]
+        totalCount: {
+          class: :integer
+        },
+
+        # @!attribute results
+        #   @return [Array<Jamf::OAPISchemas::GetComputerPrestageV2>]
+        results: {
+          class: Jamf::OAPISchemas::GetComputerPrestageV2,
+          multi: true
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class ComputerPrestageSearchResultsV2
+
+  end # module OAPISchemas
+
+end # module Jamf

data/lib/jamf/api/jamf_pro/oapi_schemas/computer_prestage_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: ComputerPrestageV2
+    #
+    #
+    #
+    # 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.
+    #
+    #
+    # Endpoints and Privileges:
+    # API endpoints and HTTP operations that use this object
+    # model, and the Jamf Pro privileges needed to access them.
+    #
+    #
+    #
+    class ComputerPrestageV2 < Jamf::OAPIObject
+
+      # Enums used by this class or others
+
+      RECOVERY_LOCK_PASSWORD_TYPE_OPTIONS = [
+        'MANUAL',
+        'RANDOM'
+      ]
+
+      OAPI_PROPERTIES = {
+
+        # @!attribute installProfilesDuringSetup
+        #   @return [Boolean]
+        installProfilesDuringSetup: {
+          class: :boolean,
+          required: true
+        },
+
+        # @!attribute prestageInstalledProfileIds
+        #   @return [Array<String>]
+        prestageInstalledProfileIds: {
+          class: :string,
+          required: true,
+          multi: true
+        },
+
+        # @!attribute customPackageIds
+        #   @return [Array<String>]
+        customPackageIds: {
+          class: :string,
+          required: true,
+          multi: true
+        },
+
+        # @!attribute customPackageDistributionPointId
+        #   @return [String]
+        customPackageDistributionPointId: {
+          class: :string,
+          required: true
+        },
+
+        # @!attribute enableRecoveryLock
+        #   @return [Boolean]
+        enableRecoveryLock: {
+          class: :boolean
+        },
+
+        # @!attribute recoveryLockPasswordType
+        #   @return [String]
+        recoveryLockPasswordType: {
+          class: :string,
+          enum: RECOVERY_LOCK_PASSWORD_TYPE_OPTIONS
+        },
+
+        # @!attribute rotateRecoveryLockPassword
+        #   @return [Boolean]
+        rotateRecoveryLockPassword: {
+          class: :boolean
+        }
+
+      }.merge(Jamf::OAPISchemas::DeviceEnrollmentPrestageV2::OAPI_PROPERTIES) # end OAPI_PROPERTIES
+
+    end # class ComputerPrestageV2
+
+  end # module OAPISchemas
+
+end # module Jamf

data/lib/jamf/api/jamf_pro/oapi_schemas/computer_printer.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: ComputerPrinter
+    #
+    #
+    #
+    # 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::ComputerInventoryResponse
+    #
+    # 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 ComputerPrinter < Jamf::OAPIObject
+
+      
+
+      OAPI_PROPERTIES = {
+
+        # @!attribute name
+        #   @return [String]
+        name: {
+          class: :string
+        },
+
+        # @!attribute type
+        #   @return [String]
+        type: {
+          class: :string
+        },
+
+        # @!attribute uri
+        #   @return [String]
+        uri: {
+          class: :string
+        },
+
+        # @!attribute location
+        #   @return [String]
+        location: {
+          class: :string
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class ComputerPrinter
+
+  end # module OAPISchemas
+
+end # module Jamf

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

@@ -0,0 +1,159 @@
+# 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: ComputerPurchase
+    #
+    #
+    #
+    # 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::ComputerInventoryResponse
+    #  - Jamf::OAPISchemas::ComputerInventoryUpdateRequest
+    #
+    # Sub Objects:
+    # Other object models used by this model's attributes.
+    #  - Jamf::OAPISchemas::ComputerExtensionAttribute
+    #
+    # Endpoints and Privileges:
+    # API endpoints and HTTP operations that use this object
+    # model, and the Jamf Pro privileges needed to access them.
+    #
+    #
+    #
+    class ComputerPurchase < Jamf::OAPIObject
+
+      
+
+      OAPI_PROPERTIES = {
+
+        # @!attribute leased
+        #   @return [Boolean]
+        leased: {
+          class: :boolean
+        },
+
+        # @!attribute purchased
+        #   @return [Boolean]
+        purchased: {
+          class: :boolean
+        },
+
+        # @!attribute poNumber
+        #   @return [String]
+        poNumber: {
+          class: :string
+        },
+
+        # @!attribute poDate
+        #   @return [String]
+        poDate: {
+          class: :string,
+          format: 'date'
+        },
+
+        # @!attribute vendor
+        #   @return [String]
+        vendor: {
+          class: :string
+        },
+
+        # @!attribute warrantyDate
+        #   @return [String]
+        warrantyDate: {
+          class: :string,
+          format: 'date'
+        },
+
+        # @!attribute appleCareId
+        #   @return [String]
+        appleCareId: {
+          class: :string
+        },
+
+        # @!attribute leaseDate
+        #   @return [String]
+        leaseDate: {
+          class: :string,
+          format: 'date'
+        },
+
+        # @!attribute purchasePrice
+        #   @return [String]
+        purchasePrice: {
+          class: :string
+        },
+
+        # @!attribute lifeExpectancy
+        #   @return [Integer]
+        lifeExpectancy: {
+          class: :integer
+        },
+
+        # @!attribute purchasingAccount
+        #   @return [String]
+        purchasingAccount: {
+          class: :string
+        },
+
+        # @!attribute purchasingContact
+        #   @return [String]
+        purchasingContact: {
+          class: :string
+        },
+
+        # @!attribute extensionAttributes
+        #   @return [Array<Jamf::OAPISchemas::ComputerExtensionAttribute>]
+        extensionAttributes: {
+          class: Jamf::OAPISchemas::ComputerExtensionAttribute,
+          multi: true
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class ComputerPurchase
+
+  end # module OAPISchemas
+
+end # module Jamf