stigg 0.1.0.pre.alpha.1

data/lib/stigg/models/v1_create_event_params.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module Stigg
+  module Models
+    # @see Stigg::Resources::V1#create_event
+    class V1CreateEventParams < Stigg::Internal::Type::BaseModel
+      extend Stigg::Internal::Type::RequestParameters::Converter
+      include Stigg::Internal::Type::RequestParameters
+
+      # @!attribute events
+      #   A list of usage events to report
+      #
+      #   @return [Array<Stigg::Models::V1CreateEventParams::Event>]
+      required :events, -> { Stigg::Internal::Type::ArrayOf[Stigg::V1CreateEventParams::Event] }
+
+      # @!method initialize(events:, request_options: {})
+      #   @param events [Array<Stigg::Models::V1CreateEventParams::Event>] A list of usage events to report
+      #
+      #   @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}]
+
+      class Event < Stigg::Internal::Type::BaseModel
+        # @!attribute customer_id
+        #   Customer id
+        #
+        #   @return [String]
+        required :customer_id, String, api_name: :customerId
+
+        # @!attribute event_name
+        #   The name of the usage event
+        #
+        #   @return [String]
+        required :event_name, String, api_name: :eventName
+
+        # @!attribute idempotency_key
+        #   Idempotency key
+        #
+        #   @return [String]
+        required :idempotency_key, String, api_name: :idempotencyKey
+
+        # @!attribute dimensions
+        #   Dimensions associated with the usage event
+        #
+        #   @return [Hash{Symbol=>String, Float, Boolean}, nil]
+        optional :dimensions,
+                 -> { Stigg::Internal::Type::HashOf[union: Stigg::V1CreateEventParams::Event::Dimension] }
+
+        # @!attribute resource_id
+        #   Resource id
+        #
+        #   @return [String, nil]
+        optional :resource_id, String, api_name: :resourceId, nil?: true
+
+        # @!attribute timestamp
+        #   Timestamp
+        #
+        #   @return [Time, nil]
+        optional :timestamp, Time
+
+        # @!method initialize(customer_id:, event_name:, idempotency_key:, dimensions: nil, resource_id: nil, timestamp: nil)
+        #   @param customer_id [String] Customer id
+        #
+        #   @param event_name [String] The name of the usage event
+        #
+        #   @param idempotency_key [String] Idempotency key
+        #
+        #   @param dimensions [Hash{Symbol=>String, Float, Boolean}] Dimensions associated with the usage event
+        #
+        #   @param resource_id [String, nil] Resource id
+        #
+        #   @param timestamp [Time] Timestamp
+
+        module Dimension
+          extend Stigg::Internal::Type::Union
+
+          variant String
+
+          variant Float
+
+          variant Stigg::Internal::Type::Boolean
+
+          # @!method self.variants
+          #   @return [Array(String, Float, Boolean)]
+        end
+      end
+    end
+  end
+end

data/lib/stigg/models/v1_create_event_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Stigg
+  module Models
+    # @see Stigg::Resources::V1#create_event
+    class V1CreateEventResponse < Stigg::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Object]
+      required :data, Stigg::Internal::Type::Unknown
+
+      # @!method initialize(data:)
+      #   @param data [Object]
+    end
+  end
+end

data/lib/stigg/models/v1_create_usage_params.rb

@@ -0,0 +1,96 @@
+# 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

@@ -0,0 +1,112 @@
+# 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/models.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Stigg
+  [Stigg::Internal::Type::BaseModel, *Stigg::Internal::Type::BaseModel.subclasses].each do |cls|
+    cls.define_sorbet_constant!(:OrHash) { T.type_alias { T.any(cls, Stigg::Internal::AnyHash) } }
+  end
+
+  Stigg::Internal::Util.walk_namespaces(Stigg::Models).each do |mod|
+    case mod
+    in Stigg::Internal::Type::Enum | Stigg::Internal::Type::Union
+      mod.constants.each do |name|
+        case mod.const_get(name)
+        in true | false
+          mod.define_sorbet_constant!(:TaggedBoolean) { T.type_alias { T::Boolean } }
+          mod.define_sorbet_constant!(:OrBoolean) { T.type_alias { T::Boolean } }
+        in Integer
+          mod.define_sorbet_constant!(:TaggedInteger) { T.type_alias { Integer } }
+          mod.define_sorbet_constant!(:OrInteger) { T.type_alias { Integer } }
+        in Float
+          mod.define_sorbet_constant!(:TaggedFloat) { T.type_alias { Float } }
+          mod.define_sorbet_constant!(:OrFloat) { T.type_alias { Float } }
+        in Symbol
+          mod.define_sorbet_constant!(:TaggedSymbol) { T.type_alias { Symbol } }
+          mod.define_sorbet_constant!(:OrSymbol) { T.type_alias { T.any(Symbol, String) } }
+        else
+        end
+      end
+    else
+    end
+  end
+
+  Stigg::Internal::Util.walk_namespaces(Stigg::Models)
+                       .lazy
+                       .grep(Stigg::Internal::Type::Union)
+                       .each do |mod|
+    const = :Variants
+    next if mod.sorbet_constant_defined?(const)
+
+    mod.define_sorbet_constant!(const) { T.type_alias { mod.to_sorbet_type } }
+  end
+
+  V1 = Stigg::Models::V1
+
+  V1CreateEventParams = Stigg::Models::V1CreateEventParams
+
+  V1CreateUsageParams = Stigg::Models::V1CreateUsageParams
+end

data/lib/stigg/request_options.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Stigg
+  # Specify HTTP behaviour to use for a specific request. These options supplement
+  # or override those provided at the client level.
+  #
+  # When making a request, you can pass an actual {RequestOptions} instance, or
+  # simply pass a Hash with symbol keys matching the attributes on this class.
+  class RequestOptions < Stigg::Internal::Type::BaseModel
+    # @api private
+    #
+    # @param opts [Stigg::RequestOptions, Hash{Symbol=>Object}]
+    #
+    # @raise [ArgumentError]
+    def self.validate!(opts)
+      case opts
+      in Stigg::RequestOptions | Hash
+        opts.to_h.each_key do |k|
+          unless fields.include?(k)
+            raise ArgumentError.new("Request `opts` keys must be one of #{fields.keys}, got #{k.inspect}")
+          end
+        end
+      else
+        raise ArgumentError.new("Request `opts` must be a Hash or RequestOptions, got #{opts.inspect}")
+      end
+    end
+
+    # @!attribute idempotency_key
+    #   Idempotency key to send with request and all associated retries. Will only be
+    #   sent for write requests.
+    #
+    #   @return [String, nil]
+    optional :idempotency_key, String
+
+    # @!attribute extra_query
+    #   Extra query params to send with the request. These are `.merge`’d into any
+    #   `query` given at the client level.
+    #
+    #   @return [Hash{String=>Array<String>, String, nil}, nil]
+    optional :extra_query, Stigg::Internal::Type::HashOf[Stigg::Internal::Type::ArrayOf[String]]
+
+    # @!attribute extra_headers
+    #   Extra headers to send with the request. These are `.merged`’d into any
+    #   `extra_headers` given at the client level.
+    #
+    #   @return [Hash{String=>String, nil}, nil]
+    optional :extra_headers, Stigg::Internal::Type::HashOf[String, nil?: true]
+
+    # @!attribute extra_body
+    #   Extra data to send with the request. These are deep merged into any data
+    #   generated as part of the normal request.
+    #
+    #   @return [Object, nil]
+    optional :extra_body, Stigg::Internal::Type::HashOf[Stigg::Internal::Type::Unknown]
+
+    # @!attribute max_retries
+    #   Maximum number of retries to attempt after a failed initial request.
+    #
+    #   @return [Integer, nil]
+    optional :max_retries, Integer
+
+    # @!attribute timeout
+    #   Request timeout in seconds.
+    #
+    #   @return [Float, nil]
+    optional :timeout, Float
+
+    # @!method initialize(values = {})
+    #   Returns a new instance of RequestOptions.
+    #
+    #   @param values [Hash{Symbol=>Object}]
+
+    define_sorbet_constant!(:OrHash) do
+      T.type_alias { T.any(Stigg::RequestOptions, Stigg::Internal::AnyHash) }
+    end
+  end
+end

data/lib/stigg/resources/v1/coupons.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module Stigg
+  module Resources
+    class V1
+      class Coupons
+        # Create a new Coupon
+        #
+        # @overload create(id:, amounts_off:, description:, duration_in_months:, name:, percent_off:, additional_meta_data: nil, request_options: {})
+        #
+        # @param id [String] The unique identifier for the entity
+        #
+        # @param amounts_off [Array<Stigg::Models::V1::CouponCreateParams::AmountsOff>, nil] Fixed amount discounts in different currencies
+        #
+        # @param description [String, nil] Description of the coupon
+        #
+        # @param duration_in_months [Integer, nil] Duration of the coupon validity in months
+        #
+        # @param name [String] Name of the coupon
+        #
+        # @param percent_off [Float, nil] Percentage discount off the original price
+        #
+        # @param additional_meta_data [Object] Metadata associated with the entity
+        #
+        # @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Stigg::Models::V1::CouponCreateResponse]
+        #
+        # @see Stigg::Models::V1::CouponCreateParams
+        def create(params)
+          parsed, options = Stigg::V1::CouponCreateParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "api/v1/coupons",
+            body: parsed,
+            model: Stigg::Models::V1::CouponCreateResponse,
+            options: options
+          )
+        end
+
+        # Get a single Coupon by id
+        #
+        # @overload retrieve(id, request_options: {})
+        #
+        # @param id [String]
+        # @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Stigg::Models::V1::CouponRetrieveResponse]
+        #
+        # @see Stigg::Models::V1::CouponRetrieveParams
+        def retrieve(id, params = {})
+          @client.request(
+            method: :get,
+            path: ["api/v1/coupons/%1$s", id],
+            model: Stigg::Models::V1::CouponRetrieveResponse,
+            options: params[:request_options]
+          )
+        end
+
+        # Get a list of Coupons
+        #
+        # @overload list(ending_before: nil, limit: nil, starting_after: nil, request_options: {})
+        #
+        # @param ending_before [String] Ending before this UUID for pagination
+        #
+        # @param limit [Integer] Items per page
+        #
+        # @param starting_after [String] Starting after this UUID for pagination
+        #
+        # @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Stigg::Models::V1::CouponListResponse]
+        #
+        # @see Stigg::Models::V1::CouponListParams
+        def list(params = {})
+          parsed, options = Stigg::V1::CouponListParams.dump_request(params)
+          @client.request(
+            method: :get,
+            path: "api/v1/coupons",
+            query: parsed.transform_keys(ending_before: "endingBefore", starting_after: "startingAfter"),
+            model: Stigg::Models::V1::CouponListResponse,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Stigg::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Stigg
+  module Resources
+    class V1
+      class Customers
+        class PaymentMethod
+          # Perform payment-method attachment on a Customer
+          #
+          # @overload attach(id, integration_id:, payment_method_id:, vendor_identifier:, billing_currency: nil, request_options: {})
+          #
+          # @param id [String]
+          #
+          # @param integration_id [String] Integration details
+          #
+          # @param payment_method_id [String] Billing provider payment method id
+          #
+          # @param vendor_identifier [Symbol, Stigg::Models::V1::Customers::PaymentMethodAttachParams::VendorIdentifier] The vendor identifier of integration
+          #
+          # @param billing_currency [Symbol, Stigg::Models::V1::Customers::PaymentMethodAttachParams::BillingCurrency, nil]
+          #
+          # @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [Stigg::Models::V1::CustomerResponse]
+          #
+          # @see Stigg::Models::V1::Customers::PaymentMethodAttachParams
+          def attach(id, params)
+            parsed, options = Stigg::V1::Customers::PaymentMethodAttachParams.dump_request(params)
+            @client.request(
+              method: :post,
+              path: ["api/v1/customers/%1$s/payment-method", id],
+              body: parsed,
+              model: Stigg::V1::CustomerResponse,
+              options: options
+            )
+          end
+
+          # Perform payment-method detachment on a Customer
+          #
+          # @overload detach(id, request_options: {})
+          #
+          # @param id [String]
+          # @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [Stigg::Models::V1::CustomerResponse]
+          #
+          # @see Stigg::Models::V1::Customers::PaymentMethodDetachParams
+          def detach(id, params = {})
+            @client.request(
+              method: :delete,
+              path: ["api/v1/customers/%1$s/payment-method", id],
+              model: Stigg::V1::CustomerResponse,
+              options: params[:request_options]
+            )
+          end
+
+          # @api private
+          #
+          # @param client [Stigg::Client]
+          def initialize(client:)
+            @client = client
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Stigg
+  module Resources
+    class V1
+      class Customers
+        class Promotional
+          # Create a new Promotional Entitlements
+          #
+          # @overload create(customer_id, promotional_entitlements:, request_options: {})
+          #
+          # @param customer_id [String] The unique identifier of the entitlement customer
+          #
+          # @param promotional_entitlements [Array<Stigg::Models::V1::Customers::PromotionalCreateParams::PromotionalEntitlement>] Promotional entitlements to grant
+          #
+          # @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [Stigg::Models::V1::Customers::PromotionalCreateResponse]
+          #
+          # @see Stigg::Models::V1::Customers::PromotionalCreateParams
+          def create(customer_id, params)
+            parsed, options = Stigg::V1::Customers::PromotionalCreateParams.dump_request(params)
+            @client.request(
+              method: :post,
+              path: ["api/v1/customers/%1$s/promotional", customer_id],
+              body: parsed,
+              model: Stigg::Models::V1::Customers::PromotionalCreateResponse,
+              options: options
+            )
+          end
+
+          # Perform revocation on a Promotional Entitlement
+          #
+          # @overload revoke(feature_id, customer_id:, request_options: {})
+          #
+          # @param feature_id [String] The unique identifier of the entitlement feature
+          #
+          # @param customer_id [String] The unique identifier of the entitlement customer
+          #
+          # @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [Stigg::Models::V1::Customers::PromotionalRevokeResponse]
+          #
+          # @see Stigg::Models::V1::Customers::PromotionalRevokeParams
+          def revoke(feature_id, params)
+            parsed, options = Stigg::V1::Customers::PromotionalRevokeParams.dump_request(params)
+            customer_id =
+              parsed.delete(:customer_id) do
+                raise ArgumentError.new("missing required path argument #{_1}")
+              end
+            @client.request(
+              method: :delete,
+              path: ["api/v1/customers/%1$s/promotional/featureId/%2$s", customer_id, feature_id],
+              model: Stigg::Models::V1::Customers::PromotionalRevokeResponse,
+              options: options
+            )
+          end
+
+          # @api private
+          #
+          # @param client [Stigg::Client]
+          def initialize(client:)
+            @client = client
+          end
+        end
+      end
+    end
+  end
+end