ruby-jss 1.6.4 → 2.0.0a10

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

@@ -0,0 +1,118 @@
+# 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: ExportParameters
+    #
+    #
+    #
+    # 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::ExportField
+    #
+    # 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/export:POST' needs permissions:
+    #    - Read LDAP Servers
+    #  - '/v2/inventory-preload/export:POST' needs permissions:
+    #    - Read Inventory Preload Records
+    #
+    #
+    class ExportParameters < Jamf::OAPIObject
+
+      
+
+      OAPI_PROPERTIES = {
+
+        # @!attribute page
+        #   @return [Integer]
+        page: {
+          class: :integer,
+          nil_ok: true
+        },
+
+        # @!attribute pageSize
+        #   @return [Integer]
+        pageSize: {
+          class: :integer,
+          nil_ok: true
+        },
+
+        # Sorting criteria in the format: [<property>[:asc/desc]. Default direction when not stated is ascending.
+        # @!attribute sort
+        #   @return [Array<String>]
+        sort: {
+          class: :string,
+          nil_ok: true,
+          multi: true
+        },
+
+        # @!attribute filter
+        #   @return [String]
+        filter: {
+          class: :string,
+          nil_ok: true
+        },
+
+        # Used to change default order or ignore some of the fields. When null or empty array, all fields will be exported.
+        # @!attribute fields
+        #   @return [Array<Jamf::OAPISchemas::ExportField>]
+        fields: {
+          class: Jamf::OAPISchemas::ExportField,
+          nil_ok: true,
+          multi: true
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class ExportParameters
+
+  end # module OAPISchemas
+
+end # module Jamf

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

@@ -0,0 +1,116 @@
+# 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: ExtensionAttribute
+    #
+    #
+    #
+    # 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::MobileDeviceDetails
+    #  - Jamf::OAPISchemas::UpdateMobileDevice
+    #
+    # 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 ExtensionAttribute < Jamf::OAPIObject
+
+      # Enums used by this class or others
+
+      TYPE_OPTIONS = [
+        'STRING',
+        'INTEGER',
+        'DATE'
+      ]
+
+      OAPI_PROPERTIES = {
+
+        # @!attribute id
+        #   @return [Integer]
+        id: {
+          class: :j_id,
+          identifier: :primary
+        },
+
+        # @!attribute name
+        #   @return [String]
+        name: {
+          class: :string
+        },
+
+        # @!attribute type
+        #   @return [String]
+        type: {
+          class: :string,
+          enum: TYPE_OPTIONS
+        },
+
+        # @!attribute value
+        #   @return [Array<String>]
+        value: {
+          class: :string,
+          multi: true
+        },
+
+        # @!attribute isExtensionAttributeCollectionAllowed
+        #   @return [Boolean]
+        isExtensionAttributeCollectionAllowed: {
+          class: :boolean
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class ExtensionAttribute
+
+  end # module OAPISchemas
+
+end # module Jamf

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

@@ -0,0 +1,117 @@
+# 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: ExtensionAttributeV2
+    #
+    #
+    #
+    # 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::MobileDeviceDetailsV2
+    #  - Jamf::OAPISchemas::UpdateMobileDeviceV2
+    #
+    # 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 ExtensionAttributeV2 < Jamf::OAPIObject
+
+      # Enums used by this class or others
+
+      TYPE_OPTIONS = [
+        'STRING',
+        'INTEGER',
+        'DATE'
+      ]
+
+      OAPI_PROPERTIES = {
+
+        # @!attribute [r] id
+        #   @return [String]
+        id: {
+          class: :j_id,
+          identifier: :primary,
+          readonly: true
+        },
+
+        # @!attribute name
+        #   @return [String]
+        name: {
+          class: :string
+        },
+
+        # @!attribute type
+        #   @return [String]
+        type: {
+          class: :string,
+          enum: TYPE_OPTIONS
+        },
+
+        # @!attribute value
+        #   @return [Array<String>]
+        value: {
+          class: :string,
+          multi: true
+        },
+
+        # @!attribute extensionAttributeCollectionAllowed
+        #   @return [Boolean]
+        extensionAttributeCollectionAllowed: {
+          class: :boolean
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class ExtensionAttributeV2
+
+  end # module OAPISchemas
+
+end # module Jamf

data/lib/jamf/api/jamf_pro/oapi_schemas/external_recipient.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: ExternalRecipient
+    #
+    #
+    #
+    # 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::VolumePurchasingSubscriptionBase
+    #
+    # 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 ExternalRecipient < Jamf::OAPIObject
+
+      
+
+      OAPI_PROPERTIES = {
+
+        # @!attribute name
+        #   @return [String]
+        name: {
+          class: :string,
+          required: true,
+          min_length: 1
+        },
+
+        # @!attribute email
+        #   @return [String]
+        email: {
+          class: :string,
+          required: true,
+          min_length: 1
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class ExternalRecipient
+
+  end # module OAPISchemas
+
+end # module Jamf

data/lib/jamf/api/jamf_pro/oapi_schemas/file_attachment.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: FileAttachment
+    #
+    #
+    #
+    # 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/mobile-device-prestages/{id}/attachments:GET' needs permissions:
+    #    - Read Mobile Device PreStage Enrollments
+    #
+    #
+    class FileAttachment < Jamf::OAPIObject
+
+      
+
+      OAPI_PROPERTIES = {
+
+        # @!attribute id
+        #   @return [Integer]
+        id: {
+          class: :j_id,
+          identifier: :primary
+        },
+
+        # @!attribute name
+        #   @return [String]
+        name: {
+          class: :string
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class FileAttachment
+
+  end # module OAPISchemas
+
+end # module Jamf

data/lib/jamf/api/jamf_pro/oapi_schemas/file_attachment_delete.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: FileAttachmentDelete
+    #
+    #
+    #
+    # 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/mobile-device-prestages/{id}/attachments:DELETE' needs permissions:
+    #    - Delete Mobile Device PreStage Enrollments
+    #
+    #
+    class FileAttachmentDelete < Jamf::OAPIObject
+
+      
+
+      OAPI_PROPERTIES = {
+
+        # @!attribute ids
+        #   @return [Array<Integer>]
+        ids: {
+          class: :integer,
+          multi: true
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class FileAttachmentDelete
+
+  end # module OAPISchemas
+
+end # module Jamf

data/lib/jamf/api/jamf_pro/oapi_schemas/file_attachment_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: FileAttachmentV2
+    #
+    #
+    #
+    # 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.
+    #  - '/v2/mobile-device-prestages/{id}/attachments:GET' needs permissions:
+    #    - Read Mobile Device PreStage Enrollments
+    #
+    #
+    class FileAttachmentV2 < Jamf::OAPIObject
+
+      
+
+      OAPI_PROPERTIES = {
+
+        # @!attribute id
+        #   @return [String]
+        id: {
+          class: :j_id,
+          identifier: :primary
+        },
+
+        # @!attribute name
+        #   @return [String]
+        name: {
+          class: :string
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class FileAttachmentV2
+
+  end # module OAPISchemas
+
+end # module Jamf