stigg 0.1.0.pre.alpha.1 → 0.1.0.pre.alpha.3

data/lib/stigg/models/v1_create_usage_params.rb

@@ -1,96 +0,0 @@
-# frozen_string_literal: true
-
-module Stigg
-  module Models
-    # @see Stigg::Resources::V1#create_usage
-    class V1CreateUsageParams < Stigg::Internal::Type::BaseModel
-      extend Stigg::Internal::Type::RequestParameters::Converter
-      include Stigg::Internal::Type::RequestParameters
-
-      # @!attribute usages
-      #   A list of usage reports to be submitted in bulk
-      #
-      #   @return [Array<Stigg::Models::V1CreateUsageParams::Usage>]
-      required :usages, -> { Stigg::Internal::Type::ArrayOf[Stigg::V1CreateUsageParams::Usage] }
-
-      # @!method initialize(usages:, request_options: {})
-      #   @param usages [Array<Stigg::Models::V1CreateUsageParams::Usage>] A list of usage reports to be submitted in bulk
-      #
-      #   @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}]
-
-      class Usage < Stigg::Internal::Type::BaseModel
-        # @!attribute customer_id
-        #   Customer id
-        #
-        #   @return [String]
-        required :customer_id, String, api_name: :customerId
-
-        # @!attribute feature_id
-        #   Feature id
-        #
-        #   @return [String]
-        required :feature_id, String, api_name: :featureId
-
-        # @!attribute value
-        #   The value to report for usage
-        #
-        #   @return [Integer]
-        required :value, Integer
-
-        # @!attribute created_at
-        #   Timestamp of when the record was created
-        #
-        #   @return [Time, nil]
-        optional :created_at, Time, api_name: :createdAt
-
-        # @!attribute dimensions
-        #   Additional dimensions for the usage report
-        #
-        #   @return [Hash{Symbol=>String}, nil]
-        optional :dimensions, Stigg::Internal::Type::HashOf[String]
-
-        # @!attribute resource_id
-        #   Resource id
-        #
-        #   @return [String, nil]
-        optional :resource_id, String, api_name: :resourceId, nil?: true
-
-        # @!attribute update_behavior
-        #   The method by which the usage value should be updated
-        #
-        #   @return [Symbol, Stigg::Models::V1CreateUsageParams::Usage::UpdateBehavior, nil]
-        optional :update_behavior,
-                 enum: -> { Stigg::V1CreateUsageParams::Usage::UpdateBehavior },
-                 api_name: :updateBehavior
-
-        # @!method initialize(customer_id:, feature_id:, value:, created_at: nil, dimensions: nil, resource_id: nil, update_behavior: nil)
-        #   @param customer_id [String] Customer id
-        #
-        #   @param feature_id [String] Feature id
-        #
-        #   @param value [Integer] The value to report for usage
-        #
-        #   @param created_at [Time] Timestamp of when the record was created
-        #
-        #   @param dimensions [Hash{Symbol=>String}] Additional dimensions for the usage report
-        #
-        #   @param resource_id [String, nil] Resource id
-        #
-        #   @param update_behavior [Symbol, Stigg::Models::V1CreateUsageParams::Usage::UpdateBehavior] The method by which the usage value should be updated
-
-        # The method by which the usage value should be updated
-        #
-        # @see Stigg::Models::V1CreateUsageParams::Usage#update_behavior
-        module UpdateBehavior
-          extend Stigg::Internal::Type::Enum
-
-          DELTA = :DELTA
-          SET = :SET
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-      end
-    end
-  end
-end

data/lib/stigg/models/v1_create_usage_response.rb

@@ -1,112 +0,0 @@
-# frozen_string_literal: true
-
-module Stigg
-  module Models
-    # @see Stigg::Resources::V1#create_usage
-    class V1CreateUsageResponse < Stigg::Internal::Type::BaseModel
-      # @!attribute data
-      #
-      #   @return [Array<Stigg::Models::V1CreateUsageResponse::Data>]
-      required :data, -> { Stigg::Internal::Type::ArrayOf[Stigg::Models::V1CreateUsageResponse::Data] }
-
-      # @!method initialize(data:)
-      #   @param data [Array<Stigg::Models::V1CreateUsageResponse::Data>]
-
-      class Data < Stigg::Internal::Type::BaseModel
-        # @!attribute id
-        #   Unique identifier for the entity
-        #
-        #   @return [String]
-        required :id, String
-
-        # @!attribute created_at
-        #   Timestamp of when the record was created
-        #
-        #   @return [Time]
-        required :created_at, Time, api_name: :createdAt
-
-        # @!attribute customer_id
-        #   Customer id
-        #
-        #   @return [String]
-        required :customer_id, String, api_name: :customerId
-
-        # @!attribute feature_id
-        #   Feature id
-        #
-        #   @return [String]
-        required :feature_id, String, api_name: :featureId
-
-        # @!attribute timestamp
-        #   Timestamp
-        #
-        #   @return [Time]
-        required :timestamp, Time
-
-        # @!attribute value
-        #   The usage measurement record
-        #
-        #   @return [Float]
-        required :value, Float
-
-        # @!attribute current_usage
-        #   The current measured usage value
-        #
-        #   @return [Float, nil]
-        optional :current_usage, Float, api_name: :currentUsage, nil?: true
-
-        # @!attribute next_reset_date
-        #   The date when the next usage reset will occur
-        #
-        #   @return [Time, nil]
-        optional :next_reset_date, Time, api_name: :nextResetDate, nil?: true
-
-        # @!attribute resource_id
-        #   Resource id
-        #
-        #   @return [String, nil]
-        optional :resource_id, String, api_name: :resourceId, nil?: true
-
-        # @!attribute usage_period_end
-        #   The end date of the usage period in which this measurement resides (for
-        #   entitlements with a reset period)
-        #
-        #   @return [Time, nil]
-        optional :usage_period_end, Time, api_name: :usagePeriodEnd, nil?: true
-
-        # @!attribute usage_period_start
-        #   The start date of the usage period in which this measurement resides (for
-        #   entitlements with a reset period)
-        #
-        #   @return [Time, nil]
-        optional :usage_period_start, Time, api_name: :usagePeriodStart, nil?: true
-
-        # @!method initialize(id:, created_at:, customer_id:, feature_id:, timestamp:, value:, current_usage: nil, next_reset_date: nil, resource_id: nil, usage_period_end: nil, usage_period_start: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {Stigg::Models::V1CreateUsageResponse::Data} for more details.
-        #
-        #   @param id [String] Unique identifier for the entity
-        #
-        #   @param created_at [Time] Timestamp of when the record was created
-        #
-        #   @param customer_id [String] Customer id
-        #
-        #   @param feature_id [String] Feature id
-        #
-        #   @param timestamp [Time] Timestamp
-        #
-        #   @param value [Float] The usage measurement record
-        #
-        #   @param current_usage [Float, nil] The current measured usage value
-        #
-        #   @param next_reset_date [Time, nil] The date when the next usage reset will occur
-        #
-        #   @param resource_id [String, nil] Resource id
-        #
-        #   @param usage_period_end [Time, nil] The end date of the usage period in which this measurement resides (for entitlem
-        #
-        #   @param usage_period_start [Time, nil] The start date of the usage period in which this measurement resides (for entitl
-      end
-    end
-  end
-end

data/lib/stigg/resources/v1/customers/usage.rb

@@ -1,59 +0,0 @@
-# frozen_string_literal: true
-
-module Stigg
-  module Resources
-    class V1
-      class Customers
-        class Usage
-          # Perform retrieval on a Usage history
-          #
-          # @overload retrieve(feature_id, customer_id:, start_date:, end_date: nil, group_by: nil, resource_id: nil, request_options: {})
-          #
-          # @param feature_id [String] Path param: Feature id
-          #
-          # @param customer_id [String] Path param: Customer id
-          #
-          # @param start_date [Time] Query param: The start date of the range
-          #
-          # @param end_date [Time] Query param: The end date of the range
-          #
-          # @param group_by [String] Query param
-          #
-          # @param resource_id [String, nil] Query param: Resource id
-          #
-          # @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}, nil]
-          #
-          # @return [Stigg::Models::V1::Customers::UsageRetrieveResponse]
-          #
-          # @see Stigg::Models::V1::Customers::UsageRetrieveParams
-          def retrieve(feature_id, params)
-            parsed, options = Stigg::V1::Customers::UsageRetrieveParams.dump_request(params)
-            customer_id =
-              parsed.delete(:customer_id) do
-                raise ArgumentError.new("missing required path argument #{_1}")
-              end
-            @client.request(
-              method: :get,
-              path: ["api/v1/customers/%1$s/usage/features/%2$s", customer_id, feature_id],
-              query: parsed.transform_keys(
-                start_date: "startDate",
-                end_date: "endDate",
-                group_by: "groupBy",
-                resource_id: "resourceId"
-              ),
-              model: Stigg::Models::V1::Customers::UsageRetrieveResponse,
-              options: options
-            )
-          end
-
-          # @api private
-          #
-          # @param client [Stigg::Client]
-          def initialize(client:)
-            @client = client
-          end
-        end
-      end
-    end
-  end
-end