ruby-jss 1.6.4 → 2.0.0b1

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

@@ -0,0 +1,172 @@
+# 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: MdmCommandType
+    #
+    #
+    #
+    # 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::MdmCommand
+    #
+    # 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 MdmCommandType < Jamf::OAPIObject
+
+      # Enums used by this class or others
+
+      VALUE_OPTIONS = [
+        'DEVICE_LOCATION',
+        'ENABLE_LOST_MODE',
+        'ACTIVATION_LOCK_BYPASS_CODE',
+        'CLEAR_ACTIVATION_LOCK_BYPASS_CODE',
+        'ACCOUNT_CONFIGURATION',
+        'REFRESH_CELLULAR_PLANS',
+        'SETTINGS',
+        'CONTENT_CACHING_INFORMATION',
+        'UNMANAGE_DEVICE',
+        'ERASE_DEVICE',
+        'DEVICE_LOCK',
+        'CLEAR_PASSCODE',
+        'DELETE_USER',
+        'DEVICE_INFORMATION',
+        'SHUT_DOWN_DEVICE',
+        'RESTART_DEVICE',
+        'INSTALL_BYO_PROFILE',
+        'REMOVE_PROFILE',
+        'INSTALL_PROFILE',
+        'REINSTALL_PROFILE',
+        'INSTALL_PROVISIONING_PROFILE',
+        'PROFILE_LIST',
+        'REMOVE_PROVISIONING_PROFILE',
+        'CERTIFICATE_LIST',
+        'INSTALLED_APPLICATION_LIST',
+        'MANAGED_APPLICATION_LIST',
+        'INSTALL_APPLICATION',
+        'INSTALL_ENTERPRISE_APPLICATION',
+        'INSTALL_PACKAGE',
+        'REMOVE_APPLICATION',
+        'MANAGED_MEDIA_LIST',
+        'INSTALL_MEDIA',
+        'REMOVE_MEDIA',
+        'APPLY_REDEMPTION_CODE',
+        'SETTINGS_ENABLE_PERSONAL_HOTSPOT',
+        'SETTINGS_DISABLE_PERSONAL_HOTSPOT',
+        'UPDATE_INVENTORY',
+        'WALLPAPER',
+        'DEVICE_CONFIGURED',
+        'RESTRICTIONS',
+        'ENABLE_REMOTE_DESKTOP',
+        'DISABLE_REMOTE_DESKTOP',
+        'SECURITY_INFO',
+        'MARK_AS_UNMANAGED',
+        'QUERY_RESPONSES',
+        'AVAILABLE_OS_UPDATES',
+        'PROVISIONING_PROFILE_LIST',
+        'SCHEDULE_OS_UPDATE',
+        'OS_UPDATE_STATUS',
+        'INVITE_TO_PROGRAM',
+        'PUSH_TRIGGER',
+        'CLEAR_RESTRICTIONS_PASSWORD',
+        'BLANK_PUSH',
+        'CORPORATE_WIPE',
+        'DEVICE_INFO_ACCOUNT_HASH',
+        'DEVICE_INFO_ITUNES_ACTIVE',
+        'DEVICE_INFO_LAST_CLOUD_BACKUP_DATE',
+        'DEVICE_INFO_ACTIVE_MANAGED_USERS',
+        'DEVICE_NAME',
+        'ENABLE_ACTIVATION_LOCK',
+        'DISABLE_ACTIVATION_LOCK',
+        'LAST_CLOUD_BACKUP_DATE',
+        'MARK_AS_CORPORATE_WIPE',
+        'REQUEST_MIRRORING',
+        'SETTINGS_DISABLE_DATA_ROAMING',
+        'SETTINGS_DISABLE_VOICE_ROAMING',
+        'SETTINGS_DISABLE_DIAGNOSTIC_SUBMISSION',
+        'SETTINGS_DISABLE_APP_ANALYTICS',
+        'SETTINGS_ENABLE_DATA_ROAMING',
+        'SETTINGS_ENABLE_VOICE_ROAMING',
+        'SETTINGS_ENABLE_DIAGNOSTIC_SUBMISSION',
+        'SETTINGS_ENABLE_APP_ANALYTICS',
+        'SETTINGS_ENABLE_BLUETOOTH',
+        'SETTINGS_DISABLE_BLUETOOTH',
+        'SETTINGS_MOBILE_DEVICE_PER_APP_VPN',
+        'SETTINGS_MOBILE_DEVICE_APPLICATION_ATTRIBUTES',
+        'STOP_MIRRORING',
+        'PASSCODE_LOCK_GRACE_PERIOD',
+        'SCHEDULE_OS_UPDATE_SCAN',
+        'PLAY_LOST_MODE_SOUND',
+        'DISABLE_LOST_MODE',
+        'LOG_OUT_USER',
+        'USER_LIST',
+        'VALIDATE_APPLICATIONS',
+        'UNLOCK_USER_ACCOUNT',
+        'SET_RECOVERY_LOCK',
+        'UNKNOWN'
+      ]
+
+      OAPI_PROPERTIES = {
+
+        # @!attribute value
+        #   @return [String]
+        value: {
+          class: :string,
+          enum: VALUE_OPTIONS
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class MdmCommandType
+
+  end # module OAPISchemas
+
+end # module Jamf

data/lib/jamf/api/jamf_pro/oapi_schemas/membership_mappings.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: MembershipMappings
+    #
+    # Description of this class from the OAPI Schema:
+    #   Cloud Identity Provider user group membership mappings configuration
+    #
+    # 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::CloudLdapMappingsRequest
+    #  - Jamf::OAPISchemas::CloudLdapMappingsResponse
+    #
+    # 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 MembershipMappings < Jamf::OAPIObject
+
+      
+
+      OAPI_PROPERTIES = {
+
+        # @!attribute groupMembershipMapping
+        #   @return [String]
+        groupMembershipMapping: {
+          class: :string,
+          required: true
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class MembershipMappings
+
+  end # module OAPISchemas
+
+end # module Jamf

data/lib/jamf/api/jamf_pro/oapi_schemas/membership_test_search_request.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: MembershipTestSearchRequest
+    #
+    #
+    #
+    # 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/cloud-idp/{id}/test-user-membership:POST' needs permissions:
+    #    - Read LDAP Servers
+    #
+    #
+    class MembershipTestSearchRequest < Jamf::OAPIObject
+
+      
+
+      OAPI_PROPERTIES = {
+
+        # @!attribute username
+        #   @return [String]
+        username: {
+          class: :string,
+          required: true
+        },
+
+        # @!attribute groupname
+        #   @return [String]
+        groupname: {
+          class: :string,
+          required: true
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class MembershipTestSearchRequest
+
+  end # module OAPISchemas
+
+end # module Jamf

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

@@ -0,0 +1,88 @@
+# 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: MembershipTestSearchResponse
+    #
+    #
+    #
+    # 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/cloud-idp/{id}/test-user-membership:POST' needs permissions:
+    #    - Read LDAP Servers
+    #
+    #
+    class MembershipTestSearchResponse < Jamf::OAPIObject
+
+      
+
+      OAPI_PROPERTIES = {
+
+        # @!attribute username
+        #   @return [String]
+        username: {
+          class: :string
+        },
+
+        # @!attribute isMember
+        #   @return [Boolean]
+        isMember: {
+          class: :boolean
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class MembershipTestSearchResponse
+
+  end # module OAPISchemas
+
+end # module Jamf

data/lib/jamf/api/jamf_pro/oapi_schemas/memcached_endpoints.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: MemcachedEndpoints
+    #
+    #
+    #
+    # 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::CacheSettings
+    #
+    # 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 MemcachedEndpoints < Jamf::OAPIObject
+
+      
+
+      OAPI_PROPERTIES = {
+
+        # @!attribute [r] id
+        #   @return [String]
+        id: {
+          class: :j_id,
+          identifier: :primary,
+          readonly: true
+        },
+
+        # @!attribute name
+        #   @return [String]
+        name: {
+          class: :string
+        },
+
+        # @!attribute hostName
+        #   @return [String]
+        hostName: {
+          class: :string
+        },
+
+        # @!attribute port
+        #   @return [Integer]
+        port: {
+          class: :integer
+        },
+
+        # @!attribute enabled
+        #   @return [Boolean]
+        enabled: {
+          class: :boolean
+        },
+
+        # @!attribute jssCacheConfigurationId
+        #   @return [Integer]
+        jssCacheConfigurationId: {
+          class: :integer
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class MemcachedEndpoints
+
+  end # module OAPISchemas
+
+end # module Jamf

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

@@ -0,0 +1,153 @@
+# 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: MobileDevice
+    #
+    #
+    #
+    # 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::MobileDeviceSearchResults
+    #
+    # 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/mobile-devices:GET' needs permissions:
+    #    - Read Mobile Devices
+    #  - '/v1/mobile-devices/{id}:GET' needs permissions:
+    #    - Read Mobile Devices
+    #
+    #
+    class MobileDevice < Jamf::OAPIObject
+
+      # Enums used by this class or others
+
+      TYPE_OPTIONS = [
+        'ios',
+        'appleTv',
+        'android',
+        'unknown'
+      ]
+
+      OAPI_PROPERTIES = {
+
+        # @!attribute id
+        #   @return [Integer]
+        id: {
+          class: :j_id,
+          identifier: :primary
+        },
+
+        # @!attribute name
+        #   @return [String]
+        name: {
+          class: :string
+        },
+
+        # @!attribute serialNumber
+        #   @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
+        },
+
+        # @!attribute model
+        #   @return [String]
+        model: {
+          class: :string
+        },
+
+        # @!attribute modelIdentifier
+        #   @return [String]
+        modelIdentifier: {
+          class: :string
+        },
+
+        # @!attribute username
+        #   @return [String]
+        username: {
+          class: :string
+        },
+
+        # @!attribute type
+        #   @return [String]
+        type: {
+          class: :string,
+          enum: TYPE_OPTIONS
+        },
+
+        # @!attribute softwareUpdateDeviceId
+        #   @return [String]
+        softwareUpdateDeviceId: {
+          class: :string
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class MobileDevice
+
+  end # module OAPISchemas
+
+end # module Jamf