payabli 2.2.27 → 2.2.29

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b6fe4c1eb951b5b2834d95fcc20169f67b6e09934c0c6215a0cd8c56aa71f50d
-  data.tar.gz: 7d3dd43cda3b300e3f00cbb5ed69c4ea33a54e500abdf375cb899d3489321d98
+  metadata.gz: 597c0c64b2d2c80e4fb75ee36a2e75c7d67a387a94b91c23403e56fff8da88a9
+  data.tar.gz: fe1d3e00f0d431362010dd3ac138e9fe5483be307c1050a3dedc2ed1ad437ff1
 SHA512:
-  metadata.gz: 7c1549d6b5cbdcf262f6dd78fea18d6ed1e3eb287212922e564fb66ab0a9ae6d383e3cc287be5246e0f4605e8a81e722388ba5c9ca55a32627360f6e911d1e52
-  data.tar.gz: e8dbbaa0c6be087ff8de29f392199416b5d8972289eb0209aed5ef25001f05f7225c4cc545de65a87fe05ebd230c85264999a99ea9b35706f74d9ce737166ba1
+  metadata.gz: 7f556e15ea09959467c2375664704debd6282fcb7fc0edbb7428ddc2a0608dcf205c99807226e306104208f7f89fcaff99f637038240fbae9c2b5d89e6fcc1e7
+  data.tar.gz: 4788c0decb8b1feacdd3be3138fa42d1da7448d9dcf36077672ac776ecd39a4e808b02c28c3d30027eb4f27b39b7e1751897c8c48ddb9cfcf8e2f722082b6400

data/.fern/metadata.json

@@ -6,6 +6,6 @@
     "enableWireTests": true,
     "rubocopVariableNumberStyle": "snake_case"
   },
-  "originGitCommit": "72fdff3484316d01ba20c78f02c52cde8b292f54",
-  "sdkVersion": "2.2.27"
+  "originGitCommit": "d69946f7f37797d4fdc34de0c29dc377dbc94fc5",
+  "sdkVersion": "2.2.29"
 }

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.27",
+          "User-Agent" => "payabli/2.2.29",
           "X-Fern-Language" => "Ruby",
           requestToken: api_key.to_s
         }

data/lib/payabli/query/client.rb

@@ -1964,6 +1964,100 @@ module Payabli
         end
       end
 
+      # Retrieve a list of virtual card transactions for an entrypoint. Use filters to limit results.
+      #
+      # @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 [Payabli::Types::Entry] :entry
+      # @option params [Integer, nil] :from_record
+      # @option params [Integer, nil] :limit_record
+      # @option params [Hash[String, String, nil], nil] :parameters
+      # @option params [String, nil] :sort_by
+      #
+      # @return [Payabli::QueryTypes::Types::VCardTransactionQueryResponse]
+      def list_vcards_transactions(request_options: {}, **params)
+        params = Payabli::Internal::Types::Utils.normalize_keys(params)
+        query_param_names = %i[from_record limit_record parameters sort_by]
+        query_params = {}
+        query_params["fromRecord"] = params[:from_record] if params.key?(:from_record)
+        query_params["limitRecord"] = params[:limit_record] if params.key?(:limit_record)
+        query_params["parameters"] = params[:parameters] if params.key?(:parameters)
+        query_params["sortBy"] = params[:sort_by] if params.key?(:sort_by)
+        params = params.except(*query_param_names)
+
+        request = Payabli::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "GET",
+          path: "Query/vcardsTransactions/#{URI.encode_uri_component(params[:entry].to_s)}",
+          query: query_params,
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Payabli::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        if code.between?(200, 299)
+          Payabli::QueryTypes::Types::VCardTransactionQueryResponse.load(response.body)
+        else
+          error_class = Payabli::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # Retrieve a list of virtual card transactions for an organization. Use filters to limit results.
+      #
+      # @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 [Integer] :org_id
+      # @option params [Integer, nil] :from_record
+      # @option params [Integer, nil] :limit_record
+      # @option params [Hash[String, String, nil], nil] :parameters
+      # @option params [String, nil] :sort_by
+      #
+      # @return [Payabli::QueryTypes::Types::VCardTransactionQueryResponse]
+      def list_vcards_transactions_org(request_options: {}, **params)
+        params = Payabli::Internal::Types::Utils.normalize_keys(params)
+        query_param_names = %i[from_record limit_record parameters sort_by]
+        query_params = {}
+        query_params["fromRecord"] = params[:from_record] if params.key?(:from_record)
+        query_params["limitRecord"] = params[:limit_record] if params.key?(:limit_record)
+        query_params["parameters"] = params[:parameters] if params.key?(:parameters)
+        query_params["sortBy"] = params[:sort_by] if params.key?(:sort_by)
+        params = params.except(*query_param_names)
+
+        request = Payabli::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "GET",
+          path: "Query/vcardsTransactions/org/#{URI.encode_uri_component(params[:org_id].to_s)}",
+          query: query_params,
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Payabli::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        if code.between?(200, 299)
+          Payabli::QueryTypes::Types::VCardTransactionQueryResponse.load(response.body)
+        else
+          error_class = Payabli::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
       # Retrieve a list of vcards (virtual credit cards) issued for an organization. Use filters to limit results.
       # Include the `exportFormat` query parameter to return the results as a file instead of a JSON response.
       #

data/lib/payabli/query/types/list_vcards_transactions_org_request.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Query
+    module Types
+      class ListVcardsTransactionsOrgRequest < Internal::Types::Model
+        field :org_id, -> { Integer }, optional: false, nullable: false, api_name: "orgId"
+        field :from_record, -> { Integer }, optional: true, nullable: false, api_name: "fromRecord"
+        field :limit_record, -> { Integer }, optional: true, nullable: false, api_name: "limitRecord"
+        field :parameters, -> { Internal::Types::Hash[String, String] }, optional: true, nullable: false
+        field :sort_by, -> { String }, optional: true, nullable: false, api_name: "sortBy"
+      end
+    end
+  end
+end

data/lib/payabli/query/types/list_vcards_transactions_request.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Query
+    module Types
+      class ListVcardsTransactionsRequest < Internal::Types::Model
+        field :entry, -> { String }, optional: false, nullable: false
+        field :from_record, -> { Integer }, optional: true, nullable: false, api_name: "fromRecord"
+        field :limit_record, -> { Integer }, optional: true, nullable: false, api_name: "limitRecord"
+        field :parameters, -> { Internal::Types::Hash[String, String] }, optional: true, nullable: false
+        field :sort_by, -> { String }, optional: true, nullable: false, api_name: "sortBy"
+      end
+    end
+  end
+end

data/lib/payabli/query_types/types/query_transfer_summary.rb

@@ -18,6 +18,7 @@ module Payabli
         field :transfer_amount, -> { Integer }, optional: false, nullable: true, api_name: "transferAmount"
         field :refunds, -> { Integer }, optional: false, nullable: true
         field :held_amount, -> { Integer }, optional: false, nullable: true, api_name: "heldAmount"
+        field :card_rejected_amount, -> { Integer }, optional: false, nullable: true, api_name: "cardRejectedAmount"
         field :total_records, -> { Integer }, optional: false, nullable: true, api_name: "totalRecords"
         field :total_amount, -> { Integer }, optional: false, nullable: true, api_name: "totalAmount"
         field :total_net_amount, -> { Integer }, optional: false, nullable: true, api_name: "totalNetAmount"

data/lib/payabli/query_types/types/transfer_detail_record.rb

@@ -21,6 +21,7 @@ module Payabli
         field :adjustments_amount, -> { Integer }, optional: false, nullable: true, api_name: "adjustmentsAmount"
         field :net_transfer_amount, -> { Integer }, optional: false, nullable: true, api_name: "netTransferAmount"
         field :split_funding_amount, -> { Integer }, optional: false, nullable: true, api_name: "splitFundingAmount"
+        field :card_rejected_amount, -> { Integer }, optional: false, nullable: true, api_name: "cardRejectedAmount"
         field :billing_fees_details, -> { Internal::Types::Array[Payabli::Types::BillingFeeDetail] }, optional: false, nullable: true, api_name: "billingFeesDetails"
         field :parent_org_name, -> { String }, optional: false, nullable: true, api_name: "ParentOrgName"
         field :paypoint_dbaname, -> { String }, optional: false, nullable: true, api_name: "PaypointDbaname"

data/lib/payabli/query_types/types/v_card_transaction_query_response.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Payabli
+  module QueryTypes
+    module Types
+      # Response body for queries about virtual card transactions.
+      class VCardTransactionQueryResponse < Internal::Types::Model
+        field :summary, -> { Payabli::Types::VCardSummary }, optional: false, nullable: false, api_name: "Summary"
+        field :records, -> { Internal::Types::Array[Payabli::QueryTypes::Types::VCardTransactionRecord] }, optional: false, nullable: false, api_name: "Records"
+      end
+    end
+  end
+end

data/lib/payabli/query_types/types/v_card_transaction_record.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Payabli
+  module QueryTypes
+    module Types
+      # A virtual card transaction record returned by the query.
+      class VCardTransactionRecord < Internal::Types::Model
+        field :identifier, -> { String }, optional: false, nullable: true, api_name: "Identifier"
+        field :card_token, -> { String }, optional: false, nullable: true, api_name: "CardToken"
+        field :last_four, -> { String }, optional: false, nullable: true, api_name: "LastFour"
+        field :expiration_date, -> { String }, optional: false, nullable: true, api_name: "ExpirationDate"
+        field :mcc, -> { String }, optional: false, nullable: true, api_name: "Mcc"
+        field :payout_id, -> { Integer }, optional: false, nullable: true, api_name: "PayoutId"
+        field :customer_id, -> { Integer }, optional: false, nullable: true, api_name: "CustomerId"
+        field :vendor_id, -> { Integer }, optional: false, nullable: true, api_name: "VendorId"
+        field :misc_data_1, -> { String }, optional: false, nullable: true, api_name: "MiscData1"
+        field :misc_data_2, -> { String }, optional: false, nullable: true, api_name: "MiscData2"
+        field :current_uses, -> { Integer }, optional: false, nullable: true, api_name: "CurrentUses"
+        field :amount, -> { Integer }, optional: false, nullable: true, api_name: "Amount"
+        field :balance, -> { Integer }, optional: false, nullable: true, api_name: "Balance"
+        field :paypoint_id, -> { Integer }, optional: false, nullable: true, api_name: "PaypointId"
+        field :paypoint_legal, -> { String }, optional: false, nullable: true, api_name: "PaypointLegal"
+        field :paypoint_dba, -> { String }, optional: false, nullable: true, api_name: "PaypointDba"
+        field :external_paypoint_id, -> { String }, optional: false, nullable: true, api_name: "ExternalPaypointID"
+        field :org_name, -> { String }, optional: false, nullable: true, api_name: "OrgName"
+        field :type, -> { String }, optional: false, nullable: true, api_name: "Type"
+        field :status, -> { String }, optional: false, nullable: true, api_name: "Status"
+        field :created_on, -> { String }, optional: false, nullable: true, api_name: "CreatedOn"
+        field :transaction_amount, -> { String }, optional: false, nullable: true, api_name: "TransactionAmount"
+        field :posted_amount, -> { String }, optional: false, nullable: true, api_name: "PostedAmount"
+        field :posted_on, -> { String }, optional: false, nullable: true, api_name: "PostedOn"
+        field :merchant_name, -> { String }, optional: false, nullable: true, api_name: "MerchantName"
+        field :authorization_status, -> { String }, optional: false, nullable: true, api_name: "AuthorizationStatus"
+        field :reason_to_decline, -> { String }, optional: false, nullable: true, api_name: "ReasonToDecline"
+      end
+    end
+  end
+end

data/lib/payabli/types/split_count.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    module SplitCount
+      # SplitCount is an alias for Integer
+
+      # @option str [String]
+      #
+      # @return [untyped]
+      def self.load(str)
+        ::JSON.parse(str)
+      end
+
+      # @option value [untyped]
+      #
+      # @return [String]
+      def self.dump(value)
+        ::JSON.generate(value)
+      end
+    end
+  end
+end

data/lib/payabli/types/subscription_query_records.rb

@@ -27,6 +27,7 @@ module Payabli
       field :plan_id, -> { Integer }, optional: true, nullable: false, api_name: "PlanId"
       field :source, -> { String }, optional: true, nullable: false, api_name: "Source"
       field :start_date, -> { String }, optional: false, nullable: true, api_name: "StartDate"
+      field :stored_method, -> { Payabli::Types::VendorResponseStoredMethod }, optional: false, nullable: true, api_name: "StoredMethod"
       field :sub_events, -> { Internal::Types::Array[Payabli::Types::GeneralEvents] }, optional: true, nullable: false, api_name: "SubEvents"
       field :sub_status, -> { Integer }, optional: true, nullable: false, api_name: "SubStatus"
       field :total_amount, -> { Integer }, optional: true, nullable: false, api_name: "TotalAmount"

data/lib/payabli/types/transaction_query_records.rb

@@ -37,6 +37,7 @@ module Payabli
       field :settlement_status, -> { Integer }, optional: true, nullable: false, api_name: "SettlementStatus"
       field :source, -> { String }, optional: true, nullable: false, api_name: "Source"
       field :split_funding_instructions, -> { Internal::Types::Array[Payabli::Types::SplitFundingContent] }, optional: true, nullable: false, api_name: "splitFundingInstructions"
+      field :split_count, -> { Integer }, optional: false, nullable: false, api_name: "splitCount"
       field :total_amount, -> { Integer }, optional: true, nullable: false, api_name: "TotalAmount"
       field :transaction_events, -> { Internal::Types::Array[Payabli::Types::QueryTransactionEvents] }, optional: true, nullable: false, api_name: "TransactionEvents"
       field :transaction_time, -> { String }, optional: false, nullable: true, api_name: "TransactionTime"

data/lib/payabli/types/transaction_query_records_customer.rb

@@ -37,6 +37,7 @@ module Payabli
       field :settlement_status, -> { Integer }, optional: true, nullable: false, api_name: "SettlementStatus"
       field :source, -> { String }, optional: true, nullable: false, api_name: "Source"
       field :split_funding_instructions, -> { Internal::Types::Array[Payabli::Types::SplitFundingContent] }, optional: true, nullable: false, api_name: "splitFundingInstructions"
+      field :split_count, -> { Integer }, optional: false, nullable: false, api_name: "splitCount"
       field :total_amount, -> { Integer }, optional: true, nullable: false, api_name: "TotalAmount"
       field :transaction_events, -> { Internal::Types::Array[Payabli::Types::QueryTransactionEvents] }, optional: true, nullable: false, api_name: "TransactionEvents"
       field :transaction_time, -> { String }, optional: false, nullable: true, api_name: "TransactionTime"

data/lib/payabli/types/v_card_summary.rb

@@ -6,10 +6,11 @@ module Payabli
       field :total_pages, -> { Integer }, optional: false, nullable: false, api_name: "totalPages"
       field :total_records, -> { Integer }, optional: false, nullable: false, api_name: "totalRecords"
       field :total_amount, -> { Integer }, optional: false, nullable: false, api_name: "totalAmount"
+      field :total_net_amount, -> { Integer }, optional: true, nullable: false, api_name: "totalNetAmount"
       field :totalactive, -> { Integer }, optional: false, nullable: false
-      field :totalamounteactive, -> { Integer }, optional: false, nullable: false
+      field :totalamountactive, -> { Integer }, optional: false, nullable: false
       field :totalbalanceactive, -> { Integer }, optional: false, nullable: false
-      field :page_identifier, -> { String }, optional: true, nullable: false, api_name: "pageIdentifier"
+      field :pageidentifier, -> { String }, optional: true, nullable: false
       field :page_size, -> { Integer }, optional: true, nullable: false, api_name: "pageSize"
     end
   end

data/lib/payabli/types/vendor_response_stored_method.rb

@@ -14,7 +14,7 @@ module Payabli
       field :ach_holder_type, -> { String }, optional: false, nullable: true, api_name: "AchHolderType"
       field :is_validated_ach, -> { Internal::Types::Boolean }, optional: false, nullable: true, api_name: "IsValidatedACH"
       field :bin, -> { String }, optional: false, nullable: true, api_name: "BIN"
-      field :bin_data, -> { String }, optional: false, nullable: true, api_name: "binData"
+      field :bin_data, -> { Payabli::Types::BinData }, optional: false, nullable: true, api_name: "binData"
       field :aba, -> { String }, optional: false, nullable: true, api_name: "ABA"
       field :postal_code, -> { String }, optional: false, nullable: true, api_name: "PostalCode"
       field :method_type, -> { String }, optional: false, nullable: true, api_name: "MethodType"

data/lib/payabli/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Payabli
-  VERSION = "2.2.27"
+  VERSION = "2.2.29"
 end

data/lib/payabli.rb

@@ -449,6 +449,7 @@ require_relative "payabli/types/query_response_data"
 require_relative "payabli/types/query_transaction_payor_data"
 require_relative "payabli/types/refund_id"
 require_relative "payabli/types/returned_id"
+require_relative "payabli/types/split_count"
 require_relative "payabli/types/transaction_query_records"
 require_relative "payabli/types/customer_summary_record"
 require_relative "payabli/types/descriptor"
@@ -747,6 +748,8 @@ require_relative "payabli/query_types/types/transfer_out_detail_record"
 require_relative "payabli/query_types/types/transfer_out_detail_query_response"
 require_relative "payabli/query_types/types/device_query_record"
 require_relative "payabli/query_types/types/query_device_response"
+require_relative "payabli/query_types/types/v_card_transaction_record"
+require_relative "payabli/query_types/types/v_card_transaction_query_response"
 require_relative "payabli/v_2_money_in_types/types/v_2_response_code"
 require_relative "payabli/v_2_money_in_types/types/v_2_response_reason"
 require_relative "payabli/v_2_money_in_types/types/v_2_response_explanation"
@@ -1065,6 +1068,8 @@ require_relative "payabli/query/types/list_users_paypoint_request"
 require_relative "payabli/query/types/list_vendors_request"
 require_relative "payabli/query/types/list_vendors_org_request"
 require_relative "payabli/query/types/list_vcards_request"
+require_relative "payabli/query/types/list_vcards_transactions_request"
+require_relative "payabli/query/types/list_vcards_transactions_org_request"
 require_relative "payabli/query/types/list_vcards_org_request"
 require_relative "payabli/statistic/client"
 require_relative "payabli/statistic/types/basic_stats_request"