pinelabs 0.1.0

data/lib/pinelabs/subscriptions_presentations/client.rb

@@ -0,0 +1,308 @@
+# frozen_string_literal: true
+
+module Pinelabs
+  module SubscriptionsPresentations
+    class Client
+      # @param client [Pinelabs::Internal::Http::RawClient]
+      #
+      # @return [void]
+      def initialize(client:)
+        @client = client
+      end
+
+      # Retrieves all presentations associated with a specific subscription.
+      # Supports 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] :subscription_id
+      # @option params [String, nil] :size
+      # @option params [String, nil] :page
+      # @option params [String, nil] :sort
+      #
+      # @return [Pinelabs::Types::ListPresentationsResponse]
+      def list_presentations_by_subscription(request_options: {}, **params)
+        params = Pinelabs::Internal::Types::Utils.normalize_keys(params)
+        query_param_names = %i[size page sort]
+        query_params = {}
+        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)
+        params = 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/#{URI.encode_uri_component(params[:subscription_id].to_s)}/presentations",
+          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::ListPresentationsResponse.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 presentation (mandate debit request) against an
+      # active subscription. Presentations represent scheduled debit
+      # requests raised against a customer mandate.
+      #
+      # @param request_options [Hash]
+      # @param params [Pinelabs::SubscriptionsPresentations::Types::CreatePresentationRequest]
+      # @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::CreatePresentationResponse]
+      def create_presentation(request_options: {}, **params)
+        params = Pinelabs::Internal::Types::Utils.normalize_keys(params)
+        request_data = Pinelabs::SubscriptionsPresentations::Types::CreatePresentationRequest.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: "POST",
+          path: "ps/api/v1/public/subscriptions/#{URI.encode_uri_component(params[:subscription_id].to_s)}/presentations",
+          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::CreatePresentationResponse.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 presentation by its presentation 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] :presentation_id
+      #
+      # @return [Pinelabs::Types::PresentationDetail]
+      def get_presentation_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/presentations/#{URI.encode_uri_component(params[:presentation_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::PresentationDetail.load(response.body)
+        else
+          error_class = Pinelabs::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # Deletes a presentation by its presentation 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] :presentation_id
+      #
+      # @return [untyped]
+      def delete_presentation(request_options: {}, **params)
+        params = Pinelabs::Internal::Types::Utils.normalize_keys(params)
+        request = Pinelabs::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "DELETE",
+          path: "ps/api/v1/public/presentations/#{URI.encode_uri_component(params[:presentation_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
+        return if code.between?(200, 299)
+
+        error_class = Pinelabs::Errors::ResponseError.subclass_for_code(code)
+        raise error_class.new(response.body, code: code)
+      end
+
+      # Retrieves a specific presentation by the merchant presentation 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_presentation_reference
+      #
+      # @return [Pinelabs::Types::PresentationDetail]
+      def get_presentation_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/presentations/reference/#{URI.encode_uri_component(params[:merchant_presentation_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::PresentationDetail.load(response.body)
+        else
+          error_class = Pinelabs::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # Sends a pre-debit notification for a subscription. This is used
+      # when the merchant controls the PDN (Pre-Debit Notification) process.
+      #
+      # @param request_options [Hash]
+      # @param params [Pinelabs::SubscriptionsPresentations::Types::SubscriptionNotificationRequest]
+      # @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::SubscriptionNotificationResponse]
+      def send_subscription_notification(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/notify",
+          body: Pinelabs::SubscriptionsPresentations::Types::SubscriptionNotificationRequest.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::SubscriptionNotificationResponse.load(response.body)
+        else
+          error_class = Pinelabs::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # Executes a debit (payment collection) against a subscription.
+      # Use this when the PDN (Pre-Debit Notification) is controlled by you.
+      #
+      # @param request_options [Hash]
+      # @param params [Pinelabs::SubscriptionsPresentations::Types::CreateDebitRequest]
+      # @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::CreateDebitResponse]
+      def create_debit(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/execute",
+          body: Pinelabs::SubscriptionsPresentations::Types::CreateDebitRequest.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::CreateDebitResponse.load(response.body)
+        else
+          error_class = Pinelabs::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # Retries mandate execution for a subscription when it is in
+      # DEBIT FAILED stage. Up to 3 retry attempts are allowed.
+      # Retries can be made only if is_merchant_retry is set to true
+      # in the Create Debit API.
+      #
+      # @param request_options [Hash]
+      # @param params [Pinelabs::SubscriptionsPresentations::Types::MerchantRetryRequest]
+      # @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::CreateDebitResponse]
+      def create_merchant_retry(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/mandate/merchant-retry",
+          body: Pinelabs::SubscriptionsPresentations::Types::MerchantRetryRequest.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::CreateDebitResponse.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_presentations/types/create_debit_request.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Pinelabs
+  module SubscriptionsPresentations
+    module Types
+      class CreateDebitRequest < Internal::Types::Model
+        field :presentation_id, -> { String }, optional: true, nullable: false
+        field :merchant_presentation_reference, -> { String }, optional: true, nullable: false
+        field :is_merchant_retry, -> { String }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/pinelabs/subscriptions_presentations/types/create_presentation_request.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Pinelabs
+  module SubscriptionsPresentations
+    module Types
+      class CreatePresentationRequest < Internal::Types::Model
+        field :subscription_id, -> { String }, optional: false, nullable: false
+        field :due_date, -> { String }, optional: true, nullable: false
+        field :amount, -> { Pinelabs::Types::SubscriptionAmount }, optional: true, nullable: false
+        field :merchant_presentation_reference, -> { String }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/pinelabs/subscriptions_presentations/types/delete_presentation_request.rb

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

data/lib/pinelabs/subscriptions_presentations/types/get_presentation_by_id_request.rb

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

data/lib/pinelabs/subscriptions_presentations/types/get_presentation_by_merchant_reference_request.rb

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

data/lib/pinelabs/subscriptions_presentations/types/list_presentations_by_subscription_request.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Pinelabs
+  module SubscriptionsPresentations
+    module Types
+      class ListPresentationsBySubscriptionRequest < Internal::Types::Model
+        field :subscription_id, -> { String }, optional: false, nullable: false
+        field :size, -> { String }, optional: true, nullable: false
+        field :page, -> { String }, optional: true, nullable: false
+        field :sort, -> { String }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/pinelabs/subscriptions_presentations/types/merchant_retry_request.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Pinelabs
+  module SubscriptionsPresentations
+    module Types
+      class MerchantRetryRequest < Internal::Types::Model
+        field :presentation_id, -> { String }, optional: true, nullable: false
+        field :merchant_presentation_reference, -> { String }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/pinelabs/subscriptions_presentations/types/subscription_notification_request.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Pinelabs
+  module SubscriptionsPresentations
+    module Types
+      class SubscriptionNotificationRequest < Internal::Types::Model
+        field :subscription_id, -> { String }, optional: false, nullable: false
+        field :due_date, -> { String }, optional: false, nullable: false
+        field :amount, -> { Pinelabs::Types::SubscriptionAmount }, optional: false, nullable: false
+        field :merchant_presentation_reference, -> { String }, optional: false, nullable: false
+        field :is_merchant_retry, -> { Internal::Types::Boolean }, optional: true, nullable: false
+      end
+    end
+  end
+end