ruby-jss 1.6.4 → 2.0.0b1

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

@@ -0,0 +1,234 @@
+# 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: DeviceEnrollmentPrestageV2
+    #
+    #
+    #
+    # 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::LocationInformationV2
+    #  - Jamf::OAPISchemas::PrestagePurchasingInformationV2
+    #
+    # Endpoints and Privileges:
+    # API endpoints and HTTP operations that use this object
+    # model, and the Jamf Pro privileges needed to access them.
+    #
+    #
+    #
+    class DeviceEnrollmentPrestageV2 < Jamf::OAPIObject
+
+      
+
+      OAPI_PROPERTIES = {
+
+        # @!attribute displayName
+        #   @return [String]
+        displayName: {
+          class: :string,
+          required: true
+        },
+
+        # @!attribute mandatory
+        #   @return [Boolean]
+        mandatory: {
+          class: :boolean,
+          required: true
+        },
+
+        # @!attribute mdmRemovable
+        #   @return [Boolean]
+        mdmRemovable: {
+          class: :boolean,
+          required: true
+        },
+
+        # @!attribute supportPhoneNumber
+        #   @return [String]
+        supportPhoneNumber: {
+          class: :string,
+          required: true
+        },
+
+        # @!attribute supportEmailAddress
+        #   @return [String]
+        supportEmailAddress: {
+          class: :string,
+          required: true
+        },
+
+        # @!attribute department
+        #   @return [String]
+        department: {
+          class: :string,
+          required: true
+        },
+
+        # @!attribute defaultPrestage
+        #   @return [Boolean]
+        defaultPrestage: {
+          class: :boolean,
+          required: true
+        },
+
+        # @!attribute enrollmentSiteId
+        #   @return [String]
+        enrollmentSiteId: {
+          class: :string,
+          required: true
+        },
+
+        # @!attribute keepExistingSiteMembership
+        #   @return [Boolean]
+        keepExistingSiteMembership: {
+          class: :boolean,
+          required: true
+        },
+
+        # @!attribute keepExistingLocationInformation
+        #   @return [Boolean]
+        keepExistingLocationInformation: {
+          class: :boolean,
+          required: true
+        },
+
+        # @!attribute requireAuthentication
+        #   @return [Boolean]
+        requireAuthentication: {
+          class: :boolean,
+          required: true
+        },
+
+        # @!attribute authenticationPrompt
+        #   @return [String]
+        authenticationPrompt: {
+          class: :string,
+          required: true
+        },
+
+        # @!attribute preventActivationLock
+        #   @return [Boolean]
+        preventActivationLock: {
+          class: :boolean,
+          required: true
+        },
+
+        # @!attribute enableDeviceBasedActivationLock
+        #   @return [Boolean]
+        enableDeviceBasedActivationLock: {
+          class: :boolean,
+          required: true
+        },
+
+        # @!attribute deviceEnrollmentProgramInstanceId
+        #   @return [String]
+        deviceEnrollmentProgramInstanceId: {
+          class: :string,
+          required: true
+        },
+
+        # @!attribute skipSetupItems
+        #   @return [Hash{Symbol: Boolean }]
+        skipSetupItems: {
+          class: :hash
+        },
+
+        # @!attribute locationInformation
+        #   @return [Jamf::OAPISchemas::LocationInformationV2]
+        locationInformation: {
+          class: Jamf::OAPISchemas::LocationInformationV2,
+          required: true
+        },
+
+        # @!attribute purchasingInformation
+        #   @return [Jamf::OAPISchemas::PrestagePurchasingInformationV2]
+        purchasingInformation: {
+          class: Jamf::OAPISchemas::PrestagePurchasingInformationV2,
+          required: true
+        },
+
+        # The Base64 encoded PEM Certificate
+        # @!attribute anchorCertificates
+        #   @return [Array<String>]
+        anchorCertificates: {
+          class: :string,
+          multi: true
+        },
+
+        # @!attribute enrollmentCustomizationId
+        #   @return [String]
+        enrollmentCustomizationId: {
+          class: :string
+        },
+
+        # @!attribute language
+        #   @return [String]
+        language: {
+          class: :string
+        },
+
+        # @!attribute region
+        #   @return [String]
+        region: {
+          class: :string
+        },
+
+        # @!attribute autoAdvanceSetup
+        #   @return [Boolean]
+        autoAdvanceSetup: {
+          class: :boolean,
+          required: true
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class DeviceEnrollmentPrestageV2
+
+  end # module OAPISchemas
+
+end # module Jamf

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

@@ -0,0 +1,94 @@
+# 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: DeviceEnrollmentToken
+    #
+    #
+    #
+    # 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.
+    #  - '/v1/device-enrollments/upload-token:POST' needs permissions:
+    #    - Create Device Enrollment Program Instances
+    #  - '/v1/device-enrollments/{id}/upload-token:PUT' needs permissions:
+    #    - Update Device Enrollment Program Instances
+    #
+    #
+    class DeviceEnrollmentToken < Jamf::OAPIObject
+
+      
+
+      OAPI_PROPERTIES = {
+
+        # Optional name of the token to be saved, if no name is provided one will be auto-generated
+        # @!attribute tokenFileName
+        #   @return [String]
+        tokenFileName: {
+          class: :string
+        },
+
+        # The base 64 encoded token
+        # @!attribute encodedToken
+        #   @return [String]
+        encodedToken: {
+          class: :string,
+          format: 'byte',
+          pattern: Regexp.new('^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$')
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class DeviceEnrollmentToken
+
+  end # module OAPISchemas
+
+end # module Jamf

data/lib/jamf/api/jamf_pro/oapi_schemas/diagnostic_submission_setting.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: DiagnosticSubmissionSetting
+    #
+    #
+    #
+    # 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::SettingsCommand
+    #
+    # 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 DiagnosticSubmissionSetting < Jamf::OAPIObject
+
+      # Enums used by this class or others
+
+      VALUE_OPTIONS = [
+        'ENABLE_DIAGNOSTIC_SUBMISSION',
+        'DISABLE_DIAGNOSTIC_SUBMISSION'
+      ]
+
+      OAPI_PROPERTIES = {
+
+        # @!attribute value
+        #   @return [String]
+        value: {
+          class: :string,
+          enum: VALUE_OPTIONS
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class DiagnosticSubmissionSetting
+
+  end # module OAPISchemas
+
+end # module Jamf

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

@@ -0,0 +1,152 @@
+# 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: Ebook
+    #
+    #
+    #
+    # 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::EbookSearchResults
+    #
+    # 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/ebooks/{id}:GET' needs permissions:
+    #    - Read eBooks
+    #
+    #
+    class Ebook < Jamf::OAPIObject
+
+      # Enums used by this class or others
+
+      KIND_OPTIONS = [
+        'UNKNOWN',
+        'PDF',
+        'EPUB',
+        'IBOOKS'
+      ]
+
+      OAPI_PROPERTIES = {
+
+        # @!attribute id
+        #   @return [String]
+        id: {
+          class: :j_id,
+          identifier: :primary
+        },
+
+        # @!attribute name
+        #   @return [String]
+        name: {
+          class: :string
+        },
+
+        # @!attribute kind
+        #   @return [String]
+        kind: {
+          class: :string,
+          enum: KIND_OPTIONS
+        },
+
+        # @!attribute url
+        #   @return [String]
+        url: {
+          class: :string
+        },
+
+        # @!attribute free
+        #   @return [Boolean]
+        free: {
+          class: :boolean
+        },
+
+        # @!attribute version
+        #   @return [String]
+        version: {
+          class: :string
+        },
+
+        # @!attribute author
+        #   @return [String]
+        author: {
+          class: :string
+        },
+
+        # If true, it will be automatically installed
+        # @!attribute deployAsManaged
+        #   @return [Boolean]
+        deployAsManaged: {
+          class: :boolean
+        },
+
+        # @!attribute installAutomatically
+        #   @return [Boolean]
+        installAutomatically: {
+          class: :boolean
+        },
+
+        # @!attribute categoryId
+        #   @return [String]
+        categoryId: {
+          class: :string
+        },
+
+        # @!attribute siteId
+        #   @return [String]
+        siteId: {
+          class: :string
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class Ebook
+
+  end # module OAPISchemas
+
+end # module Jamf

data/lib/jamf/api/jamf_pro/oapi_schemas/ebook_exclusions.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: EbookExclusions
+    #
+    #
+    #
+    # 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::EbookScope
+    #
+    # Sub Objects:
+    # Other object models used by this model's attributes.
+    #  - Jamf::OAPISchemas::EbookLimitations
+    #
+    # Endpoints and Privileges:
+    # API endpoints and HTTP operations that use this object
+    # model, and the Jamf Pro privileges needed to access them.
+    #
+    #
+    #
+    class EbookExclusions < Jamf::OAPIObject
+
+      
+
+      OAPI_PROPERTIES = {
+
+        # @!attribute computerIds
+        #   @return [Array<String>]
+        computerIds: {
+          class: :string,
+          multi: true
+        },
+
+        # @!attribute computerGroupIds
+        #   @return [Array<String>]
+        computerGroupIds: {
+          class: :string,
+          multi: true
+        },
+
+        # @!attribute mobileDeviceIds
+        #   @return [Array<String>]
+        mobileDeviceIds: {
+          class: :string,
+          multi: true
+        },
+
+        # @!attribute mobileDeviceGroupIds
+        #   @return [Array<String>]
+        mobileDeviceGroupIds: {
+          class: :string,
+          multi: true
+        },
+
+        # @!attribute buildingIds
+        #   @return [Array<String>]
+        buildingIds: {
+          class: :string,
+          multi: true
+        },
+
+        # @!attribute departmentIds
+        #   @return [Array<String>]
+        departmentIds: {
+          class: :string,
+          multi: true
+        },
+
+        # @!attribute userIds
+        #   @return [Array<String>]
+        userIds: {
+          class: :string,
+          multi: true
+        },
+
+        # @!attribute userGroupIds
+        #   @return [Array<String>]
+        userGroupIds: {
+          class: :string,
+          multi: true
+        },
+
+        # @!attribute limitations
+        #   @return [Jamf::OAPISchemas::EbookLimitations]
+        limitations: {
+          class: Jamf::OAPISchemas::EbookLimitations
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class EbookExclusions
+
+  end # module OAPISchemas
+
+end # module Jamf