stigg 0.1.0.pre.alpha.1

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

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

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

@@ -0,0 +1,177 @@
+# frozen_string_literal: true
+
+module Stigg
+  module Resources
+    class V1
+      class Customers
+        # @return [Stigg::Resources::V1::Customers::PaymentMethod]
+        attr_reader :payment_method
+
+        # @return [Stigg::Resources::V1::Customers::Usage]
+        attr_reader :usage
+
+        # @return [Stigg::Resources::V1::Customers::Promotional]
+        attr_reader :promotional
+
+        # Create a new Customer
+        #
+        # @overload create(id:, coupon_id: nil, default_payment_method: nil, email: nil, integrations: nil, metadata: nil, name: nil, request_options: {})
+        #
+        # @param id [String] Customer slug
+        #
+        # @param coupon_id [String, nil] Customer level coupon
+        #
+        # @param default_payment_method [Stigg::Models::V1::CustomerCreateParams::DefaultPaymentMethod, nil] The default payment method details
+        #
+        # @param email [String, nil] The email of the customer
+        #
+        # @param integrations [Array<Stigg::Models::V1::CustomerCreateParams::Integration>] List of integrations
+        #
+        # @param metadata [Hash{Symbol=>String}] Additional metadata
+        #
+        # @param name [String, nil] The name of the customer
+        #
+        # @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Stigg::Models::V1::CustomerResponse]
+        #
+        # @see Stigg::Models::V1::CustomerCreateParams
+        def create(params)
+          parsed, options = Stigg::V1::CustomerCreateParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "api/v1/customers",
+            body: parsed,
+            model: Stigg::V1::CustomerResponse,
+            options: options
+          )
+        end
+
+        # Get a single Customer by id
+        #
+        # @overload retrieve(id, request_options: {})
+        #
+        # @param id [String]
+        # @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Stigg::Models::V1::CustomerResponse]
+        #
+        # @see Stigg::Models::V1::CustomerRetrieveParams
+        def retrieve(id, params = {})
+          @client.request(
+            method: :get,
+            path: ["api/v1/customers/%1$s", id],
+            model: Stigg::V1::CustomerResponse,
+            options: params[:request_options]
+          )
+        end
+
+        # Update an existing Customer
+        #
+        # @overload update(id, coupon_id: nil, email: nil, integrations: nil, metadata: nil, name: nil, request_options: {})
+        #
+        # @param id [String]
+        #
+        # @param coupon_id [String, nil] Customer level coupon
+        #
+        # @param email [String, nil] The email of the customer
+        #
+        # @param integrations [Array<Stigg::Models::V1::CustomerUpdateParams::Integration>] List of integrations
+        #
+        # @param metadata [Hash{Symbol=>String}] Additional metadata
+        #
+        # @param name [String, nil] The name of the customer
+        #
+        # @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Stigg::Models::V1::CustomerResponse]
+        #
+        # @see Stigg::Models::V1::CustomerUpdateParams
+        def update(id, params = {})
+          parsed, options = Stigg::V1::CustomerUpdateParams.dump_request(params)
+          @client.request(
+            method: :patch,
+            path: ["api/v1/customers/%1$s", id],
+            body: parsed,
+            model: Stigg::V1::CustomerResponse,
+            options: options
+          )
+        end
+
+        # Get a list of Customers
+        #
+        # @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::CustomerListResponse]
+        #
+        # @see Stigg::Models::V1::CustomerListParams
+        def list(params = {})
+          parsed, options = Stigg::V1::CustomerListParams.dump_request(params)
+          @client.request(
+            method: :get,
+            path: "api/v1/customers",
+            query: parsed.transform_keys(ending_before: "endingBefore", starting_after: "startingAfter"),
+            model: Stigg::Models::V1::CustomerListResponse,
+            options: options
+          )
+        end
+
+        # Perform archive on a Customer
+        #
+        # @overload archive(id, request_options: {})
+        #
+        # @param id [String]
+        # @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Stigg::Models::V1::CustomerResponse]
+        #
+        # @see Stigg::Models::V1::CustomerArchiveParams
+        def archive(id, params = {})
+          @client.request(
+            method: :post,
+            path: ["api/v1/customers/%1$s/archive", id],
+            model: Stigg::V1::CustomerResponse,
+            options: params[:request_options]
+          )
+        end
+
+        # Perform unarchive on a Customer
+        #
+        # @overload unarchive(id, request_options: {})
+        #
+        # @param id [String]
+        # @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Stigg::Models::V1::CustomerResponse]
+        #
+        # @see Stigg::Models::V1::CustomerUnarchiveParams
+        def unarchive(id, params = {})
+          @client.request(
+            method: :post,
+            path: ["api/v1/customers/%1$s/unarchive", id],
+            model: Stigg::V1::CustomerResponse,
+            options: params[:request_options]
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Stigg::Client]
+        def initialize(client:)
+          @client = client
+          @payment_method = Stigg::Resources::V1::Customers::PaymentMethod.new(client: client)
+          @usage = Stigg::Resources::V1::Customers::Usage.new(client: client)
+          @promotional = Stigg::Resources::V1::Customers::Promotional.new(client: client)
+        end
+      end
+    end
+  end
+end

data/lib/stigg/resources/v1/subscriptions/future_update.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Stigg
+  module Resources
+    class V1
+      class Subscriptions
+        class FutureUpdate
+          # Perform cancel future update on a Subscription
+          #
+          # @overload cancel_pending_payment(id, request_options: {})
+          #
+          # @param id [String]
+          # @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [Stigg::Models::V1::Subscriptions::FutureUpdateCancelPendingPaymentResponse]
+          #
+          # @see Stigg::Models::V1::Subscriptions::FutureUpdateCancelPendingPaymentParams
+          def cancel_pending_payment(id, params = {})
+            @client.request(
+              method: :delete,
+              path: ["api/v1/subscriptions/%1$s/future-update/pending-payment", id],
+              model: Stigg::Models::V1::Subscriptions::FutureUpdateCancelPendingPaymentResponse,
+              options: params[:request_options]
+            )
+          end
+
+          # Perform cancel future update on a Subscription
+          #
+          # @overload cancel_schedule(id, request_options: {})
+          #
+          # @param id [String]
+          # @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [Stigg::Models::V1::Subscriptions::FutureUpdateCancelScheduleResponse]
+          #
+          # @see Stigg::Models::V1::Subscriptions::FutureUpdateCancelScheduleParams
+          def cancel_schedule(id, params = {})
+            @client.request(
+              method: :delete,
+              path: ["api/v1/subscriptions/%1$s/future-update/schedule", id],
+              model: Stigg::Models::V1::Subscriptions::FutureUpdateCancelScheduleResponse,
+              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/subscriptions.rb

@@ -0,0 +1,241 @@
+# frozen_string_literal: true
+
+module Stigg
+  module Resources
+    class V1
+      class Subscriptions
+        # @return [Stigg::Resources::V1::Subscriptions::FutureUpdate]
+        attr_reader :future_update
+
+        # Create a new Subscription
+        #
+        # @overload create(customer_id:, plan_id:, id: nil, await_payment_confirmation: nil, billing_period: nil, checkout_options: nil, metadata: nil, paying_customer_id: nil, resource_id: nil, trial_override_configuration: nil, request_options: {})
+        #
+        # @param customer_id [String] Customer ID to provision the subscription for
+        #
+        # @param plan_id [String] Plan ID to provision
+        #
+        # @param id [String, nil] Unique identifier for the subscription
+        #
+        # @param await_payment_confirmation [Boolean] Whether to wait for payment confirmation before returning the subscription
+        #
+        # @param billing_period [Symbol, Stigg::Models::V1::SubscriptionCreateParams::BillingPeriod]
+        #
+        # @param checkout_options [Stigg::Models::V1::SubscriptionCreateParams::CheckoutOptions]
+        #
+        # @param metadata [Hash{Symbol=>String}] Additional metadata for the subscription
+        #
+        # @param paying_customer_id [String, nil] Optional paying customer ID for split billing scenarios
+        #
+        # @param resource_id [String, nil] Optional resource ID for multi-instance subscriptions
+        #
+        # @param trial_override_configuration [Stigg::Models::V1::SubscriptionCreateParams::TrialOverrideConfiguration]
+        #
+        # @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Stigg::Models::V1::SubscriptionCreateResponse]
+        #
+        # @see Stigg::Models::V1::SubscriptionCreateParams
+        def create(params)
+          parsed, options = Stigg::V1::SubscriptionCreateParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "api/v1/subscriptions",
+            body: parsed,
+            model: Stigg::Models::V1::SubscriptionCreateResponse,
+            options: options
+          )
+        end
+
+        # Get a single Subscription by id
+        #
+        # @overload retrieve(id, request_options: {})
+        #
+        # @param id [String]
+        # @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Stigg::Models::V1::SubscriptionRetrieveResponse]
+        #
+        # @see Stigg::Models::V1::SubscriptionRetrieveParams
+        def retrieve(id, params = {})
+          @client.request(
+            method: :get,
+            path: ["api/v1/subscriptions/%1$s", id],
+            model: Stigg::Models::V1::SubscriptionRetrieveResponse,
+            options: params[:request_options]
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {Stigg::Models::V1::SubscriptionListParams} for more details.
+        #
+        # Get a list of Subscriptions
+        #
+        # @overload list(customer_id: nil, ending_before: nil, limit: nil, starting_after: nil, status: nil, request_options: {})
+        #
+        # @param customer_id [String] Filter by customer ID
+        #
+        # @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 status [String] Filter by subscription status (comma-separated for multiple statuses, e.g., ACTI
+        #
+        # @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Stigg::Models::V1::SubscriptionListResponse]
+        #
+        # @see Stigg::Models::V1::SubscriptionListParams
+        def list(params = {})
+          parsed, options = Stigg::V1::SubscriptionListParams.dump_request(params)
+          @client.request(
+            method: :get,
+            path: "api/v1/subscriptions",
+            query: parsed.transform_keys(
+              customer_id: "customerId",
+              ending_before: "endingBefore",
+              starting_after: "startingAfter"
+            ),
+            model: Stigg::Models::V1::SubscriptionListResponse,
+            options: options
+          )
+        end
+
+        # Perform delegate on a Subscription
+        #
+        # @overload delegate(id, target_customer_id:, request_options: {})
+        #
+        # @param id [String]
+        #
+        # @param target_customer_id [String] The customer ID to delegate the subscription to
+        #
+        # @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Stigg::Models::V1::SubscriptionDelegateResponse]
+        #
+        # @see Stigg::Models::V1::SubscriptionDelegateParams
+        def delegate(id, params)
+          parsed, options = Stigg::V1::SubscriptionDelegateParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: ["api/v1/subscriptions/%1$s/delegate", id],
+            body: parsed,
+            model: Stigg::Models::V1::SubscriptionDelegateResponse,
+            options: options
+          )
+        end
+
+        # Perform migrate to latest plan version on a Subscription
+        #
+        # @overload migrate(id, subscription_migration_time: nil, request_options: {})
+        #
+        # @param id [String]
+        #
+        # @param subscription_migration_time [Symbol, Stigg::Models::V1::SubscriptionMigrateParams::SubscriptionMigrationTime] When to migrate the subscription: IMMEDIATE or END_OF_BILLING_PERIOD
+        #
+        # @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Stigg::Models::V1::SubscriptionMigrateResponse]
+        #
+        # @see Stigg::Models::V1::SubscriptionMigrateParams
+        def migrate(id, params = {})
+          parsed, options = Stigg::V1::SubscriptionMigrateParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: ["api/v1/subscriptions/%1$s/migrate", id],
+            body: parsed,
+            model: Stigg::Models::V1::SubscriptionMigrateResponse,
+            options: options
+          )
+        end
+
+        # Create a new Subscription Preview
+        #
+        # @overload preview(customer_id:, plan_id:, addons: nil, applied_coupon: nil, billable_features: nil, billing_country_code: nil, billing_information: nil, billing_period: nil, charges: nil, paying_customer_id: nil, resource_id: nil, schedule_strategy: nil, start_date: nil, trial_override_configuration: nil, unit_quantity: nil, request_options: {})
+        #
+        # @param customer_id [String] Customer ID
+        #
+        # @param plan_id [String] Plan ID
+        #
+        # @param addons [Array<Stigg::Models::V1::SubscriptionPreviewParams::Addon>]
+        #
+        # @param applied_coupon [Stigg::Models::V1::SubscriptionPreviewParams::AppliedCoupon]
+        #
+        # @param billable_features [Array<Stigg::Models::V1::SubscriptionPreviewParams::BillableFeature>]
+        #
+        # @param billing_country_code [String]
+        #
+        # @param billing_information [Stigg::Models::V1::SubscriptionPreviewParams::BillingInformation]
+        #
+        # @param billing_period [Symbol, Stigg::Models::V1::SubscriptionPreviewParams::BillingPeriod]
+        #
+        # @param charges [Array<Stigg::Models::V1::SubscriptionPreviewParams::Charge>]
+        #
+        # @param paying_customer_id [String]
+        #
+        # @param resource_id [String]
+        #
+        # @param schedule_strategy [Symbol, Stigg::Models::V1::SubscriptionPreviewParams::ScheduleStrategy]
+        #
+        # @param start_date [Time] Subscription start date
+        #
+        # @param trial_override_configuration [Stigg::Models::V1::SubscriptionPreviewParams::TrialOverrideConfiguration]
+        #
+        # @param unit_quantity [Float]
+        #
+        # @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Stigg::Models::V1::SubscriptionPreviewResponse]
+        #
+        # @see Stigg::Models::V1::SubscriptionPreviewParams
+        def preview(params)
+          parsed, options = Stigg::V1::SubscriptionPreviewParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "api/v1/subscriptions/preview",
+            body: parsed,
+            model: Stigg::Models::V1::SubscriptionPreviewResponse,
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {Stigg::Models::V1::SubscriptionTransferParams} for more details.
+        #
+        # Perform transfer to resource on a Subscription
+        #
+        # @overload transfer(id, destination_resource_id:, request_options: {})
+        #
+        # @param id [String]
+        #
+        # @param destination_resource_id [String] The resource ID to transfer the subscription to. The destination resource must b
+        #
+        # @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Stigg::Models::V1::SubscriptionTransferResponse]
+        #
+        # @see Stigg::Models::V1::SubscriptionTransferParams
+        def transfer(id, params)
+          parsed, options = Stigg::V1::SubscriptionTransferParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: ["api/v1/subscriptions/%1$s/transfer", id],
+            body: parsed,
+            model: Stigg::Models::V1::SubscriptionTransferResponse,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Stigg::Client]
+        def initialize(client:)
+          @client = client
+          @future_update = Stigg::Resources::V1::Subscriptions::FutureUpdate.new(client: client)
+        end
+      end
+    end
+  end
+end

data/lib/stigg/resources/v1.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module Stigg
+  module Resources
+    class V1
+      # @return [Stigg::Resources::V1::Customers]
+      attr_reader :customers
+
+      # @return [Stigg::Resources::V1::Subscriptions]
+      attr_reader :subscriptions
+
+      # @return [Stigg::Resources::V1::Coupons]
+      attr_reader :coupons
+
+      # Create events
+      #
+      # @overload create_event(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}, nil]
+      #
+      # @return [Stigg::Models::V1CreateEventResponse]
+      #
+      # @see Stigg::Models::V1CreateEventParams
+      def create_event(params)
+        parsed, options = Stigg::V1CreateEventParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "api/v1/events",
+          body: parsed,
+          model: Stigg::Models::V1CreateEventResponse,
+          options: options
+        )
+      end
+
+      # Create a new Usage
+      #
+      # @overload create_usage(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}, nil]
+      #
+      # @return [Stigg::Models::V1CreateUsageResponse]
+      #
+      # @see Stigg::Models::V1CreateUsageParams
+      def create_usage(params)
+        parsed, options = Stigg::V1CreateUsageParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "api/v1/usage",
+          body: parsed,
+          model: Stigg::Models::V1CreateUsageResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Stigg::Client]
+      def initialize(client:)
+        @client = client
+        @customers = Stigg::Resources::V1::Customers.new(client: client)
+        @subscriptions = Stigg::Resources::V1::Subscriptions.new(client: client)
+        @coupons = Stigg::Resources::V1::Coupons.new(client: client)
+      end
+    end
+  end
+end

data/lib/stigg/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Stigg
+  VERSION = "0.1.0.pre.alpha.1"
+end