ruby-jss 1.6.4 → 2.0.0a10

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

@@ -0,0 +1,92 @@
+# 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: ProcessTextsSearchResults
+    #
+    #
+    #
+    # 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::EnrollmentProcessTextObject
+    #
+    # Endpoints and Privileges:
+    # API endpoints and HTTP operations that use this object
+    # model, and the Jamf Pro privileges needed to access them.
+    #  - '/v1/enrollment/languages:GET' needs permissions:
+    #    - Read User-Initiated Enrollment
+    #  - '/v2/enrollment/languages:GET' needs permissions:
+    #    - Read User-Initiated Enrollment
+    #
+    #
+    class ProcessTextsSearchResults < Jamf::OAPIObject
+
+      
+
+      OAPI_PROPERTIES = {
+
+        # @!attribute totalCount
+        #   @return [Integer]
+        totalCount: {
+          class: :integer
+        },
+
+        # @!attribute results
+        #   @return [Array<Jamf::OAPISchemas::EnrollmentProcessTextObject>]
+        results: {
+          class: Jamf::OAPISchemas::EnrollmentProcessTextObject,
+          multi: true
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class ProcessTextsSearchResults
+
+  end # module OAPISchemas
+
+end # module Jamf

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

@@ -0,0 +1,99 @@
+# 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: ProtectRegistrationRequest
+    #
+    # Description of this class from the OAPI Schema:
+    #   Create an API Client in the Jamf Protect web console to obtain these values.
+    #
+    # 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/jamf-protect/register:POST' needs permissions:
+    #    - Update Jamf Protect Settings
+    #
+    #
+    class ProtectRegistrationRequest < Jamf::OAPIObject
+
+      
+
+      OAPI_PROPERTIES = {
+
+        # @!attribute protectUrl
+        #   @return [String]
+        protectUrl: {
+          class: :string,
+          required: true
+        },
+
+        # @!attribute clientId
+        #   @return [String]
+        clientId: {
+          class: :string,
+          required: true
+        },
+
+        # @!attribute password
+        #   @return [String]
+        password: {
+          class: :string,
+          required: true
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class ProtectRegistrationRequest
+
+  end # module OAPISchemas
+
+end # module Jamf

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

@@ -0,0 +1,142 @@
+# 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: ProtectSettingsResponse
+    #
+    #
+    #
+    # 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/jamf-protect:GET' needs permissions:
+    #    - Read Jamf Protect Settings
+    #    - Read Jamf Protect Deployments
+    #  - '/v1/jamf-protect:PUT' needs permissions:
+    #    - Update Jamf Protect Settings
+    #  - '/v1/jamf-protect/register:POST' needs permissions:
+    #    - Update Jamf Protect Settings
+    #
+    #
+    class ProtectSettingsResponse < Jamf::OAPIObject
+
+      # Enums used by this class or others
+
+      SYNC_STATUS_OPTIONS = [
+        'IN_PROGRESS',
+        'COMPLETED',
+        'ERROR',
+        'UNKNOWN'
+      ]
+
+      OAPI_PROPERTIES = {
+
+        # @!attribute id
+        #   @return [String]
+        id: {
+          class: :j_id,
+          identifier: :primary
+        },
+
+        # @!attribute apiClientId
+        #   @return [String]
+        apiClientId: {
+          class: :string
+        },
+
+        # display name used when creating the API Client in the Jamf Protect web console
+        # @!attribute apiClientName
+        #   @return [String]
+        apiClientName: {
+          class: :string
+        },
+
+        # ID used when making requests to identify this particular Protect registration.
+        # @!attribute registrationId
+        #   @return [String]
+        registrationId: {
+          class: :string
+        },
+
+        # @!attribute protectUrl
+        #   @return [String]
+        protectUrl: {
+          class: :string
+        },
+
+        # @!attribute lastSyncTime
+        #   @return [String]
+        lastSyncTime: {
+          class: Jamf::Timestamp
+        },
+
+        # @!attribute syncStatus
+        #   @return [String]
+        syncStatus: {
+          class: :string,
+          enum: SYNC_STATUS_OPTIONS
+        },
+
+        # determines whether the Jamf Protect agent will be automatically installed on client computers
+        # @!attribute autoInstall
+        #   @return [Boolean]
+        autoInstall: {
+          class: :boolean
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class ProtectSettingsResponse
+
+  end # module OAPISchemas
+
+end # module Jamf

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

@@ -0,0 +1,84 @@
+# 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: ProtectUpdatableSettingsRequest
+    #
+    #
+    #
+    # 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/jamf-protect:PUT' needs permissions:
+    #    - Update Jamf Protect Settings
+    #
+    #
+    class ProtectUpdatableSettingsRequest < Jamf::OAPIObject
+
+      
+
+      OAPI_PROPERTIES = {
+
+        # determines whether the Jamf Protect agent will be automatically installed on client computers
+        # @!attribute autoInstall
+        #   @return [Boolean]
+        autoInstall: {
+          class: :boolean
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class ProtectUpdatableSettingsRequest
+
+  end # module OAPISchemas
+
+end # module Jamf

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

@@ -0,0 +1,96 @@
+# 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: ProvisioningProfile
+    #
+    #
+    #
+    # 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::IosDetails
+    #  - 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 ProvisioningProfile < Jamf::OAPIObject
+
+      
+
+      OAPI_PROPERTIES = {
+
+        # @!attribute displayName
+        #   @return [String]
+        displayName: {
+          class: :string
+        },
+
+        # @!attribute uuid
+        #   @return [String]
+        uuid: {
+          class: :string
+        },
+
+        # @!attribute expirationDate
+        #   @return [Jamf::Timestamp]
+        expirationDate: {
+          class: Jamf::Timestamp,
+          format: 'date-time'
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class ProvisioningProfile
+
+  end # module OAPISchemas
+
+end # module Jamf

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

@@ -0,0 +1,154 @@
+# 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: Purchasing
+    #
+    #
+    #
+    # 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::AppleTvDetails
+    #  - Jamf::OAPISchemas::IosDetails
+    #  - Jamf::OAPISchemas::UpdateAppleTv
+    #  - Jamf::OAPISchemas::UpdateIos
+    #
+    # 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 Purchasing < Jamf::OAPIObject
+
+      
+
+      OAPI_PROPERTIES = {
+
+        # @!attribute isPurchased
+        #   @return [Boolean]
+        isPurchased: {
+          class: :boolean
+        },
+
+        # @!attribute isLeased
+        #   @return [Boolean]
+        isLeased: {
+          class: :boolean
+        },
+
+        # @!attribute poNumber
+        #   @return [String]
+        poNumber: {
+          class: :string
+        },
+
+        # @!attribute vendor
+        #   @return [String]
+        vendor: {
+          class: :string
+        },
+
+        # @!attribute appleCareId
+        #   @return [String]
+        appleCareId: {
+          class: :string
+        },
+
+        # @!attribute purchasePrice
+        #   @return [String]
+        purchasePrice: {
+          class: :string
+        },
+
+        # @!attribute purchasingAccount
+        #   @return [String]
+        purchasingAccount: {
+          class: :string
+        },
+
+        # @!attribute poDate
+        #   @return [Jamf::Timestamp]
+        poDate: {
+          class: Jamf::Timestamp,
+          format: 'date-time'
+        },
+
+        # @!attribute warrantyExpiresDate
+        #   @return [Jamf::Timestamp]
+        warrantyExpiresDate: {
+          class: Jamf::Timestamp,
+          format: 'date-time'
+        },
+
+        # @!attribute leaseExpiresDate
+        #   @return [Jamf::Timestamp]
+        leaseExpiresDate: {
+          class: Jamf::Timestamp,
+          format: 'date-time'
+        },
+
+        # @!attribute lifeExpectancy
+        #   @return [Integer]
+        lifeExpectancy: {
+          class: :integer
+        },
+
+        # @!attribute purchasingContact
+        #   @return [String]
+        purchasingContact: {
+          class: :string
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class Purchasing
+
+  end # module OAPISchemas
+
+end # module Jamf