oci-cli 3.62.2__py3-none-any.whl → 3.63.1__py3-none-any.whl

oci_cli/help_text_producer/data_files/text/cmdref/marketplace-publisher/listing-revision/create-listing-revision-create-oci-listing-revision-details.txt

@@ -0,0 +1,318 @@
+"create-listing-revision-create-oci-listing-revision-details"
+*************************************************************
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Creates a new Listing Revision.
+
+
+Usage
+=====
+
+   oci marketplace-publisher listing-revision create-listing-revision-create-oci-listing-revision-details [OPTIONS]
+
+
+Required Parameters
+===================
+
+--headline [text]
+
+Single line introduction for the listing revision.
+
+--listing-id [text]
+
+The unique identifier for the listing this revision belongs to.
+
+--pricing-type [text]
+
+The pricing model for the listing revision.
+
+--products [complex type]
+
+List of Products subscribed by listing. This is a complex type whose
+value must be valid JSON. The value can be provided as a string on the
+command line or passed in as a file using the file://path/to/file
+syntax.
+
+The "--generate-param-json-input" option can be used to generate an
+example of the JSON which must be provided. We recommend storing this
+example in a file, modifying it as needed and then passing it back in
+via the file:// syntax.
+
+
+Optional Parameters
+===================
+
+--availability-and-pricing-policy [text]
+
+Listing availability and Pricing Policy statement.
+
+--content-language [complex type]
+
+This is a complex type whose value must be valid JSON. The value can
+be provided as a string on the command line or passed in as a file
+using the file://path/to/file syntax.
+
+The "--generate-param-json-input" option can be used to generate an
+example of the JSON which must be provided. We recommend storing this
+example in a file, modifying it as needed and then passing it back in
+via the file:// syntax.
+
+--defined-tags [complex type]
+
+Defined tags for this resource. Each key is predefined and scoped to a
+namespace. Example: *{“foo-namespace”: {“bar-key”: “value”}}* This is
+a complex type whose value must be valid JSON. The value can be
+provided as a string on the command line or passed in as a file using
+the file://path/to/file syntax.
+
+The "--generate-param-json-input" option can be used to generate an
+example of the JSON which must be provided. We recommend storing this
+example in a file, modifying it as needed and then passing it back in
+via the file:// syntax.
+
+--display-name [text]
+
+The name for the listing revision.
+
+--freeform-tags [complex type]
+
+Simple key-value pair that is applied without any predefined name,
+type or scope. Exists for cross-compatibility only. Example: *{“bar-
+key”: “value”}* This is a complex type whose value must be valid JSON.
+The value can be provided as a string on the command line or passed in
+as a file using the file://path/to/file syntax.
+
+The "--generate-param-json-input" option can be used to generate an
+example of the JSON which must be provided. We recommend storing this
+example in a file, modifying it as needed and then passing it back in
+via the file:// syntax.
+
+--from-json [text]
+
+Provide input to this command as a JSON document from a file using the
+file://path-to/file syntax.
+
+The "--generate-full-command-json-input" option can be used to
+generate a sample json file to be used with this command option. The
+key names are pre-populated and match the command option names
+(converted to camelCase format, e.g. compartment-id –> compartmentId),
+while the values of the keys need to be populated by the user before
+using the sample file as an input to this command. For any command
+option that accepts multiple values, the value of the key can be a
+JSON array.
+
+Options can still be provided on the command line. If an option exists
+in both the JSON document and the command line then the command line
+specified value will be used.
+
+For examples on usage of this option, please see our “using CLI with
+advanced JSON options” link: https://docs.cloud.oracle.com/iaas/Conte
+nt/API/SDKDocs/cliusing.htm#AdvancedJSONOptions
+
+--is-rover-exportable [boolean]
+
+Is this listing rover exportable
+
+--keywords [text]
+
+Keywords associated with the listing revision.
+
+--long-description [text]
+
+A long description for the listing revision.
+
+--max-wait-seconds [integer]
+
+The maximum time to wait for the resource to reach the lifecycle state
+defined by "--wait-for-state". Defaults to 1200 seconds.
+
+--pricing-plans [complex type]
+
+List of Pricing Plans provider by publisher.
+
+This option is a JSON list with items of type PricingPlan.  For
+documentation on PricingPlan please see our API reference: https://do
+cs.cloud.oracle.com/api/#/en/marketplacepublisher/20241201/datatypes/
+PricingPlan. This is a complex type whose value must be valid JSON.
+The value can be provided as a string on the command line or passed in
+as a file using the file://path/to/file syntax.
+
+The "--generate-param-json-input" option can be used to generate an
+example of the JSON which must be provided. We recommend storing this
+example in a file, modifying it as needed and then passing it back in
+via the file:// syntax.
+
+--recommended-service-provider-listing-ids [complex type]
+
+OCIDs of service listings attached to lead gen listing This is a
+complex type whose value must be valid JSON. The value can be provided
+as a string on the command line or passed in as a file using the
+file://path/to/file syntax.
+
+The "--generate-param-json-input" option can be used to generate an
+example of the JSON which must be provided. We recommend storing this
+example in a file, modifying it as needed and then passing it back in
+via the file:// syntax.
+
+--short-description [text]
+
+A short description for the listing revision.
+
+--status [text]
+
+The current status of the Listing revision.
+
+--support-contacts [complex type]
+
+Contact information to use to get support from the publisher for the
+listing revision.
+
+This option is a JSON list with items of type SupportContact.  For
+documentation on SupportContact please see our API reference: https:/
+/docs.cloud.oracle.com/api/#/en/marketplacepublisher/20241201/datatyp
+es/SupportContact. This is a complex type whose value must be valid
+JSON. The value can be provided as a string on the command line or
+passed in as a file using the file://path/to/file syntax.
+
+The "--generate-param-json-input" option can be used to generate an
+example of the JSON which must be provided. We recommend storing this
+example in a file, modifying it as needed and then passing it back in
+via the file:// syntax.
+
+--support-links [complex type]
+
+Links to support resources for the listing revision.
+
+This option is a JSON list with items of type NamedLink.  For
+documentation on NamedLink please see our API reference: https://docs
+.cloud.oracle.com/api/#/en/marketplacepublisher/20241201/datatypes/Na
+medLink. This is a complex type whose value must be valid JSON. The
+value can be provided as a string on the command line or passed in as
+a file using the file://path/to/file syntax.
+
+The "--generate-param-json-input" option can be used to generate an
+example of the JSON which must be provided. We recommend storing this
+example in a file, modifying it as needed and then passing it back in
+via the file:// syntax.
+
+--supportedlanguages [complex type]
+
+Languages supported by the publisher for the listing revision.
+
+This option is a JSON list with items of type LanguageItem.  For
+documentation on LanguageItem please see our API reference: https://d
+ocs.cloud.oracle.com/api/#/en/marketplacepublisher/20241201/datatypes
+/LanguageItem. This is a complex type whose value must be valid JSON.
+The value can be provided as a string on the command line or passed in
+as a file using the file://path/to/file syntax.
+
+The "--generate-param-json-input" option can be used to generate an
+example of the JSON which must be provided. We recommend storing this
+example in a file, modifying it as needed and then passing it back in
+via the file:// syntax.
+
+--system-requirements [text]
+
+System requirements for the listing revision.
+
+--tagline [text]
+
+The tagline for the listing revision.
+
+--usage-information [text]
+
+Usage information for the listing revision.
+
+--vanity-url [text]
+
+Custom link to the listing
+
+--version-details [complex type]
+
+This is a complex type whose value must be valid JSON. The value can
+be provided as a string on the command line or passed in as a file
+using the file://path/to/file syntax.
+
+The "--generate-param-json-input" option can be used to generate an
+example of the JSON which must be provided. We recommend storing this
+example in a file, modifying it as needed and then passing it back in
+via the file:// syntax.
+
+--wait-for-state [text]
+
+This operation creates, modifies or deletes a resource that has a
+defined lifecycle state. Specify this option to perform the action and
+then wait until the resource reaches a given lifecycle state. Multiple
+states can be specified, returning on the first state. For example, "
+--wait-for-state" SUCCEEDED "--wait-for-state" FAILED would return on
+whichever lifecycle state is reached first. If timeout is reached, a
+return code of 2 is returned. For any other error, a return code of 1
+is returned.
+
+Accepted values are:
+
+   ACTIVE, CREATING, DELETED, DELETING, FAILED, UPDATING
+
+--wait-interval-seconds [integer]
+
+Check every "--wait-interval-seconds" to see whether the resource has
+reached the lifecycle state defined by "--wait-for-state". Defaults to
+30 seconds.
+
+
+Global Parameters
+=================
+
+Use "oci --help" for help on global parameters.
+
+"--auth-purpose", "--auth", "--cert-bundle", "--cli-auto-prompt", "--
+cli-rc-file", "--config-file", "--connection-timeout", "--debug", "--
+defaults-file", "--endpoint", "--generate-full-command-json-input", "
+--generate-param-json-input", "--help", "--latest-version", "--max-
+retries", "--no-retry", "--opc-client-request-id", "--opc-request-id",
+"--output", "--profile", "--proxy", "--query", "--raw-output", "--
+read-timeout", "--realm-specific-endpoint", "--region", "--release-
+info", "--request-id", "--version", "-?", "-d", "-h", "-i", "-v"
+
+
+Example using required parameter
+================================
+
+Copy and paste the following example into a JSON file, replacing the
+example parameters with your own.
+
+       oci marketplace-publisher listing-revision create-listing-revision-create-oci-listing-revision-details --generate-param-json-input products > products.json
+
+Copy the following CLI commands into a file named example.sh. Run the
+command by typing “bash example.sh” and replacing the example
+parameters with your own.
+
+Please note this sample will only work in the POSIX-compliant bash-
+like shell. You need to set up the OCI configuration and appropriate
+security policies before trying the examples.
+
+       export compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/marketplace-publisher/listing/create.html#cmdoption-compartment-id
+       export listing_type=<substitute-value-of-listing_type> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/marketplace-publisher/listing/create.html#cmdoption-listing-type
+       export name=<substitute-value-of-name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/marketplace-publisher/listing/create.html#cmdoption-name
+       export package_type=<substitute-value-of-package_type> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/marketplace-publisher/listing/create.html#cmdoption-package-type
+       export headline=<substitute-value-of-headline> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/marketplace-publisher/listing-revision/create-listing-revision-create-oci-listing-revision-details.html#cmdoption-headline
+       export pricing_type=<substitute-value-of-pricing_type> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/marketplace-publisher/listing-revision/create-listing-revision-create-oci-listing-revision-details.html#cmdoption-pricing-type
+
+       listing_id=$(oci marketplace-publisher listing create --compartment-id $compartment_id --listing-type $listing_type --name $name --package-type $package_type --query data.id --raw-output)
+
+       oci marketplace-publisher listing-revision create-listing-revision-create-oci-listing-revision-details --headline $headline --listing-id $listing_id --pricing-type $pricing_type --products file://products.json

oci_cli/help_text_producer/data_files/text/cmdref/marketplace-publisher/listing-revision/create-listing-revision-create-service-listing-revision-details.txt

@@ -0,0 +1,312 @@
+"create-listing-revision-create-service-listing-revision-details"
+*****************************************************************
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Creates a new Listing Revision.
+
+
+Usage
+=====
+
+   oci marketplace-publisher listing-revision create-listing-revision-create-service-listing-revision-details [OPTIONS]
+
+
+Required Parameters
+===================
+
+--headline [text]
+
+Single line introduction for the listing revision.
+
+--industries [complex type]
+
+List of industries subscribed by listing. This is a complex type whose
+value must be valid JSON. The value can be provided as a string on the
+command line or passed in as a file using the file://path/to/file
+syntax.
+
+The "--generate-param-json-input" option can be used to generate an
+example of the JSON which must be provided. We recommend storing this
+example in a file, modifying it as needed and then passing it back in
+via the file:// syntax.
+
+--listing-id [text]
+
+The unique identifier for the listing this revision belongs to.
+
+--product-codes [complex type]
+
+List of product codes subscribed by listing. This is a complex type
+whose value must be valid JSON. The value can be provided as a string
+on the command line or passed in as a file using the
+file://path/to/file syntax.
+
+The "--generate-param-json-input" option can be used to generate an
+example of the JSON which must be provided. We recommend storing this
+example in a file, modifying it as needed and then passing it back in
+via the file:// syntax.
+
+
+Optional Parameters
+===================
+
+--contact-us [text]
+
+Custom text by partner regarding contact information
+
+--content-language [complex type]
+
+This is a complex type whose value must be valid JSON. The value can
+be provided as a string on the command line or passed in as a file
+using the file://path/to/file syntax.
+
+The "--generate-param-json-input" option can be used to generate an
+example of the JSON which must be provided. We recommend storing this
+example in a file, modifying it as needed and then passing it back in
+via the file:// syntax.
+
+--defined-tags [complex type]
+
+Defined tags for this resource. Each key is predefined and scoped to a
+namespace. Example: *{“foo-namespace”: {“bar-key”: “value”}}* This is
+a complex type whose value must be valid JSON. The value can be
+provided as a string on the command line or passed in as a file using
+the file://path/to/file syntax.
+
+The "--generate-param-json-input" option can be used to generate an
+example of the JSON which must be provided. We recommend storing this
+example in a file, modifying it as needed and then passing it back in
+via the file:// syntax.
+
+--display-name [text]
+
+The name for the listing revision.
+
+--freeform-tags [complex type]
+
+Simple key-value pair that is applied without any predefined name,
+type or scope. Exists for cross-compatibility only. Example: *{“bar-
+key”: “value”}* This is a complex type whose value must be valid JSON.
+The value can be provided as a string on the command line or passed in
+as a file using the file://path/to/file syntax.
+
+The "--generate-param-json-input" option can be used to generate an
+example of the JSON which must be provided. We recommend storing this
+example in a file, modifying it as needed and then passing it back in
+via the file:// syntax.
+
+--from-json [text]
+
+Provide input to this command as a JSON document from a file using the
+file://path-to/file syntax.
+
+The "--generate-full-command-json-input" option can be used to
+generate a sample json file to be used with this command option. The
+key names are pre-populated and match the command option names
+(converted to camelCase format, e.g. compartment-id –> compartmentId),
+while the values of the keys need to be populated by the user before
+using the sample file as an input to this command. For any command
+option that accepts multiple values, the value of the key can be a
+JSON array.
+
+Options can still be provided on the command line. If an option exists
+in both the JSON document and the command line then the command line
+specified value will be used.
+
+For examples on usage of this option, please see our “using CLI with
+advanced JSON options” link: https://docs.cloud.oracle.com/iaas/Conte
+nt/API/SDKDocs/cliusing.htm#AdvancedJSONOptions
+
+--geo-locations [complex type]
+
+Support details based on geographic location
+
+This option is a JSON list with items of type GeoLocation.  For
+documentation on GeoLocation please see our API reference: https://do
+cs.cloud.oracle.com/api/#/en/marketplacepublisher/20241201/datatypes/
+GeoLocation. This is a complex type whose value must be valid JSON.
+The value can be provided as a string on the command line or passed in
+as a file using the file://path/to/file syntax.
+
+The "--generate-param-json-input" option can be used to generate an
+example of the JSON which must be provided. We recommend storing this
+example in a file, modifying it as needed and then passing it back in
+via the file:// syntax.
+
+--keywords [text]
+
+Keywords associated with the listing revision.
+
+--long-description [text]
+
+A long description for the listing revision.
+
+--max-wait-seconds [integer]
+
+The maximum time to wait for the resource to reach the lifecycle state
+defined by "--wait-for-state". Defaults to 1200 seconds.
+
+--short-description [text]
+
+A short description for the listing revision.
+
+--status [text]
+
+The current status of the Listing revision.
+
+--support-contacts [complex type]
+
+Contact information to use to get support from the publisher for the
+listing revision.
+
+This option is a JSON list with items of type SupportContact.  For
+documentation on SupportContact please see our API reference: https:/
+/docs.cloud.oracle.com/api/#/en/marketplacepublisher/20241201/datatyp
+es/SupportContact. This is a complex type whose value must be valid
+JSON. The value can be provided as a string on the command line or
+passed in as a file using the file://path/to/file syntax.
+
+The "--generate-param-json-input" option can be used to generate an
+example of the JSON which must be provided. We recommend storing this
+example in a file, modifying it as needed and then passing it back in
+via the file:// syntax.
+
+--support-links [complex type]
+
+Links to support resources for the listing revision.
+
+This option is a JSON list with items of type NamedLink.  For
+documentation on NamedLink please see our API reference: https://docs
+.cloud.oracle.com/api/#/en/marketplacepublisher/20241201/datatypes/Na
+medLink. This is a complex type whose value must be valid JSON. The
+value can be provided as a string on the command line or passed in as
+a file using the file://path/to/file syntax.
+
+The "--generate-param-json-input" option can be used to generate an
+example of the JSON which must be provided. We recommend storing this
+example in a file, modifying it as needed and then passing it back in
+via the file:// syntax.
+
+--supportedlanguages [complex type]
+
+Languages supported by the publisher for the listing revision.
+
+This option is a JSON list with items of type LanguageItem.  For
+documentation on LanguageItem please see our API reference: https://d
+ocs.cloud.oracle.com/api/#/en/marketplacepublisher/20241201/datatypes
+/LanguageItem. This is a complex type whose value must be valid JSON.
+The value can be provided as a string on the command line or passed in
+as a file using the file://path/to/file syntax.
+
+The "--generate-param-json-input" option can be used to generate an
+example of the JSON which must be provided. We recommend storing this
+example in a file, modifying it as needed and then passing it back in
+via the file:// syntax.
+
+--tagline [text]
+
+The tagline for the listing revision.
+
+--trained-professionals [complex type]
+
+Number of trained professional per product
+
+This option is a JSON list with items of type TrainedProfessionals.
+For documentation on TrainedProfessionals please see our API
+reference: https://docs.cloud.oracle.com/api/#/en/marketplacepublishe
+r/20241201/datatypes/TrainedProfessionals. This is a complex type
+whose value must be valid JSON. The value can be provided as a string
+on the command line or passed in as a file using the
+file://path/to/file syntax.
+
+The "--generate-param-json-input" option can be used to generate an
+example of the JSON which must be provided. We recommend storing this
+example in a file, modifying it as needed and then passing it back in
+via the file:// syntax.
+
+--usage-information [text]
+
+Usage information for the listing revision.
+
+--vanity-url [text]
+
+Custom link to the listing
+
+--wait-for-state [text]
+
+This operation creates, modifies or deletes a resource that has a
+defined lifecycle state. Specify this option to perform the action and
+then wait until the resource reaches a given lifecycle state. Multiple
+states can be specified, returning on the first state. For example, "
+--wait-for-state" SUCCEEDED "--wait-for-state" FAILED would return on
+whichever lifecycle state is reached first. If timeout is reached, a
+return code of 2 is returned. For any other error, a return code of 1
+is returned.
+
+Accepted values are:
+
+   ACTIVE, CREATING, DELETED, DELETING, FAILED, UPDATING
+
+--wait-interval-seconds [integer]
+
+Check every "--wait-interval-seconds" to see whether the resource has
+reached the lifecycle state defined by "--wait-for-state". Defaults to
+30 seconds.
+
+
+Global Parameters
+=================
+
+Use "oci --help" for help on global parameters.
+
+"--auth-purpose", "--auth", "--cert-bundle", "--cli-auto-prompt", "--
+cli-rc-file", "--config-file", "--connection-timeout", "--debug", "--
+defaults-file", "--endpoint", "--generate-full-command-json-input", "
+--generate-param-json-input", "--help", "--latest-version", "--max-
+retries", "--no-retry", "--opc-client-request-id", "--opc-request-id",
+"--output", "--profile", "--proxy", "--query", "--raw-output", "--
+read-timeout", "--realm-specific-endpoint", "--region", "--release-
+info", "--request-id", "--version", "-?", "-d", "-h", "-i", "-v"
+
+
+Example using required parameter
+================================
+
+Copy and paste the following example into a JSON file, replacing the
+example parameters with your own.
+
+       oci marketplace-publisher listing-revision create-listing-revision-create-service-listing-revision-details --generate-param-json-input industries > industries.json
+       oci marketplace-publisher listing-revision create-listing-revision-create-service-listing-revision-details --generate-param-json-input product-codes > product-codes.json
+
+Copy the following CLI commands into a file named example.sh. Run the
+command by typing “bash example.sh” and replacing the example
+parameters with your own.
+
+Please note this sample will only work in the POSIX-compliant bash-
+like shell. You need to set up the OCI configuration and appropriate
+security policies before trying the examples.
+
+       export compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/marketplace-publisher/listing/create.html#cmdoption-compartment-id
+       export listing_type=<substitute-value-of-listing_type> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/marketplace-publisher/listing/create.html#cmdoption-listing-type
+       export name=<substitute-value-of-name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/marketplace-publisher/listing/create.html#cmdoption-name
+       export package_type=<substitute-value-of-package_type> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/marketplace-publisher/listing/create.html#cmdoption-package-type
+       export headline=<substitute-value-of-headline> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/marketplace-publisher/listing-revision/create-listing-revision-create-service-listing-revision-details.html#cmdoption-headline
+
+       listing_id=$(oci marketplace-publisher listing create --compartment-id $compartment_id --listing-type $listing_type --name $name --package-type $package_type --query data.id --raw-output)
+
+       oci marketplace-publisher listing-revision create-listing-revision-create-service-listing-revision-details --headline $headline --industries file://industries.json --listing-id $listing_id --product-codes file://product-codes.json