payabli 2.2.31 → 3.0.0

data/lib/payabli/charge_backs/client.rb

@@ -22,7 +22,7 @@ module Payabli
       # @option params [Integer] :id
       # @option params [String, nil] :idempotency_key
       #
-      # @return [Payabli::ChargeBacks::Types::AddResponseResponse]
+      # @return [Payabli::Types::AddResponseResponse]
       def add_response(request_options: {}, **params)
         params = Payabli::Internal::Types::Utils.normalize_keys(params)
         request_data = Payabli::ChargeBacks::Types::ResponseChargeBack.new(params).to_h
@@ -47,7 +47,7 @@ module Payabli
         end
         code = response.code.to_i
         if code.between?(200, 299)
-          Payabli::ChargeBacks::Types::AddResponseResponse.load(response.body)
+          Payabli::Types::AddResponseResponse.load(response.body)
         else
           error_class = Payabli::Errors::ResponseError.subclass_for_code(code)
           raise error_class.new(response.body, code: code)
@@ -65,7 +65,7 @@ module Payabli
       # @option request_options [Integer] :timeout_in_seconds
       # @option params [Integer] :id
       #
-      # @return [Payabli::ChargeBacks::Types::ChargebackQueryRecords]
+      # @return [Payabli::Types::ChargebackQueryRecords]
       def get_chargeback(request_options: {}, **params)
         params = Payabli::Internal::Types::Utils.normalize_keys(params)
         request = Payabli::Internal::JSON::Request.new(
@@ -81,7 +81,7 @@ module Payabli
         end
         code = response.code.to_i
         if code.between?(200, 299)
-          Payabli::ChargeBacks::Types::ChargebackQueryRecords.load(response.body)
+          Payabli::Types::ChargebackQueryRecords.load(response.body)
         else
           error_class = Payabli::Errors::ResponseError.subclass_for_code(code)
           raise error_class.new(response.body, code: code)

data/lib/payabli/check_capture/client.rb

@@ -22,7 +22,7 @@ module Payabli
       # @option request_options [Hash{String => Object}] :additional_body_parameters
       # @option request_options [Integer] :timeout_in_seconds
       #
-      # @return [Payabli::CheckCapture::Types::CheckCaptureResponse]
+      # @return [Payabli::Types::CheckCaptureResponse]
       def check_processing(request_options: {}, **params)
         params = Payabli::Internal::Types::Utils.normalize_keys(params)
         request = Payabli::Internal::JSON::Request.new(
@@ -39,7 +39,7 @@ module Payabli
         end
         code = response.code.to_i
         if code.between?(200, 299)
-          Payabli::CheckCapture::Types::CheckCaptureResponse.load(response.body)
+          Payabli::Types::CheckCaptureResponse.load(response.body)
         else
           error_class = Payabli::Errors::ResponseError.subclass_for_code(code)
           raise error_class.new(response.body, code: code)

data/lib/payabli/client.rb

@@ -10,7 +10,7 @@ module Payabli
       @raw_client = Payabli::Internal::Http::RawClient.new(
         base_url: base_url || Payabli::Environment::SANDBOX,
         headers: {
-          "User-Agent" => "payabli/2.2.31",
+          "User-Agent" => "payabli/3.0.0",
           "X-Fern-Language" => "Ruby",
           requestToken: api_key.to_s
         }
@@ -22,14 +22,9 @@ module Payabli
       @bill ||= Payabli::Bill::Client.new(client: @raw_client)
     end
 
-    # @return [Payabli::Boarding::Client]
-    def boarding
-      @boarding ||= Payabli::Boarding::Client.new(client: @raw_client)
-    end
-
-    # @return [Payabli::ChargeBacks::Client]
-    def charge_backs
-      @charge_backs ||= Payabli::ChargeBacks::Client.new(client: @raw_client)
+    # @return [Payabli::Customer::Client]
+    def customer
+      @customer ||= Payabli::Customer::Client.new(client: @raw_client)
     end
 
     # @return [Payabli::CheckCapture::Client]
@@ -37,64 +32,59 @@ module Payabli
       @check_capture ||= Payabli::CheckCapture::Client.new(client: @raw_client)
     end
 
-    # @return [Payabli::Cloud::Client]
-    def cloud
-      @cloud ||= Payabli::Cloud::Client.new(client: @raw_client)
-    end
-
-    # @return [Payabli::Customer::Client]
-    def customer
-      @customer ||= Payabli::Customer::Client.new(client: @raw_client)
+    # @return [Payabli::MoneyIn::Client]
+    def money_in
+      @money_in ||= Payabli::MoneyIn::Client.new(client: @raw_client)
     end
 
-    # @return [Payabli::Export::Client]
-    def export
-      @export ||= Payabli::Export::Client.new(client: @raw_client)
+    # @return [Payabli::Subscription::Client]
+    def subscription
+      @subscription ||= Payabli::Subscription::Client.new(client: @raw_client)
     end
 
-    # @return [Payabli::GhostCard::Client]
-    def ghost_card
-      @ghost_card ||= Payabli::GhostCard::Client.new(client: @raw_client)
+    # @return [Payabli::Invoice::Client]
+    def invoice
+      @invoice ||= Payabli::Invoice::Client.new(client: @raw_client)
     end
 
-    # @return [Payabli::HostedPaymentPages::Client]
-    def hosted_payment_pages
-      @hosted_payment_pages ||= Payabli::HostedPaymentPages::Client.new(client: @raw_client)
+    # @return [Payabli::PaymentLink::Client]
+    def payment_link
+      @payment_link ||= Payabli::PaymentLink::Client.new(client: @raw_client)
     end
 
-    # @return [Payabli::Import::Client]
-    def import
-      @import ||= Payabli::Import::Client.new(client: @raw_client)
+    # @return [Payabli::TokenStorage::Client]
+    def token_storage
+      @token_storage ||= Payabli::TokenStorage::Client.new(client: @raw_client)
     end
 
-    # @return [Payabli::Invoice::Client]
-    def invoice
-      @invoice ||= Payabli::Invoice::Client.new(client: @raw_client)
+    # @return [Payabli::Paypoint::Client]
+    def paypoint
+      @paypoint ||= Payabli::Paypoint::Client.new(client: @raw_client)
     end
 
-    # @return [Payabli::LineItem::Client]
-    def line_item
-      @line_item ||= Payabli::LineItem::Client.new(client: @raw_client)
+    # @return [Payabli::HostedPaymentPages::Client]
+    def hosted_payment_pages
+      @hosted_payment_pages ||= Payabli::HostedPaymentPages::Client.new(client: @raw_client)
     end
 
-    # @return [Payabli::Management::Client]
-    def management
-      @management ||= Payabli::Management::Client.new(client: @raw_client)
+    # @return [Payabli::PaymentMethodDomain::Client]
+    def payment_method_domain
+      @payment_method_domain ||= Payabli::PaymentMethodDomain::Client.new(client: @raw_client)
     end
 
-    # @return [Payabli::MoneyIn::Client]
-    def money_in
-      @money_in ||= Payabli::MoneyIn::Client.new(client: @raw_client)
+    # @return [Payabli::Import::Client]
+    def import
+      @import ||= Payabli::Import::Client.new(client: @raw_client)
     end
 
-    # @return [Payabli::MoneyOut::Client]
-    def money_out
-      @money_out ||= Payabli::MoneyOut::Client.new(client: @raw_client)
+    # @return [Payabli::Query::Client]
+    def query
+      @query ||= Payabli::Query::Client.new(client: @raw_client)
     end
 
-    # @return [Payabli::Notification::Client]
-    def notification
-      @notification ||= Payabli::Notification::Client.new(client: @raw_client)
+    # @return [Payabli::Ocr::Client]
+    def ocr
+      @ocr ||= Payabli::Ocr::Client.new(client: @raw_client)
     end
 
     # @return [Payabli::Notificationlogs::Client]
@@ -102,39 +92,39 @@ module Payabli
       @notificationlogs ||= Payabli::Notificationlogs::Client.new(client: @raw_client)
     end
 
-    # @return [Payabli::Ocr::Client]
-    def ocr
-      @ocr ||= Payabli::Ocr::Client.new(client: @raw_client)
+    # @return [Payabli::Cloud::Client]
+    def cloud
+      @cloud ||= Payabli::Cloud::Client.new(client: @raw_client)
     end
 
-    # @return [Payabli::Organization::Client]
-    def organization
-      @organization ||= Payabli::Organization::Client.new(client: @raw_client)
+    # @return [Payabli::LineItem::Client]
+    def line_item
+      @line_item ||= Payabli::LineItem::Client.new(client: @raw_client)
     end
 
-    # @return [Payabli::PaymentLink::Client]
-    def payment_link
-      @payment_link ||= Payabli::PaymentLink::Client.new(client: @raw_client)
+    # @return [Payabli::Boarding::Client]
+    def boarding
+      @boarding ||= Payabli::Boarding::Client.new(client: @raw_client)
     end
 
-    # @return [Payabli::PaymentMethodDomain::Client]
-    def payment_method_domain
-      @payment_method_domain ||= Payabli::PaymentMethodDomain::Client.new(client: @raw_client)
+    # @return [Payabli::Templates::Client]
+    def templates
+      @templates ||= Payabli::Templates::Client.new(client: @raw_client)
     end
 
-    # @return [Payabli::PayoutSubscription::Client]
-    def payout_subscription
-      @payout_subscription ||= Payabli::PayoutSubscription::Client.new(client: @raw_client)
+    # @return [Payabli::Export::Client]
+    def export
+      @export ||= Payabli::Export::Client.new(client: @raw_client)
     end
 
-    # @return [Payabli::Paypoint::Client]
-    def paypoint
-      @paypoint ||= Payabli::Paypoint::Client.new(client: @raw_client)
+    # @return [Payabli::Organization::Client]
+    def organization
+      @organization ||= Payabli::Organization::Client.new(client: @raw_client)
     end
 
-    # @return [Payabli::Query::Client]
-    def query
-      @query ||= Payabli::Query::Client.new(client: @raw_client)
+    # @return [Payabli::Management::Client]
+    def management
+      @management ||= Payabli::Management::Client.new(client: @raw_client)
     end
 
     # @return [Payabli::Statistic::Client]
@@ -142,19 +132,9 @@ module Payabli
       @statistic ||= Payabli::Statistic::Client.new(client: @raw_client)
     end
 
-    # @return [Payabli::Subscription::Client]
-    def subscription
-      @subscription ||= Payabli::Subscription::Client.new(client: @raw_client)
-    end
-
-    # @return [Payabli::Templates::Client]
-    def templates
-      @templates ||= Payabli::Templates::Client.new(client: @raw_client)
-    end
-
-    # @return [Payabli::TokenStorage::Client]
-    def token_storage
-      @token_storage ||= Payabli::TokenStorage::Client.new(client: @raw_client)
+    # @return [Payabli::Notification::Client]
+    def notification
+      @notification ||= Payabli::Notification::Client.new(client: @raw_client)
     end
 
     # @return [Payabli::User::Client]
@@ -167,9 +147,29 @@ module Payabli
       @vendor ||= Payabli::Vendor::Client.new(client: @raw_client)
     end
 
+    # @return [Payabli::GhostCard::Client]
+    def ghost_card
+      @ghost_card ||= Payabli::GhostCard::Client.new(client: @raw_client)
+    end
+
+    # @return [Payabli::MoneyOut::Client]
+    def money_out
+      @money_out ||= Payabli::MoneyOut::Client.new(client: @raw_client)
+    end
+
     # @return [Payabli::Wallet::Client]
     def wallet
       @wallet ||= Payabli::Wallet::Client.new(client: @raw_client)
     end
+
+    # @return [Payabli::PayoutSubscription::Client]
+    def payout_subscription
+      @payout_subscription ||= Payabli::PayoutSubscription::Client.new(client: @raw_client)
+    end
+
+    # @return [Payabli::ChargeBacks::Client]
+    def charge_backs
+      @charge_backs ||= Payabli::ChargeBacks::Client.new(client: @raw_client)
+    end
   end
 end

data/lib/payabli/cloud/client.rb

@@ -23,7 +23,7 @@ module Payabli
       # @option params [String] :entry
       # @option params [String, nil] :idempotency_key
       #
-      # @return [Payabli::Cloud::Types::AddDeviceResponse]
+      # @return [Payabli::Types::AddDeviceResponse]
       def add_device(request_options: {}, **params)
         params = Payabli::Internal::Types::Utils.normalize_keys(params)
         request_data = Payabli::Cloud::Types::DeviceEntry.new(params).to_h
@@ -48,14 +48,14 @@ module Payabli
         end
         code = response.code.to_i
         if code.between?(200, 299)
-          Payabli::Cloud::Types::AddDeviceResponse.load(response.body)
+          Payabli::Types::AddDeviceResponse.load(response.body)
         else
           error_class = Payabli::Errors::ResponseError.subclass_for_code(code)
           raise error_class.new(response.body, code: code)
         end
       end
 
-      # Retrieve the registration history for a device.
+      # Remove a cloud device from an entrypoint.
       #
       # @param request_options [Hash]
       # @param params [Hash]
@@ -67,13 +67,13 @@ module Payabli
       # @option params [String] :entry
       # @option params [String] :device_id
       #
-      # @return [Payabli::Types::CloudQueryApiResponse]
-      def history_device(request_options: {}, **params)
+      # @return [Payabli::Types::RemoveDeviceResponse]
+      def remove_device(request_options: {}, **params)
         params = Payabli::Internal::Types::Utils.normalize_keys(params)
         request = Payabli::Internal::JSON::Request.new(
           base_url: request_options[:base_url],
-          method: "GET",
-          path: "Cloud/history/#{URI.encode_uri_component(params[:entry].to_s)}/#{URI.encode_uri_component(params[:device_id].to_s)}",
+          method: "DELETE",
+          path: "Cloud/register/#{URI.encode_uri_component(params[:entry].to_s)}/#{URI.encode_uri_component(params[:device_id].to_s)}",
           request_options: request_options
         )
         begin
@@ -83,17 +83,14 @@ module Payabli
         end
         code = response.code.to_i
         if code.between?(200, 299)
-          Payabli::Types::CloudQueryApiResponse.load(response.body)
+          Payabli::Types::RemoveDeviceResponse.load(response.body)
         else
           error_class = Payabli::Errors::ResponseError.subclass_for_code(code)
           raise error_class.new(response.body, code: code)
         end
       end
 
-      # Use [List devices by paypoint](/developers/api-reference/cloud/get-list-of-devices-for-a-paypoint) instead,
-      # which supports filters, sorting, and pagination.
-      #
-      # Get a list of cloud devices registered to an entrypoint.
+      # Retrieve the registration history for a device.
       #
       # @param request_options [Hash]
       # @param params [Hash]
@@ -103,19 +100,15 @@ module Payabli
       # @option request_options [Hash{String => Object}] :additional_body_parameters
       # @option request_options [Integer] :timeout_in_seconds
       # @option params [String] :entry
-      # @option params [Boolean, nil] :force_refresh
+      # @option params [String] :device_id
       #
       # @return [Payabli::Types::CloudQueryApiResponse]
-      def list_device(request_options: {}, **params)
+      def history_device(request_options: {}, **params)
         params = Payabli::Internal::Types::Utils.normalize_keys(params)
-        query_params = {}
-        query_params["forceRefresh"] = params[:force_refresh] if params.key?(:force_refresh)
-
         request = Payabli::Internal::JSON::Request.new(
           base_url: request_options[:base_url],
           method: "GET",
-          path: "Cloud/list/#{URI.encode_uri_component(params[:entry].to_s)}",
-          query: query_params,
+          path: "Cloud/history/#{URI.encode_uri_component(params[:entry].to_s)}/#{URI.encode_uri_component(params[:device_id].to_s)}",
           request_options: request_options
         )
         begin
@@ -132,7 +125,10 @@ module Payabli
         end
       end
 
-      # Remove a cloud device from an entrypoint.
+      # Use [List devices by paypoint](/developers/api-reference/cloud/get-list-of-devices-for-a-paypoint) instead,
+      # which supports filters, sorting, and pagination.
+      #
+      # Get a list of cloud devices registered to an entrypoint.
       #
       # @param request_options [Hash]
       # @param params [Hash]
@@ -142,15 +138,19 @@ module Payabli
       # @option request_options [Hash{String => Object}] :additional_body_parameters
       # @option request_options [Integer] :timeout_in_seconds
       # @option params [String] :entry
-      # @option params [String] :device_id
+      # @option params [Boolean, nil] :force_refresh
       #
-      # @return [Payabli::Cloud::Types::RemoveDeviceResponse]
-      def remove_device(request_options: {}, **params)
+      # @return [Payabli::Types::CloudQueryApiResponse]
+      def list_device(request_options: {}, **params)
         params = Payabli::Internal::Types::Utils.normalize_keys(params)
+        query_params = {}
+        query_params["forceRefresh"] = params[:force_refresh] if params.key?(:force_refresh)
+
         request = Payabli::Internal::JSON::Request.new(
           base_url: request_options[:base_url],
-          method: "DELETE",
-          path: "Cloud/register/#{URI.encode_uri_component(params[:entry].to_s)}/#{URI.encode_uri_component(params[:device_id].to_s)}",
+          method: "GET",
+          path: "Cloud/list/#{URI.encode_uri_component(params[:entry].to_s)}",
+          query: query_params,
           request_options: request_options
         )
         begin
@@ -160,7 +160,7 @@ module Payabli
         end
         code = response.code.to_i
         if code.between?(200, 299)
-          Payabli::Cloud::Types::RemoveDeviceResponse.load(response.body)
+          Payabli::Types::CloudQueryApiResponse.load(response.body)
         else
           error_class = Payabli::Errors::ResponseError.subclass_for_code(code)
           raise error_class.new(response.body, code: code)

data/lib/payabli/customer/client.rb

@@ -64,7 +64,7 @@ module Payabli
         end
       end
 
-      # Delete a customer record.
+      # Retrieves a customer's record and details.
       #
       # @param request_options [Hash]
       # @param params [Hash]
@@ -75,12 +75,12 @@ module Payabli
       # @option request_options [Integer] :timeout_in_seconds
       # @option params [Integer] :customer_id
       #
-      # @return [Payabli::Types::PayabliApiResponse00Responsedatanonobject]
-      def delete_customer(request_options: {}, **params)
+      # @return [Payabli::Types::CustomerQueryRecords]
+      def get_customer(request_options: {}, **params)
         params = Payabli::Internal::Types::Utils.normalize_keys(params)
         request = Payabli::Internal::JSON::Request.new(
           base_url: request_options[:base_url],
-          method: "DELETE",
+          method: "GET",
           path: "Customer/#{URI.encode_uri_component(params[:customer_id].to_s)}",
           request_options: request_options
         )
@@ -91,17 +91,17 @@ module Payabli
         end
         code = response.code.to_i
         if code.between?(200, 299)
-          Payabli::Types::PayabliApiResponse00Responsedatanonobject.load(response.body)
+          Payabli::Types::CustomerQueryRecords.load(response.body)
         else
           error_class = Payabli::Errors::ResponseError.subclass_for_code(code)
           raise error_class.new(response.body, code: code)
         end
       end
 
-      # Retrieves a customer's record and details.
+      # Update a customer record. Include only the fields you want to change.
       #
       # @param request_options [Hash]
-      # @param params [Hash]
+      # @param params [Payabli::Types::CustomerData]
       # @option request_options [String] :base_url
       # @option request_options [Hash{String => Object}] :additional_headers
       # @option request_options [Hash{String => Object}] :additional_query_parameters
@@ -109,13 +109,14 @@ module Payabli
       # @option request_options [Integer] :timeout_in_seconds
       # @option params [Integer] :customer_id
       #
-      # @return [Payabli::Types::CustomerQueryRecords]
-      def get_customer(request_options: {}, **params)
+      # @return [Payabli::Types::PayabliApiResponse00Responsedatanonobject]
+      def update_customer(request_options: {}, **params)
         params = Payabli::Internal::Types::Utils.normalize_keys(params)
         request = Payabli::Internal::JSON::Request.new(
           base_url: request_options[:base_url],
-          method: "GET",
+          method: "PUT",
           path: "Customer/#{URI.encode_uri_component(params[:customer_id].to_s)}",
+          body: Payabli::Types::CustomerData.new(params).to_h,
           request_options: request_options
         )
         begin
@@ -125,14 +126,14 @@ module Payabli
         end
         code = response.code.to_i
         if code.between?(200, 299)
-          Payabli::Types::CustomerQueryRecords.load(response.body)
+          Payabli::Types::PayabliApiResponse00Responsedatanonobject.load(response.body)
         else
           error_class = Payabli::Errors::ResponseError.subclass_for_code(code)
           raise error_class.new(response.body, code: code)
         end
       end
 
-      # Links a customer to a transaction by ID.
+      # Delete a customer record.
       #
       # @param request_options [Hash]
       # @param params [Hash]
@@ -142,15 +143,14 @@ module Payabli
       # @option request_options [Hash{String => Object}] :additional_body_parameters
       # @option request_options [Integer] :timeout_in_seconds
       # @option params [Integer] :customer_id
-      # @option params [String] :trans_id
       #
       # @return [Payabli::Types::PayabliApiResponse00Responsedatanonobject]
-      def link_customer_transaction(request_options: {}, **params)
+      def delete_customer(request_options: {}, **params)
         params = Payabli::Internal::Types::Utils.normalize_keys(params)
         request = Payabli::Internal::JSON::Request.new(
           base_url: request_options[:base_url],
-          method: "GET",
-          path: "Customer/link/#{URI.encode_uri_component(params[:customer_id].to_s)}/#{URI.encode_uri_component(params[:trans_id].to_s)}",
+          method: "DELETE",
+          path: "Customer/#{URI.encode_uri_component(params[:customer_id].to_s)}",
           request_options: request_options
         )
         begin
@@ -201,25 +201,25 @@ module Payabli
         end
       end
 
-      # Update a customer record. Include only the fields you want to change.
+      # Links a customer to a transaction by ID.
       #
       # @param request_options [Hash]
-      # @param params [Payabli::Types::CustomerData]
+      # @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 [Integer] :customer_id
+      # @option params [String] :trans_id
       #
       # @return [Payabli::Types::PayabliApiResponse00Responsedatanonobject]
-      def update_customer(request_options: {}, **params)
+      def link_customer_transaction(request_options: {}, **params)
         params = Payabli::Internal::Types::Utils.normalize_keys(params)
         request = Payabli::Internal::JSON::Request.new(
           base_url: request_options[:base_url],
-          method: "PUT",
-          path: "Customer/#{URI.encode_uri_component(params[:customer_id].to_s)}",
-          body: Payabli::Types::CustomerData.new(params).to_h,
+          method: "GET",
+          path: "Customer/link/#{URI.encode_uri_component(params[:customer_id].to_s)}/#{URI.encode_uri_component(params[:trans_id].to_s)}",
           request_options: request_options
         )
         begin