payabli 3.0.7 → 3.0.8

data/lib/payabli/organization/client.rb

@@ -104,11 +104,11 @@ module Payabli
       # @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] :org_id_path_param
       #
       # @example
       #   client.organization.edit_organization(
-      #     org_id: 123,
+      #     org_id_path_param: 123,
       #     contacts: [{
       #       contact_email: "herman@hermanscoatings.com",
       #       contact_name: "Herman Martinez",
@@ -119,7 +119,7 @@ module Payabli
       #     org_city: "Johnson City",
       #     org_country: "US",
       #     org_entry_name: "pilgrim-planner",
-      #     organization_data_org_id: "123",
+      #     org_id: "123",
       #     org_name: "Pilgrim Planner",
       #     org_state: "TN",
       #     org_timezone: -5,
@@ -132,14 +132,14 @@ module Payabli
       def edit_organization(request_options: {}, **params)
         params = Payabli::Internal::Types::Utils.normalize_keys(params)
         request_data = Payabli::Organization::Types::OrganizationData.new(params).to_h
-        non_body_param_names = %w[orgId]
+        non_body_param_names = %w[orgIdPathParam]
         body = request_data.except(*non_body_param_names)
 
         headers = @client.auth_headers_for_endpoint(security: [{ "BearerAuth" => [] }, { "APIKeyAuth" => [] }])
         request = Payabli::Internal::JSON::Request.new(
           base_url: request_options[:base_url],
           method: "PUT",
-          path: "Organization/#{URI.encode_uri_component(params[:org_id].to_s)}",
+          path: "Organization/#{URI.encode_uri_component(params[:org_id_path_param].to_s)}",
           headers: headers,
           body: body,
           request_options: request_options

data/lib/payabli/organization/types/organization_data.rb

@@ -4,7 +4,7 @@ module Payabli
   module Organization
     module Types
       class OrganizationData < Internal::Types::Model
-        field :org_id, -> { Integer }, optional: false, nullable: false, api_name: "orgId"
+        field :org_id_path_param, -> { Integer }, optional: false, nullable: false, api_name: "orgIdPathParam"
 
         field :services, -> { Internal::Types::Array[Payabli::Types::ServiceCost] }, optional: true, nullable: false
 
@@ -24,7 +24,7 @@ module Payabli
 
         field :org_entry_name, -> { String }, optional: true, nullable: false, api_name: "orgEntryName"
 
-        field :organization_data_org_id, -> { String }, optional: true, nullable: false, api_name: "orgId"
+        field :org_id, -> { String }, optional: true, nullable: false, api_name: "orgId"
 
         field :org_logo, -> { Payabli::Types::FileContent }, optional: true, nullable: false, api_name: "orgLogo"
 

data/lib/payabli/payment_link/client.rb

@@ -393,13 +393,16 @@ module Payabli
       # @return [Payabli::Types::PayabliApiResponsePaymentLinks]
       def push_pay_link_from_id(request_options: {}, **params)
         params = Payabli::Internal::Types::Utils.normalize_keys(params)
+        path_param_names = %i[pay_link_id]
+        body_params = params.except(*path_param_names)
+
         headers = @client.auth_headers_for_endpoint(security: [{ "BearerAuth" => [] }, { "APIKeyAuth" => [] }])
         request = Payabli::Internal::JSON::Request.new(
           base_url: request_options[:base_url],
           method: "POST",
           path: "PaymentLink/push/#{URI.encode_uri_component(params[:pay_link_id].to_s)}",
           headers: headers,
-          body: Payabli::Types::PushPayLinkRequest.new(params).to_h,
+          body: Payabli::Types::PushPayLinkRequest.new(body_params).to_h,
           request_options: request_options
         )
         begin
@@ -816,13 +819,16 @@ module Payabli
       # @return [Payabli::Types::PayabliApiResponsePaymentLinks]
       def update_pay_link_out_from_id(request_options: {}, **params)
         params = Payabli::Internal::Types::Utils.normalize_keys(params)
+        path_param_names = %i[paylink_id]
+        body_params = params.except(*path_param_names)
+
         headers = @client.auth_headers_for_endpoint(security: [{ "BearerAuth" => [] }, { "APIKeyAuth" => [] }])
         request = Payabli::Internal::JSON::Request.new(
           base_url: request_options[:base_url],
           method: "PATCH",
           path: "PaymentLink/updateOut/#{URI.encode_uri_component(params[:paylink_id].to_s)}",
           headers: headers,
-          body: Payabli::Types::PaymentPageRequestBodyOut.new(params).to_h,
+          body: Payabli::Types::PaymentPageRequestBodyOut.new(body_params).to_h,
           request_options: request_options
         )
         begin

data/lib/payabli/paypoint/client.rb

@@ -105,13 +105,16 @@ module Payabli
       # @return [Payabli::Types::PayabliApiResponse00Responsedatanonobject]
       def save_logo(request_options: {}, **params)
         params = Payabli::Internal::Types::Utils.normalize_keys(params)
+        path_param_names = %i[entry]
+        body_params = params.except(*path_param_names)
+
         headers = @client.auth_headers_for_endpoint(security: [{ "BearerAuth" => [] }, { "APIKeyAuth" => [] }])
         request = Payabli::Internal::JSON::Request.new(
           base_url: request_options[:base_url],
           method: "PUT",
           path: "Paypoint/logo/#{URI.encode_uri_component(params[:entry].to_s)}",
           headers: headers,
-          body: Payabli::Types::FileContent.new(params).to_h,
+          body: Payabli::Types::FileContent.new(body_params).to_h,
           request_options: request_options
         )
         begin

data/lib/payabli/types/auth_capture_payout_response_data.rb

@@ -5,7 +5,7 @@ module Payabli
     class AuthCapturePayoutResponseData < Internal::Types::Model
       field :auth_code, -> { String }, optional: false, nullable: true, api_name: "authCode"
 
-      field :reference_id, -> { String }, optional: false, nullable: false, api_name: "referenceId"
+      field :reference_id, -> { String }, optional: false, nullable: true, api_name: "referenceId"
 
       field :result_code, -> { Integer }, optional: false, nullable: false, api_name: "resultCode"
 

data/lib/payabli/types/billable_event.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # A chargeable action covered by a billing profile, with the fee schedule(s)
+    # that apply to it.
+    class BillableEvent < Internal::Types::Model
+      field :id, -> { Integer }, optional: false, nullable: false
+
+      field :name, -> { String }, optional: false, nullable: false
+
+      field :vertical, -> { Integer }, optional: false, nullable: false
+
+      field :service, -> { Integer }, optional: false, nullable: false
+
+      field :service_type, -> { Integer }, optional: false, nullable: false, api_name: "serviceType"
+
+      field :event_type, -> { Integer }, optional: false, nullable: false, api_name: "eventType"
+
+      field :event_group, -> { Integer }, optional: false, nullable: false, api_name: "eventGroup"
+
+      field :event_source, -> { Integer }, optional: false, nullable: false, api_name: "eventSource"
+
+      field :region_type, -> { Integer }, optional: false, nullable: false, api_name: "regionType"
+
+      field :fee_schedules, -> { Internal::Types::Array[Payabli::Types::FeeSchedule] }, optional: false, nullable: false, api_name: "feeSchedules"
+    end
+  end
+end

data/lib/payabli/types/billing_entity.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # An owning or participating entity, as returned by the View profile endpoint
+    # (`entityType` serialized as an integer).
+    class BillingEntity < Internal::Types::Model
+      field :entity_type, -> { Integer }, optional: false, nullable: false, api_name: "entityType"
+
+      field :entity_id, -> { Integer }, optional: false, nullable: false, api_name: "entityId"
+    end
+  end
+end

data/lib/payabli/types/billing_entity_named.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # An owning entity, as returned by the List profiles endpoint (`entityType`
+    # serialized as a name).
+    class BillingEntityNamed < Internal::Types::Model
+      field :entity_type, -> { Payabli::Types::EntityTypeName }, optional: false, nullable: false, api_name: "entityType"
+
+      field :entity_id, -> { Integer }, optional: false, nullable: false, api_name: "entityId"
+    end
+  end
+end

data/lib/payabli/types/billing_profile_query_response.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # A page of billing profiles that belong to an organization, returned by the
+    # List profiles endpoint. This is the data behind the Profile Library table in
+    # the Payabli Portal.
+    class BillingProfileQueryResponse < Internal::Types::Model
+      field :summary, -> { Payabli::Types::BillingProfileSummary }, optional: false, nullable: false
+
+      field :records, -> { Internal::Types::Array[Payabli::Types::BillingProfileRecord] }, optional: false, nullable: false
+    end
+  end
+end

data/lib/payabli/types/billing_profile_record.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # A single billing profile as it appears in the list.
+    class BillingProfileRecord < Internal::Types::Model
+      field :id, -> { Integer }, optional: false, nullable: false
+
+      field :version_id, -> { Integer }, optional: false, nullable: false, api_name: "versionId"
+
+      field :version_number, -> { Integer }, optional: false, nullable: false, api_name: "versionNumber"
+
+      field :business, -> { Payabli::Types::BillingEntityNamed }, optional: false, nullable: false
+
+      field :service_vertical, -> { Payabli::Types::ServiceVerticalName }, optional: false, nullable: false, api_name: "serviceVertical"
+
+      field :name, -> { String }, optional: false, nullable: false
+
+      field :fee_type, -> { Payabli::Types::FeeTypeName }, optional: false, nullable: false, api_name: "feeType"
+
+      field :created_at, -> { String }, optional: false, nullable: false, api_name: "createdAt"
+
+      field :updated_at, -> { String }, optional: false, nullable: false, api_name: "updatedAt"
+
+      field :entities_assigned, -> { Payabli::Types::EntitiesAssigned }, optional: false, nullable: false, api_name: "entitiesAssigned"
+
+      field :parent_id, -> { String }, optional: false, nullable: false, api_name: "parentId"
+
+      field :count_of_events, -> { Integer }, optional: false, nullable: false, api_name: "countOfEvents"
+    end
+  end
+end

data/lib/payabli/types/billing_profile_response.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # A billing profile assigned to an entity, returned by the View profile
+    # endpoint. A profile is a named configuration of billable events, each with
+    # one or more fee schedules. Profiles are append-only versioned — every edit
+    # mints a new version.
+    class BillingProfileResponse < Internal::Types::Model
+      field :id, -> { Integer }, optional: false, nullable: false
+
+      field :version_id, -> { Integer }, optional: false, nullable: false, api_name: "versionId"
+
+      field :version_number, -> { Integer }, optional: false, nullable: false, api_name: "versionNumber"
+
+      field :business, -> { Payabli::Types::BillingEntity }, optional: false, nullable: false
+
+      field :name, -> { String }, optional: false, nullable: false
+
+      field :fee_type, -> { Integer }, optional: false, nullable: false, api_name: "feeType"
+
+      field :created_at, -> { String }, optional: false, nullable: false, api_name: "createdAt"
+
+      field :updated_at, -> { String }, optional: false, nullable: false, api_name: "updatedAt"
+
+      field :parent_id, -> { String }, optional: false, nullable: false, api_name: "parentId"
+
+      field :billable_events, -> { Internal::Types::Array[Payabli::Types::BillableEvent] }, optional: false, nullable: false, api_name: "billableEvents"
+    end
+  end
+end

data/lib/payabli/types/billing_profile_summary.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # Pagination summary for the profile list.
+    class BillingProfileSummary < Internal::Types::Model
+      field :page_identifier, -> { String }, optional: false, nullable: false, api_name: "pageIdentifier"
+
+      field :page_size, -> { Integer }, optional: false, nullable: false, api_name: "pageSize"
+
+      field :total_pages, -> { Integer }, optional: false, nullable: false, api_name: "totalPages"
+
+      field :total_records, -> { Integer }, optional: false, nullable: false, api_name: "totalRecords"
+    end
+  end
+end

data/lib/payabli/types/collection_schedule_value.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    module CollectionScheduleValue
+      # CollectionScheduleValue 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/device_query_record.rb

@@ -45,11 +45,19 @@ module Payabli
 
       field :paypoint_entry, -> { String }, optional: false, nullable: true, api_name: "paypointEntry"
 
+      field :paypoint_logo, -> { String }, optional: false, nullable: true, api_name: "paypointLogo"
+
       field :external_paypoint_id, -> { String }, optional: false, nullable: true, api_name: "externalPaypointId"
 
       field :parent_org_id, -> { Integer }, optional: false, nullable: true, api_name: "parentOrgId"
 
       field :parent_org_name, -> { String }, optional: false, nullable: true, api_name: "parentOrgName"
+
+      field :parent_org_logo, -> { String }, optional: false, nullable: true, api_name: "parentOrgLogo"
+
+      field :transaction_count, -> { Integer }, optional: false, nullable: false, api_name: "transactionCount"
+
+      field :volume_processed, -> { Integer }, optional: false, nullable: false, api_name: "volumeProcessed"
     end
   end
 end

data/lib/payabli/types/entities_assigned.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # Counts of entities the profile is assigned to. Any non-zero count locks the
+    # profile from deletion in the Payabli Portal.
+    class EntitiesAssigned < Internal::Types::Model
+      field :organizations, -> { Integer }, optional: false, nullable: false
+
+      field :paypoints, -> { Integer }, optional: false, nullable: false
+
+      field :templates, -> { Integer }, optional: false, nullable: false
+
+      field :applications, -> { Integer }, optional: false, nullable: false
+    end
+  end
+end

data/lib/payabli/types/entity_type_name.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    module EntityTypeName
+      extend Payabli::Internal::Types::Enum
+
+      ORGANIZATION = "Organization"
+      PAYPOINT = "Paypoint"
+      CUSTOMER = "Customer"
+      TEMPLATE = "Template"
+      APPLICATION = "Application"
+      BANK_ACCOUNT = "BankAccount"
+      ADDRESS = "Address"
+    end
+  end
+end

data/lib/payabli/types/entity_type_value.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    module EntityTypeValue
+      # EntityTypeValue 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/event_group_value.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    module EventGroupValue
+      # EventGroupValue 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/event_source_value.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    module EventSourceValue
+      # EventSourceValue 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/event_type_value.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    module EventTypeValue
+      # EventTypeValue 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/fee_schedule.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # A fee schedule attached to a billable event. Flat and interchange-plus
+    # schedules share this shape; `feeType` is the discriminator.
+    class FeeSchedule < Internal::Types::Model
+      field :id, -> { Integer }, optional: false, nullable: false
+
+      field :value, -> { Integer }, optional: false, nullable: false
+
+      field :rate, -> { Integer }, optional: false, nullable: false
+
+      field :passthrough, -> { Integer }, optional: false, nullable: false
+
+      field :payor, -> { Payabli::Types::BillingEntity }, optional: false, nullable: true
+
+      field :collector, -> { Payabli::Types::BillingEntity }, optional: false, nullable: true
+
+      field :overflow_payor, -> { Payabli::Types::BillingEntity }, optional: false, nullable: true, api_name: "overflowPayor"
+
+      field :overflow_collection_schedule, -> { Integer }, optional: false, nullable: true, api_name: "overflowCollectionSchedule"
+
+      field :minimum_total, -> { Integer }, optional: false, nullable: true, api_name: "minimumTotal"
+
+      field :maximum_total, -> { Integer }, optional: false, nullable: true, api_name: "maximumTotal"
+
+      field :effective_date, -> { String }, optional: false, nullable: false, api_name: "effectiveDate"
+
+      field :expiration_date, -> { String }, optional: false, nullable: true, api_name: "expirationDate"
+
+      field :created_at, -> { String }, optional: false, nullable: false, api_name: "createdAt"
+
+      field :updated_at, -> { String }, optional: false, nullable: false, api_name: "updatedAt"
+
+      field :created_by, -> { String }, optional: false, nullable: false, api_name: "createdBy"
+
+      field :collection_schedule, -> { Integer }, optional: false, nullable: false, api_name: "collectionSchedule"
+
+      field :bill_date, -> { Integer }, optional: false, nullable: true, api_name: "billDate"
+
+      field :override_fee_schedule_id, -> { Integer }, optional: false, nullable: true, api_name: "overrideFeeScheduleId"
+
+      field :fee_type, -> { Integer }, optional: false, nullable: false, api_name: "feeType"
+    end
+  end
+end

data/lib/payabli/types/fee_type_name.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    module FeeTypeName
+      extend Payabli::Internal::Types::Enum
+
+      FLAT = "Flat"
+      ICP = "ICP"
+    end
+  end
+end

data/lib/payabli/types/fee_type_value.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    module FeeTypeValue
+      # FeeTypeValue 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/passthrough_value.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    module PassthroughValue
+      # PassthroughValue 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/query_payout_transaction_records_item.rb

@@ -100,6 +100,8 @@ module Payabli
       field :ach_trace_number, -> { String }, optional: true, nullable: false, api_name: "AchTraceNumber"
 
       field :entity_id, -> { String }, optional: true, nullable: false, api_name: "EntityId"
+
+      field :allowed_actions, -> { Internal::Types::Array[Payabli::Types::QueryPayoutTransactionRecordsItemAllowedActionsItem] }, optional: false, nullable: false, api_name: "allowedActions"
     end
   end
 end

data/lib/payabli/types/query_payout_transaction_records_item_allowed_actions_item.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    module QueryPayoutTransactionRecordsItemAllowedActionsItem
+      extend Payabli::Internal::Types::Enum
+
+      CAPTURE = "capture"
+      CANCEL = "cancel"
+      REISSUE = "reissue"
+    end
+  end
+end

data/lib/payabli/types/region_type_value.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    module RegionTypeValue
+      # RegionTypeValue 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/service_group_value.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    module ServiceGroupValue
+      # ServiceGroupValue 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/service_type_value.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    module ServiceTypeValue
+      # ServiceTypeValue 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