pinelabs 0.1.0

data/lib/pinelabs/subscriptions_subscriptions/client.rb

@@ -0,0 +1,321 @@
+# frozen_string_literal: true
+
+module Pinelabs
+  module SubscriptionsSubscriptions
+    class Client
+      # @param client [Pinelabs::Internal::Http::RawClient]
+      #
+      # @return [void]
+      def initialize(client:)
+        @client = client
+      end
+
+      # Retrieves all subscriptions. Supports filtering by plan_id, status,
+      # amount, date range, frequency, and pagination.
+      #
+      # @param request_options [Hash]
+      # @param params [Hash]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      # @option params [String, nil] :plan_id
+      # @option params [String, nil] :status
+      # @option params [Integer, nil] :amount
+      # @option params [Pinelabs::SubscriptionsSubscriptions::Types::ListSubscriptionsRequestAmountRange, nil] :amount_range
+      # @option params [String, nil] :start_date
+      # @option params [String, nil] :end_date
+      # @option params [Integer, nil] :size
+      # @option params [Integer, nil] :page
+      # @option params [String, nil] :sort
+      # @option params [String, nil] :frequency
+      #
+      # @return [Pinelabs::Types::ListSubscriptionsResponse]
+      def list_subscriptions(request_options: {}, **params)
+        params = Pinelabs::Internal::Types::Utils.normalize_keys(params)
+        query_param_names = %i[plan_id status amount amount_range start_date end_date size page sort frequency]
+        query_params = {}
+        query_params["plan_id"] = params[:plan_id] if params.key?(:plan_id)
+        query_params["status"] = params[:status] if params.key?(:status)
+        query_params["amount"] = params[:amount] if params.key?(:amount)
+        query_params["amount_range"] = params[:amount_range] if params.key?(:amount_range)
+        query_params["start_date"] = params[:start_date] if params.key?(:start_date)
+        query_params["end_date"] = params[:end_date] if params.key?(:end_date)
+        query_params["size"] = params[:size] if params.key?(:size)
+        query_params["page"] = params[:page] if params.key?(:page)
+        query_params["sort"] = params[:sort] if params.key?(:sort)
+        query_params["frequency"] = params[:frequency] if params.key?(:frequency)
+        params.except(*query_param_names)
+
+        request = Pinelabs::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "GET",
+          path: "ps/api/v1/public/subscriptions",
+          query: query_params,
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Pinelabs::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        if code.between?(200, 299)
+          Pinelabs::Types::ListSubscriptionsResponse.load(response.body)
+        else
+          error_class = Pinelabs::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # Creates a new subscription against an existing plan. The subscription
+      # defines the recurring billing cycle for a customer based on the
+      # selected plan's pricing and frequency.
+      #
+      # @param request_options [Hash]
+      # @param params [Pinelabs::SubscriptionsSubscriptions::Types::CreateSubscriptionRequest]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      #
+      # @return [Pinelabs::Types::CreateSubscriptionResponse]
+      def create_subscription(request_options: {}, **params)
+        params = Pinelabs::Internal::Types::Utils.normalize_keys(params)
+        request = Pinelabs::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "POST",
+          path: "ps/api/v1/public/subscriptions",
+          body: Pinelabs::SubscriptionsSubscriptions::Types::CreateSubscriptionRequest.new(params).to_h,
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Pinelabs::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        if code.between?(200, 299)
+          Pinelabs::Types::CreateSubscriptionResponse.load(response.body)
+        else
+          error_class = Pinelabs::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # Retrieves a specific subscription by its subscription ID.
+      #
+      # @param request_options [Hash]
+      # @param params [Hash]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      # @option params [String] :subscription_id
+      #
+      # @return [Pinelabs::Types::SubscriptionDetail]
+      def get_subscription_by_id(request_options: {}, **params)
+        params = Pinelabs::Internal::Types::Utils.normalize_keys(params)
+        request = Pinelabs::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "GET",
+          path: "ps/api/v1/public/subscriptions/#{URI.encode_uri_component(params[:subscription_id].to_s)}",
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Pinelabs::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        if code.between?(200, 299)
+          Pinelabs::Types::SubscriptionDetail.load(response.body)
+        else
+          error_class = Pinelabs::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # Updates an existing subscription. You can switch to a new plan
+      # or update the end date. A reason is required.
+      #
+      # @param request_options [Hash]
+      # @param params [Pinelabs::SubscriptionsSubscriptions::Types::UpdateSubscriptionRequest]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      # @option params [String] :subscription_id
+      #
+      # @return [Pinelabs::Types::SubscriptionDetail]
+      def update_subscription(request_options: {}, **params)
+        params = Pinelabs::Internal::Types::Utils.normalize_keys(params)
+        request_data = Pinelabs::SubscriptionsSubscriptions::Types::UpdateSubscriptionRequest.new(params).to_h
+        non_body_param_names = ["subscription_id"]
+        body = request_data.except(*non_body_param_names)
+
+        request = Pinelabs::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "PATCH",
+          path: "ps/api/v1/public/subscriptions/#{URI.encode_uri_component(params[:subscription_id].to_s)}",
+          body: body,
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Pinelabs::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        if code.between?(200, 299)
+          Pinelabs::Types::SubscriptionDetail.load(response.body)
+        else
+          error_class = Pinelabs::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # Retrieves a specific subscription by the merchant subscription reference.
+      #
+      # @param request_options [Hash]
+      # @param params [Hash]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      # @option params [String] :merchant_subscription_reference
+      #
+      # @return [Pinelabs::Types::SubscriptionDetail]
+      def get_subscription_by_merchant_reference(request_options: {}, **params)
+        params = Pinelabs::Internal::Types::Utils.normalize_keys(params)
+        request = Pinelabs::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "GET",
+          path: "ps/api/v1/public/subscriptions/reference/#{URI.encode_uri_component(params[:merchant_subscription_reference].to_s)}",
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Pinelabs::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        if code.between?(200, 299)
+          Pinelabs::Types::SubscriptionDetail.load(response.body)
+        else
+          error_class = Pinelabs::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # Cancels an active subscription. Once cancelled, the subscription
+      # can no longer process recurring payments.
+      #
+      # @param request_options [Hash]
+      # @param params [Hash]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      # @option params [String] :subscription_id
+      #
+      # @return [Pinelabs::Types::SubscriptionDetail]
+      def cancel_subscription(request_options: {}, **params)
+        params = Pinelabs::Internal::Types::Utils.normalize_keys(params)
+        request = Pinelabs::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "POST",
+          path: "ps/api/v1/public/subscriptions/#{URI.encode_uri_component(params[:subscription_id].to_s)}/cancel",
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Pinelabs::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        if code.between?(200, 299)
+          Pinelabs::Types::SubscriptionDetail.load(response.body)
+        else
+          error_class = Pinelabs::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # Pauses an active subscription. The subscription must be in an
+      # active, inactive, trial, or resumed state to be paused.
+      #
+      # @param request_options [Hash]
+      # @param params [Hash]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      # @option params [String] :subscription_id
+      #
+      # @return [Pinelabs::Types::SubscriptionDetail]
+      def pause_subscription(request_options: {}, **params)
+        params = Pinelabs::Internal::Types::Utils.normalize_keys(params)
+        request = Pinelabs::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "POST",
+          path: "ps/api/v1/public/subscriptions/#{URI.encode_uri_component(params[:subscription_id].to_s)}/pause",
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Pinelabs::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        if code.between?(200, 299)
+          Pinelabs::Types::SubscriptionDetail.load(response.body)
+        else
+          error_class = Pinelabs::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # Resumes a paused or halted subscription.
+      #
+      # @param request_options [Hash]
+      # @param params [Hash]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      # @option params [String] :subscription_id
+      #
+      # @return [Pinelabs::Types::SubscriptionDetail]
+      def resume_subscription(request_options: {}, **params)
+        params = Pinelabs::Internal::Types::Utils.normalize_keys(params)
+        request = Pinelabs::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "POST",
+          path: "ps/api/v1/public/subscriptions/#{URI.encode_uri_component(params[:subscription_id].to_s)}/resume",
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Pinelabs::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        if code.between?(200, 299)
+          Pinelabs::Types::SubscriptionDetail.load(response.body)
+        else
+          error_class = Pinelabs::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+    end
+  end
+end

data/lib/pinelabs/subscriptions_subscriptions/types/cancel_subscription_request.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Pinelabs
+  module SubscriptionsSubscriptions
+    module Types
+      class CancelSubscriptionRequest < Internal::Types::Model
+        field :subscription_id, -> { String }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/pinelabs/subscriptions_subscriptions/types/create_subscription_request.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Pinelabs
+  module SubscriptionsSubscriptions
+    module Types
+      class CreateSubscriptionRequest < Internal::Types::Model
+        field :merchant_subscription_reference, -> { String }, optional: false, nullable: false
+        field :plan_id, -> { String }, optional: false, nullable: false
+        field :enable_notification, -> { Internal::Types::Boolean }, optional: true, nullable: false
+        field :start_date, -> { String }, optional: false, nullable: false
+        field :end_date, -> { String }, optional: false, nullable: false
+        field :customer_id, -> { String }, optional: false, nullable: false
+        field :allowed_payment_methods, -> { Internal::Types::Array[Pinelabs::SubscriptionsSubscriptions::Types::CreateSubscriptionRequestAllowedPaymentMethodsItem] }, optional: true, nullable: false
+        field :integration_mode, -> { Pinelabs::SubscriptionsSubscriptions::Types::CreateSubscriptionRequestIntegrationMode }, optional: false, nullable: false
+        field :merchant_metadata, -> { Internal::Types::Hash[String, String] }, optional: true, nullable: false
+        field :is_tpv_enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false
+        field :bank_account, -> { Pinelabs::Types::BankAccount }, optional: true, nullable: false
+        field :callback_url, -> { String }, optional: true, nullable: false
+        field :failure_callback_url, -> { String }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/pinelabs/subscriptions_subscriptions/types/create_subscription_request_allowed_payment_methods_item.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Pinelabs
+  module SubscriptionsSubscriptions
+    module Types
+      module CreateSubscriptionRequestAllowedPaymentMethodsItem
+        extend Pinelabs::Internal::Types::Enum
+
+        CARD = "CARD"
+        UPI = "UPI"
+        POINTS = "POINTS"
+        NETBANKING = "NETBANKING"
+        WALLET = "WALLET"
+      end
+    end
+  end
+end

data/lib/pinelabs/subscriptions_subscriptions/types/create_subscription_request_integration_mode.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Pinelabs
+  module SubscriptionsSubscriptions
+    module Types
+      module CreateSubscriptionRequestIntegrationMode
+        extend Pinelabs::Internal::Types::Enum
+
+        SEAMLESS = "SEAMLESS"
+        REDIRECT = "REDIRECT"
+      end
+    end
+  end
+end

data/lib/pinelabs/subscriptions_subscriptions/types/get_subscription_by_id_request.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Pinelabs
+  module SubscriptionsSubscriptions
+    module Types
+      class GetSubscriptionByIDRequest < Internal::Types::Model
+        field :subscription_id, -> { String }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/pinelabs/subscriptions_subscriptions/types/get_subscription_by_merchant_reference_request.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Pinelabs
+  module SubscriptionsSubscriptions
+    module Types
+      class GetSubscriptionByMerchantReferenceRequest < Internal::Types::Model
+        field :merchant_subscription_reference, -> { String }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/pinelabs/subscriptions_subscriptions/types/list_subscriptions_request.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Pinelabs
+  module SubscriptionsSubscriptions
+    module Types
+      class ListSubscriptionsRequest < Internal::Types::Model
+        field :plan_id, -> { String }, optional: true, nullable: false
+        field :status, -> { String }, optional: true, nullable: false
+        field :amount, -> { Integer }, optional: true, nullable: false
+        field :amount_range, -> { Pinelabs::SubscriptionsSubscriptions::Types::ListSubscriptionsRequestAmountRange }, optional: true, nullable: false
+        field :start_date, -> { String }, optional: true, nullable: false
+        field :end_date, -> { String }, optional: true, nullable: false
+        field :size, -> { Integer }, optional: true, nullable: false
+        field :page, -> { Integer }, optional: true, nullable: false
+        field :sort, -> { String }, optional: true, nullable: false
+        field :frequency, -> { String }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/pinelabs/subscriptions_subscriptions/types/list_subscriptions_request_amount_range.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Pinelabs
+  module SubscriptionsSubscriptions
+    module Types
+      module ListSubscriptionsRequestAmountRange
+        extend Pinelabs::Internal::Types::Enum
+
+        IS_MORE = "isMore"
+        IS_LESS = "isLess"
+        IS_EQUAL = "isEqual"
+      end
+    end
+  end
+end

data/lib/pinelabs/subscriptions_subscriptions/types/pause_subscription_request.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Pinelabs
+  module SubscriptionsSubscriptions
+    module Types
+      class PauseSubscriptionRequest < Internal::Types::Model
+        field :subscription_id, -> { String }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/pinelabs/subscriptions_subscriptions/types/resume_subscription_request.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Pinelabs
+  module SubscriptionsSubscriptions
+    module Types
+      class ResumeSubscriptionRequest < Internal::Types::Model
+        field :subscription_id, -> { String }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/pinelabs/subscriptions_subscriptions/types/update_subscription_request.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Pinelabs
+  module SubscriptionsSubscriptions
+    module Types
+      class UpdateSubscriptionRequest < Internal::Types::Model
+        field :subscription_id, -> { String }, optional: false, nullable: false
+        field :new_plan_id, -> { String }, optional: true, nullable: false
+        field :new_end_date, -> { String }, optional: true, nullable: false
+        field :reason, -> { String }, optional: false, nullable: false
+      end
+    end
+  end
+end