oci 2.14.0 → 2.15.0

data/lib/oci/tenant_manager_control_plane/orders_client_composite_operations.rb

@@ -0,0 +1,76 @@
+# Copyright (c) 2016, 2021, Oracle and/or its affiliates.  All rights reserved.
+# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
+
+# rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
+module OCI
+  # This class provides a wrapper around {OCI::TenantManagerControlPlane::OrdersClient} and offers convenience methods
+  # for operations that would otherwise need to be chained together. For example, instead of performing an action
+  # on a resource (e.g. launching an instance, creating a load balancer) and then using a waiter to wait for the resource
+  # to enter a given state, you can call a single method in this class to accomplish the same functionality
+  class TenantManagerControlPlane::OrdersClientCompositeOperations
+    # The {OCI::TenantManagerControlPlane::OrdersClient} used to communicate with the service_client
+    #
+    # @return [OCI::TenantManagerControlPlane::OrdersClient]
+    attr_reader :service_client
+
+    # Initializes a new OrdersClientCompositeOperations
+    #
+    # @param [OCI::TenantManagerControlPlane::OrdersClient] service_client The client used to communicate with the service.
+    #   Defaults to a new service client created via {OCI::TenantManagerControlPlane::OrdersClient#initialize} with no arguments
+    def initialize(service_client = OCI::TenantManagerControlPlane::OrdersClient.new)
+      @service_client = service_client
+    end
+
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/ParameterLists, Metrics/PerceivedComplexity
+    # rubocop:disable Layout/EmptyLines
+
+
+    # Calls {OCI::TenantManagerControlPlane::OrdersClient#activate_order} and then waits for the {OCI::TenantManagerControlPlane::Models::WorkRequest}
+    # to enter the given state(s).
+    #
+    # @param [OCI::TenantManagerControlPlane::Models::ActivateOrderDetails] activate_order_details The information needed to activate an order in a tenancy.
+    # @param [String] activation_token Activation Token containing an order id. JWT RFC 7519 formatted string.
+    #
+    # @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::TenantManagerControlPlane::Models::WorkRequest#status}
+    # @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::TenantManagerControlPlane::OrdersClient#activate_order}
+    # @param [Hash] waiter_opts Optional arguments for the waiter. Keys should be symbols, and the following keys are supported:
+    #   * max_interval_seconds: The maximum interval between queries, in seconds.
+    #   * max_wait_seconds The maximum time to wait, in seconds
+    #
+    # @return [OCI::Response] A {OCI::Response} object containing the completed {OCI::TenantManagerControlPlane::Models::WorkRequest}
+    def activate_order_and_wait_for_state(activate_order_details, activation_token, wait_for_states = [], base_operation_opts = {}, waiter_opts = {})
+      operation_result = @service_client.activate_order(activate_order_details, activation_token, base_operation_opts)
+      use_util = OCI::TenantManagerControlPlane::Util.respond_to?(:wait_on_work_request)
+
+      return operation_result if wait_for_states.empty? && !use_util
+
+      lowered_wait_for_states = wait_for_states.map(&:downcase)
+      wait_for_resource_id = operation_result.headers['opc-work-request-id']
+
+      begin
+        if use_util
+          waiter_result = OCI::TenantManagerControlPlane::Util.wait_on_work_request(
+            @service_client,
+            wait_for_resource_id,
+            max_interval_seconds: waiter_opts.key?(:max_interval_seconds) ? waiter_opts[:max_interval_seconds] : 30,
+            max_wait_seconds: waiter_opts.key?(:max_wait_seconds) ? waiter_opts[:max_wait_seconds] : 1200
+          )
+        else
+          waiter_result = @service_client.get_work_request(wait_for_resource_id).wait_until(
+            eval_proc: ->(response) { response.data.respond_to?(:status) && lowered_wait_for_states.include?(response.data.status.downcase) },
+            max_interval_seconds: waiter_opts.key?(:max_interval_seconds) ? waiter_opts[:max_interval_seconds] : 30,
+            max_wait_seconds: waiter_opts.key?(:max_wait_seconds) ? waiter_opts[:max_wait_seconds] : 1200
+          )
+        end
+        result_to_return = waiter_result
+
+        return result_to_return
+      rescue StandardError
+        raise OCI::Errors::CompositeOperationError.new(partial_results: [operation_result])
+      end
+    end
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/ParameterLists, Metrics/PerceivedComplexity
+    # rubocop:enable Layout/EmptyLines
+  end
+end
+# rubocop:enable Lint/UnneededCopDisableDirective, Metrics/LineLength

data/lib/oci/tenant_manager_control_plane/tenant_manager_control_plane.rb

@@ -12,6 +12,7 @@ end
 
 # Require models
 require 'oci/tenant_manager_control_plane/models/action_type'
+require 'oci/tenant_manager_control_plane/models/activate_order_details'
 require 'oci/tenant_manager_control_plane/models/create_domain_details'
 require 'oci/tenant_manager_control_plane/models/create_domain_governance_details'
 require 'oci/tenant_manager_control_plane/models/create_sender_invitation_details'
@@ -27,6 +28,7 @@ require 'oci/tenant_manager_control_plane/models/link_collection'
 require 'oci/tenant_manager_control_plane/models/link_summary'
 require 'oci/tenant_manager_control_plane/models/operation_status'
 require 'oci/tenant_manager_control_plane/models/operation_type'
+require 'oci/tenant_manager_control_plane/models/order'
 require 'oci/tenant_manager_control_plane/models/recipient_invitation'
 require 'oci/tenant_manager_control_plane/models/recipient_invitation_collection'
 require 'oci/tenant_manager_control_plane/models/recipient_invitation_status'
@@ -35,7 +37,9 @@ require 'oci/tenant_manager_control_plane/models/sender_invitation'
 require 'oci/tenant_manager_control_plane/models/sender_invitation_collection'
 require 'oci/tenant_manager_control_plane/models/sender_invitation_status'
 require 'oci/tenant_manager_control_plane/models/sender_invitation_summary'
+require 'oci/tenant_manager_control_plane/models/sku'
 require 'oci/tenant_manager_control_plane/models/sort_order'
+require 'oci/tenant_manager_control_plane/models/subscription_info'
 require 'oci/tenant_manager_control_plane/models/update_domain_details'
 require 'oci/tenant_manager_control_plane/models/update_domain_governance_details'
 require 'oci/tenant_manager_control_plane/models/update_recipient_invitation_details'
@@ -56,6 +60,8 @@ require 'oci/tenant_manager_control_plane/domain_governance_client'
 require 'oci/tenant_manager_control_plane/domain_governance_client_composite_operations'
 require 'oci/tenant_manager_control_plane/link_client'
 require 'oci/tenant_manager_control_plane/link_client_composite_operations'
+require 'oci/tenant_manager_control_plane/orders_client'
+require 'oci/tenant_manager_control_plane/orders_client_composite_operations'
 require 'oci/tenant_manager_control_plane/recipient_invitation_client'
 require 'oci/tenant_manager_control_plane/recipient_invitation_client_composite_operations'
 require 'oci/tenant_manager_control_plane/sender_invitation_client'

data/lib/oci/usage_api/models/cost_analysis_ui.rb

@@ -15,11 +15,11 @@ module OCI
       GRAPH_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
     ].freeze
 
-    # the type of graph mode.
+    # The graph type.
     # @return [String]
     attr_reader :graph
 
-    # is cumulative graph.
+    # A cumulative graph.
     # @return [BOOLEAN]
     attr_accessor :is_cumulative_graph
 

data/lib/oci/usage_api/models/create_custom_table_details.rb

@@ -11,9 +11,9 @@ module OCI
     # @return [String]
     attr_accessor :compartment_id
 
-    # **[Required]** The user OCID.
+    # **[Required]** The associated saved report OCID.
     # @return [String]
-    attr_accessor :user_id
+    attr_accessor :saved_report_id
 
     # This attribute is required.
     # @return [OCI::UsageApi::Models::SavedCustomTable]
@@ -24,7 +24,7 @@ module OCI
       {
         # rubocop:disable Style/SymbolLiteral
         'compartment_id': :'compartmentId',
-        'user_id': :'userId',
+        'saved_report_id': :'savedReportId',
         'saved_custom_table': :'savedCustomTable'
         # rubocop:enable Style/SymbolLiteral
       }
@@ -35,7 +35,7 @@ module OCI
       {
         # rubocop:disable Style/SymbolLiteral
         'compartment_id': :'String',
-        'user_id': :'String',
+        'saved_report_id': :'String',
         'saved_custom_table': :'OCI::UsageApi::Models::SavedCustomTable'
         # rubocop:enable Style/SymbolLiteral
       }
@@ -48,7 +48,7 @@ module OCI
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
     # @option attributes [String] :compartment_id The value to assign to the {#compartment_id} property
-    # @option attributes [String] :user_id The value to assign to the {#user_id} property
+    # @option attributes [String] :saved_report_id The value to assign to the {#saved_report_id} property
     # @option attributes [OCI::UsageApi::Models::SavedCustomTable] :saved_custom_table The value to assign to the {#saved_custom_table} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
@@ -62,11 +62,11 @@ module OCI
 
       self.compartment_id = attributes[:'compartment_id'] if attributes[:'compartment_id']
 
-      self.user_id = attributes[:'userId'] if attributes[:'userId']
+      self.saved_report_id = attributes[:'savedReportId'] if attributes[:'savedReportId']
 
-      raise 'You cannot provide both :userId and :user_id' if attributes.key?(:'userId') && attributes.key?(:'user_id')
+      raise 'You cannot provide both :savedReportId and :saved_report_id' if attributes.key?(:'savedReportId') && attributes.key?(:'saved_report_id')
 
-      self.user_id = attributes[:'user_id'] if attributes[:'user_id']
+      self.saved_report_id = attributes[:'saved_report_id'] if attributes[:'saved_report_id']
 
       self.saved_custom_table = attributes[:'savedCustomTable'] if attributes[:'savedCustomTable']
 
@@ -87,7 +87,7 @@ module OCI
 
       self.class == other.class &&
         compartment_id == other.compartment_id &&
-        user_id == other.user_id &&
+        saved_report_id == other.saved_report_id &&
         saved_custom_table == other.saved_custom_table
     end
     # rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity, Layout/EmptyLines
@@ -104,7 +104,7 @@ module OCI
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [compartment_id, user_id, saved_custom_table].hash
+      [compartment_id, saved_report_id, saved_custom_table].hash
     end
     # rubocop:enable Metrics/AbcSize, Layout/EmptyLines
 

data/lib/oci/usage_api/models/create_query_details.rb

@@ -5,7 +5,7 @@ require 'date'
 
 # rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
 module OCI
-  # New query detail with savedRequestSummarizedUsagesDetails, savedCostAnalysisUI and displayName.
+  # New query detail with savedRequestSummarizedUsagesDetails, savedCostAnalysisUI, and displayName.
   class UsageApi::Models::CreateQueryDetails
     # **[Required]** The compartment OCID.
     # @return [String]

data/lib/oci/usage_api/models/custom_table.rb

@@ -5,17 +5,17 @@ require 'date'
 
 # rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
 module OCI
-  # saved custom table.
+  # The saved custom table.
   class UsageApi::Models::CustomTable
-    # **[Required]** The ocid of custom table.
+    # **[Required]** The custom table OCID.
     # @return [String]
     attr_accessor :id
 
-    # The user ocid of custom table.
+    # The custom table associated saved report OCID.
     # @return [String]
-    attr_accessor :user_id
+    attr_accessor :saved_report_id
 
-    # The compartment ocid of custom table.
+    # The custom table compartment OCID.
     # @return [String]
     attr_accessor :compartment_id
 
@@ -27,7 +27,7 @@ module OCI
       {
         # rubocop:disable Style/SymbolLiteral
         'id': :'id',
-        'user_id': :'userId',
+        'saved_report_id': :'savedReportId',
         'compartment_id': :'compartmentId',
         'saved_custom_table': :'savedCustomTable'
         # rubocop:enable Style/SymbolLiteral
@@ -39,7 +39,7 @@ module OCI
       {
         # rubocop:disable Style/SymbolLiteral
         'id': :'String',
-        'user_id': :'String',
+        'saved_report_id': :'String',
         'compartment_id': :'String',
         'saved_custom_table': :'OCI::UsageApi::Models::SavedCustomTable'
         # rubocop:enable Style/SymbolLiteral
@@ -53,7 +53,7 @@ module OCI
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
     # @option attributes [String] :id The value to assign to the {#id} property
-    # @option attributes [String] :user_id The value to assign to the {#user_id} property
+    # @option attributes [String] :saved_report_id The value to assign to the {#saved_report_id} property
     # @option attributes [String] :compartment_id The value to assign to the {#compartment_id} property
     # @option attributes [OCI::UsageApi::Models::SavedCustomTable] :saved_custom_table The value to assign to the {#saved_custom_table} property
     def initialize(attributes = {})
@@ -64,11 +64,11 @@ module OCI
 
       self.id = attributes[:'id'] if attributes[:'id']
 
-      self.user_id = attributes[:'userId'] if attributes[:'userId']
+      self.saved_report_id = attributes[:'savedReportId'] if attributes[:'savedReportId']
 
-      raise 'You cannot provide both :userId and :user_id' if attributes.key?(:'userId') && attributes.key?(:'user_id')
+      raise 'You cannot provide both :savedReportId and :saved_report_id' if attributes.key?(:'savedReportId') && attributes.key?(:'saved_report_id')
 
-      self.user_id = attributes[:'user_id'] if attributes[:'user_id']
+      self.saved_report_id = attributes[:'saved_report_id'] if attributes[:'saved_report_id']
 
       self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']
 
@@ -95,7 +95,7 @@ module OCI
 
       self.class == other.class &&
         id == other.id &&
-        user_id == other.user_id &&
+        saved_report_id == other.saved_report_id &&
         compartment_id == other.compartment_id &&
         saved_custom_table == other.saved_custom_table
     end
@@ -113,7 +113,7 @@ module OCI
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [id, user_id, compartment_id, saved_custom_table].hash
+      [id, saved_report_id, compartment_id, saved_custom_table].hash
     end
     # rubocop:enable Metrics/AbcSize, Layout/EmptyLines
 

data/lib/oci/usage_api/models/custom_table_summary.rb

@@ -5,7 +5,7 @@ require 'date'
 
 # rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
 module OCI
-  # Custom table in list request.
+  # Custom table in the list request.
   class UsageApi::Models::CustomTableSummary
     # **[Required]** The custom table OCID.
     # @return [String]

data/lib/oci/usage_api/models/dimension.rb

@@ -5,7 +5,7 @@ require 'date'
 
 # rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
 module OCI
-  # The dimension used for filtering. Availabe dimensions are: \"service\", \"skuName\", \"skuPartNumber\", \"unit\", \"compartmentName\", \"compartmentPath\", \"compartmentId\", \"platform\", \"region\", \"logicalAd\", \"resourceId\", \"tenantId\", \"tenantName\".
+  # The dimension used for filtering. Availabe dimensions are: \"service\", \"skuName\", \"skuPartNumber\", \"unit\", \"compartmentName\", \"compartmentPath\", \"compartmentId\", \"platform\", \"region\", \"logicalAd\", \"resourceId\", \"tenantId\", and \"tenantName\".
   # For example:
   # `[{value: \"COMPUTE\", key: \"service\"}]`
   #

data/lib/oci/usage_api/models/forecast.rb

@@ -13,15 +13,15 @@ module OCI
       FORECAST_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
     ].freeze
 
-    # BASIC uses ETS to project future usage/cost based on history data. The basis for projections will be a rolling set of equivalent historical days for which projection is being made.
+    # BASIC uses the exponential smoothing (ETS) model to project future usage/costs based on history data. The basis for projections is a periodic set of equivalent historical days for which the projection is being made.
     # @return [String]
     attr_reader :forecast_type
 
-    # forecast start time. Will default to UTC-1 if not specified
+    # The forecast start time. Defaults to UTC-1 if not specified.
     # @return [DateTime]
     attr_accessor :time_forecast_started
 
-    # **[Required]** forecast end time.
+    # **[Required]** The forecast end time.
     # @return [DateTime]
     attr_accessor :time_forecast_ended
 

data/lib/oci/usage_api/models/query_definition.rb

@@ -19,7 +19,7 @@ module OCI
     # @return [OCI::UsageApi::Models::CostAnalysisUI]
     attr_accessor :cost_analysis_ui
 
-    # **[Required]** the version of saved query.
+    # **[Required]** The saved query version.
     # @return [Float]
     attr_accessor :version
 

data/lib/oci/usage_api/models/query_summary.rb

@@ -5,7 +5,7 @@ require 'date'
 
 # rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
 module OCI
-  # Query summery in list request.
+  # Query summery in the list request.
   class UsageApi::Models::QuerySummary
     # **[Required]** The query OCID.
     # @return [String]

data/lib/oci/usage_api/models/report_query.rb

@@ -6,7 +6,7 @@ require 'logger'
 
 # rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
 module OCI
-  # the request of generated cost analysis report.
+  # The request of the generated Cost Analysis report.
   class UsageApi::Models::ReportQuery
     GRANULARITY_ENUM = [
       GRANULARITY_HOURLY = 'HOURLY'.freeze,
@@ -19,6 +19,9 @@ module OCI
     QUERY_TYPE_ENUM = [
       QUERY_TYPE_USAGE = 'USAGE'.freeze,
       QUERY_TYPE_COST = 'COST'.freeze,
+      QUERY_TYPE_CREDIT = 'CREDIT'.freeze,
+      QUERY_TYPE_EXPIREDCREDIT = 'EXPIREDCREDIT'.freeze,
+      QUERY_TYPE_ALLCREDIT = 'ALLCREDIT'.freeze,
       QUERY_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
     ].freeze
 
@@ -36,7 +39,7 @@ module OCI
       DATE_RANGE_NAME_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
     ].freeze
 
-    # **[Required]** Tenant ID
+    # **[Required]** Tenant ID.
     # @return [String]
     attr_accessor :tenant_id
 
@@ -57,16 +60,19 @@ module OCI
     # @return [String]
     attr_reader :granularity
 
-    # is aggregated by time. true isAggregateByTime will add up all usage/cost over query time period
+    # Whether aggregated by time. If isAggregateByTime is true, all usage/cost over the query time period will be added up.
     # @return [BOOLEAN]
     attr_accessor :is_aggregate_by_time
 
     # @return [OCI::UsageApi::Models::Forecast]
     attr_accessor :forecast
 
-    # The query usage type. COST by default if it is missing
+    # The query usage type. COST by default if it is missing.
     # Usage - Query the usage data.
     # Cost - Query the cost/billing data.
+    # Credit - Query the credit adjustments data.
+    # ExpiredCredit - Query the expired credits data
+    # AllCredit - Query the credit adjustments and expired credit
     #
     # @return [String]
     attr_reader :query_type
@@ -94,7 +100,7 @@ module OCI
     # @return [OCI::UsageApi::Models::Filter]
     attr_accessor :filter
 
-    # the date range for ui, eg LAST_THREE_MONTHS. It is conflict with timeUsageStarted and timeUsageEnded
+    # The UI date range, for example, LAST_THREE_MONTHS. Conflicts with timeUsageStarted and timeUsageEnded.
     # @return [String]
     attr_reader :date_range_name
 

data/lib/oci/usage_api/models/request_summarized_usages_details.rb

@@ -16,7 +16,10 @@ module OCI
 
     QUERY_TYPE_ENUM = [
       QUERY_TYPE_USAGE = 'USAGE'.freeze,
-      QUERY_TYPE_COST = 'COST'.freeze
+      QUERY_TYPE_COST = 'COST'.freeze,
+      QUERY_TYPE_CREDIT = 'CREDIT'.freeze,
+      QUERY_TYPE_EXPIREDCREDIT = 'EXPIREDCREDIT'.freeze,
+      QUERY_TYPE_ALLCREDIT = 'ALLCREDIT'.freeze
     ].freeze
 
     # **[Required]** Tenant ID.
@@ -40,16 +43,19 @@ module OCI
     # @return [String]
     attr_reader :granularity
 
-    # is aggregated by time. true isAggregateByTime will add up all usage/cost over query time period
+    # Whether aggregated by time. If isAggregateByTime is true, all usage/cost over the query time period will be added up.
     # @return [BOOLEAN]
     attr_accessor :is_aggregate_by_time
 
     # @return [OCI::UsageApi::Models::Forecast]
     attr_accessor :forecast
 
-    # The query usage type. COST by default if it is missing
+    # The query usage type. COST by default if it is missing.
     # Usage - Query the usage data.
     # Cost - Query the cost/billing data.
+    # Credit - Query the credit adjustments data.
+    # ExpiredCredit - Query the expired credits data.
+    # AllCredit - Query the credit adjustments and expired credit.
     #
     # @return [String]
     attr_reader :query_type
@@ -63,8 +69,8 @@ module OCI
     # @return [Array<String>]
     attr_accessor :group_by
 
-    # GroupBy a specific tagKey. Provide tagNamespace and tagKey in tag object. Only support one tag in the list
-    # example:
+    # GroupBy a specific tagKey. Provide the tagNamespace and tagKey in the tag object. Only supports one tag in the list.
+    # For example:
     #   `[{\"namespace\":\"oracle\", \"key\":\"createdBy\"]`
     #
     # @return [Array<OCI::UsageApi::Models::Tag>]