payabli 3.0.7 → 3.0.9

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_challenge_data.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # The issued activation code and the time it expires.
+    class DeviceChallengeData < Internal::Types::Model
+      field :code, -> { String }, optional: false, nullable: false
+
+      field :expires_at, -> { String }, optional: false, nullable: false, api_name: "expiresAt"
+    end
+  end
+end

data/lib/payabli/types/device_challenge_response.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # Response to a device activation code request. On success, `responseData`
+    # carries the verification code and the time it expires.
+    class DeviceChallengeResponse < Internal::Types::Model
+      field :response_code, -> { Integer }, optional: true, nullable: false, api_name: "responseCode"
+
+      field :page_identifier, -> { String }, optional: true, nullable: false, api_name: "pageIdentifier"
+
+      field :room_id, -> { Integer }, optional: true, nullable: false, api_name: "roomId"
+
+      field :is_success, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "isSuccess"
+
+      field :response_text, -> { String }, optional: false, nullable: false, api_name: "responseText"
+
+      field :response_data, -> { Payabli::Types::DeviceChallengeData }, optional: false, nullable: false, api_name: "responseData"
+    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/{lot_number.rb → fee_type_value.rb}

@@ -2,8 +2,8 @@
 
 module Payabli
   module Types
-    module LotNumber
-      # LotNumber is an alias for String
+    module FeeTypeValue
+      # FeeTypeValue is an alias for Integer
 
       # @option str [String]
       #

data/lib/payabli/types/methodall.rb

@@ -8,6 +8,7 @@ module Payabli
       CARD = "card"
       ACH = "ach"
       CLOUD = "cloud"
+      DEVICE = "device"
       CHECK = "check"
       CASH = "cash"
     end

data/lib/payabli/types/operation_result.rb

@@ -3,9 +3,11 @@
 module Payabli
   module Types
     class OperationResult < Internal::Types::Model
-      field :message, -> { String }, optional: true, nullable: false
-
       field :success, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+      field :message, -> { String }, optional: false, nullable: false
+
+      field :link, -> { String }, optional: false, nullable: false
     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/pay_method_cloud.rb

@@ -6,8 +6,6 @@ module Payabli
       field :device, -> { String }, optional: true, nullable: false
 
       field :method_, -> { Payabli::Types::PayMethodCloudMethod }, optional: false, nullable: false, api_name: "method"
-
-      field :save_if_success, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "saveIfSuccess"
     end
   end
 end

data/lib/payabli/types/pay_method_device.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # The required fields for a payment made with a semi-integrated device.
+    class PayMethodDevice < Internal::Types::Model
+      field :device, -> { String }, optional: false, nullable: false
+
+      field :method_, -> { Payabli::Types::PayMethodDeviceMethod }, optional: false, nullable: false, api_name: "method"
+
+      field :save_if_success, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "saveIfSuccess"
+    end
+  end
+end

data/lib/payabli/types/pay_method_device_method.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    module PayMethodDeviceMethod
+      extend Payabli::Internal::Types::Enum
+
+      DEVICE = "device"
+    end
+  end
+end

data/lib/payabli/types/payment_method.rb

@@ -14,6 +14,8 @@ module Payabli
 
       member -> { Payabli::Types::PayMethodCloud }
 
+      member -> { Payabli::Types::PayMethodDevice }
+
       member -> { Payabli::Types::Check }
 
       member -> { Payabli::Types::Cash }

data/lib/payabli/types/paypoint_data.rb

@@ -39,6 +39,8 @@ module Payabli
 
       field :state, -> { String }, optional: true, nullable: false, api_name: "State"
 
+      field :business_summary, -> { String }, optional: false, nullable: true, api_name: "Summary"
+
       field :summary, -> { Payabli::Types::PaypointSummary }, optional: true, nullable: false
 
       field :time_zone, -> { Integer }, optional: true, nullable: false, api_name: "TimeZone"

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/request_out_authorize_invoice_data.rb

@@ -2,32 +2,11 @@
 
 module Payabli
   module Types
+    # Bill to pay with this payout. Create the bill first with
+    # [Add bill](/developers/api-reference/bill/add-bill), then reference it here
+    # by `billId`.
     class RequestOutAuthorizeInvoiceData < Internal::Types::Model
-      field :invoice_number, -> { String }, optional: true, nullable: false, api_name: "invoiceNumber"
-
-      field :net_amount, -> { String }, optional: true, nullable: false, api_name: "netAmount"
-
-      field :invoice_date, -> { String }, optional: true, nullable: false, api_name: "invoiceDate"
-
-      field :due_date, -> { String }, optional: true, nullable: false, api_name: "dueDate"
-
-      field :comments, -> { String }, optional: true, nullable: false
-
-      field :lot_number, -> { String }, optional: true, nullable: false, api_name: "lotNumber"
-
-      field :bill_id, -> { Integer }, optional: true, nullable: false, api_name: "billId"
-
-      field :discount, -> { Integer }, optional: true, nullable: false
-
-      field :terms, -> { Payabli::Types::Terms }, optional: true, nullable: false
-
-      field :accounting_field_1, -> { String }, optional: true, nullable: false, api_name: "accountingField1"
-
-      field :accounting_field_2, -> { String }, optional: true, nullable: false, api_name: "accountingField2"
-
-      field :additional_data, -> { String }, optional: true, nullable: false, api_name: "additionalData"
-
-      field :attachments, -> { Internal::Types::Array[Payabli::Types::FileContent] }, optional: true, nullable: false
+      field :bill_id, -> { Integer }, optional: false, nullable: false, api_name: "billId"
     end
   end
 end

data/lib/payabli/types/request_out_authorize_vendor_data.rb

@@ -2,70 +2,12 @@
 
 module Payabli
   module Types
-    # Object containing vendor data.
+    # Vendor to pay with this payout. Create the vendor first with
+    # [Create vendor](/developers/api-reference/vendor/create-vendor), then
+    # reference it here by `vendorNumber` or `vendorId`.
     class RequestOutAuthorizeVendorData < Internal::Types::Model
       field :vendor_number, -> { String }, optional: true, nullable: false, api_name: "vendorNumber"
 
-      field :name_1, -> { String }, optional: true, nullable: false, api_name: "name1"
-
-      field :name_2, -> { String }, optional: true, nullable: false, api_name: "name2"
-
-      field :ein, -> { String }, optional: true, nullable: false
-
-      field :phone, -> { String }, optional: true, nullable: false
-
-      field :email, -> { String }, optional: true, nullable: false
-
-      field :address_1, -> { String }, optional: true, nullable: false, api_name: "address1"
-
-      field :city, -> { String }, optional: true, nullable: false
-
-      field :state, -> { String }, optional: true, nullable: false
-
-      field :zip, -> { String }, optional: true, nullable: false
-
-      field :country, -> { String }, optional: true, nullable: false
-
-      field :mcc, -> { String }, optional: true, nullable: false
-
-      field :contacts, -> { Internal::Types::Array[Payabli::Types::Contacts] }, optional: true, nullable: false
-
-      field :billing_data, -> { Payabli::Types::RequestOutAuthorizeVendorBillingData }, optional: true, nullable: false, api_name: "billingData"
-
-      field :vendor_status, -> { Integer }, optional: true, nullable: false, api_name: "vendorStatus"
-
-      field :remit_address_1, -> { String }, optional: true, nullable: false, api_name: "remitAddress1"
-
-      field :remit_address_2, -> { String }, optional: true, nullable: false, api_name: "remitAddress2"
-
-      field :remit_city, -> { String }, optional: true, nullable: false, api_name: "remitCity"
-
-      field :remit_state, -> { String }, optional: true, nullable: false, api_name: "remitState"
-
-      field :remit_zip, -> { String }, optional: true, nullable: false, api_name: "remitZip"
-
-      field :remit_country, -> { String }, optional: true, nullable: false, api_name: "remitCountry"
-
-      field :customer_vendor_account, -> { String }, optional: true, nullable: false, api_name: "customerVendorAccount"
-
-      field :custom_field_1, -> { String }, optional: true, nullable: false, api_name: "customField1"
-
-      field :custom_field_2, -> { String }, optional: true, nullable: false, api_name: "customField2"
-
-      field :additional_data, -> { Internal::Types::Hash[String, Internal::Types::Hash[String, Object]] }, optional: true, nullable: false, api_name: "additionalData"
-
-      field :address_2, -> { String }, optional: true, nullable: false, api_name: "address2"
-
-      field :internal_reference_id, -> { Integer }, optional: true, nullable: false, api_name: "internalReferenceId"
-
-      field :location_code, -> { String }, optional: true, nullable: false, api_name: "locationCode"
-
-      field :payee_name_1, -> { String }, optional: true, nullable: false, api_name: "payeeName1"
-
-      field :payee_name_2, -> { String }, optional: true, nullable: false, api_name: "payeeName2"
-
-      field :payment_method, -> { Payabli::Types::VendorPaymentMethod }, optional: true, nullable: false, api_name: "paymentMethod"
-
       field :vendor_id, -> { Integer }, optional: true, nullable: false, api_name: "vendorId"
     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