payabli 3.0.1 → 3.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (68) hide show
  1. checksums.yaml +4 -4
  2. data/.fern/metadata.json +5 -5
  3. data/README.md +4 -1
  4. data/lib/payabli/client.rb +38 -4
  5. data/lib/payabli/customer/client.rb +1 -1
  6. data/lib/payabli/funding/client.rb +49 -0
  7. data/lib/payabli/funding/types/deposit_funds_request.rb +19 -0
  8. data/lib/payabli/internal/http/raw_client.rb +28 -5
  9. data/lib/payabli/internal/oauth_provider.rb +67 -0
  10. data/lib/payabli/money_in/client.rb +79 -35
  11. data/lib/payabli/money_out/client.rb +63 -3
  12. data/lib/payabli/money_out/types/renew_v_card_request.rb +13 -0
  13. data/lib/payabli/payment_link/client.rb +7 -0
  14. data/lib/payabli/payment_link/types/pay_link_data_invoice.rb +1 -1
  15. data/lib/payabli/token/client.rb +51 -0
  16. data/lib/payabli/token/types/create_server_side_token_request.rb +17 -0
  17. data/lib/payabli/types/add_device_response.rb +4 -0
  18. data/lib/payabli/types/add_method_response.rb +4 -0
  19. data/lib/payabli/types/add_response_response.rb +4 -0
  20. data/lib/payabli/types/auth_capture_payout_response_data.rb +2 -0
  21. data/lib/payabli/types/authorize_payment_method.rb +4 -0
  22. data/lib/payabli/types/bill_pay_out_data.rb +15 -9
  23. data/lib/payabli/types/cancel_payout_response_data.rb +27 -0
  24. data/lib/payabli/types/capture_all_out_response_response_data_item.rb +2 -0
  25. data/lib/payabli/types/contacts_response.rb +3 -3
  26. data/lib/payabli/types/deposit_funds_response.rb +16 -0
  27. data/lib/payabli/types/get_method_response_response_data_customers_item.rb +42 -0
  28. data/lib/payabli/types/get_pay_link_from_id_response.rb +4 -0
  29. data/lib/payabli/types/method_element.rb +4 -0
  30. data/lib/payabli/types/methods_list.rb +6 -0
  31. data/lib/payabli/types/modify_approval_bill_response.rb +4 -0
  32. data/lib/payabli/types/notification_log_detail.rb +24 -0
  33. data/lib/payabli/types/payabli_access_token_response.rb +17 -0
  34. data/lib/payabli/types/payabli_api_response_0000.rb +1 -1
  35. data/lib/payabli/types/query_payout_transaction_records_item.rb +54 -34
  36. data/lib/payabli/types/query_payout_transaction_records_item_payment_data.rb +16 -16
  37. data/lib/payabli/types/query_payout_transaction_summary.rb +17 -17
  38. data/lib/payabli/types/query_response_settlements_records_item.rb +2 -0
  39. data/lib/payabli/types/query_transaction_events.rb +2 -2
  40. data/lib/payabli/types/refund_v_2_request.rb +21 -0
  41. data/lib/payabli/types/remove_device_response.rb +4 -0
  42. data/lib/payabli/types/renew_v_card_response.rb +13 -0
  43. data/lib/payabli/types/renew_v_card_response_data.rb +25 -0
  44. data/lib/payabli/types/set_approved_bill_response.rb +4 -0
  45. data/lib/payabli/types/settlement_split_funding_detail.rb +23 -0
  46. data/lib/payabli/types/stat_basic_extended_query_record.rb +8 -0
  47. data/lib/payabli/types/token_error_response.rb +13 -0
  48. data/lib/payabli/types/tokenize_ach.rb +0 -2
  49. data/lib/payabli/types/tokenize_card.rb +2 -0
  50. data/lib/payabli/types/transfer_out_record.rb +4 -0
  51. data/lib/payabli/types/vendor_call_status_completed.rb +20 -0
  52. data/lib/payabli/types/vendor_call_status_extracted_data.rb +12 -0
  53. data/lib/payabli/types/vendor_call_status_failed.rb +18 -0
  54. data/lib/payabli/types/vendor_call_status_response.rb +18 -0
  55. data/lib/payabli/types/vendor_call_status_scheduled.rb +14 -0
  56. data/lib/payabli/types/vendor_data.rb +1 -1
  57. data/lib/payabli/types/vendor_query_record.rb +45 -41
  58. data/lib/payabli/types/vendor_schedule_call_response.rb +20 -0
  59. data/lib/payabli/types/vendor_schedule_call_response_data.rb +16 -0
  60. data/lib/payabli/types/vendoridtrans.rb +23 -0
  61. data/lib/payabli/vendor/client.rb +79 -0
  62. data/lib/payabli/vendor/types/schedule_enrichment_call_request.rb +27 -0
  63. data/lib/payabli/version.rb +1 -1
  64. data/lib/payabli.rb +36 -13
  65. data/reference.md +675 -163
  66. data/wiremock/docker-compose.test.yml +1 -1
  67. data/wiremock/wiremock-mappings.json +258 -93
  68. metadata +25 -2
@@ -12,6 +12,13 @@ module Payabli
12
12
 
13
13
  # Generates a payment link for an invoice from the invoice ID.
14
14
  #
15
+ # The payment page configuration blocks (`logo`, `page`, `paymentMethods`, `review`, `messageBeforePaying`,
16
+ # `paymentButton`, `notes`, `contactUs`, and `settings`) are optional. When you omit a block, Payabli applies a
17
+ # default rather than hiding it. The block is enabled at a fixed display order, so the generated page stays
18
+ # complete and branded. To hide a section, send the block explicitly with `enabled` set to `false`. An explicit
19
+ # value is always honored and is never replaced by a default. For each block's default, see its description in the
20
+ # request body.
21
+ #
15
22
  # @param request_options [Hash]
16
23
  # @param params [Payabli::PaymentLink::Types::PayLinkDataInvoice]
17
24
  # @option request_options [String] :base_url
@@ -14,7 +14,7 @@ module Payabli
14
14
 
15
15
  field :contact_us, -> { Payabli::Types::ContactElement }, optional: true, nullable: false, api_name: "contactUs"
16
16
 
17
- field :invoices, -> { Payabli::Types::InvoiceElement }, optional: true, nullable: false
17
+ field :invoices, -> { Payabli::Types::InvoiceElement }, optional: false, nullable: false
18
18
 
19
19
  field :logo, -> { Payabli::Types::Element }, optional: true, nullable: false
20
20
 
@@ -0,0 +1,51 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Payabli
4
+ module Token
5
+ class Client
6
+ # @param client [Payabli::Internal::Http::RawClient]
7
+ #
8
+ # @return [void]
9
+ def initialize(client:)
10
+ @client = client
11
+ end
12
+
13
+ # Exchanges a client ID and client secret for a short-lived Bearer access token using the OAuth2
14
+ # client-credentials flow. Designed for server-to-server use: the credentials and the returned token stay on your
15
+ # backend. Send the returned `access_token` in the `Authorization` header as `Bearer <access_token>` on subsequent
16
+ # API calls. See the [OAuth authentication guide](/developers/oauth-authentication) for the full flow.
17
+ #
18
+ # @param request_options [Hash]
19
+ # @param params [Payabli::Token::Types::CreateServerSideTokenRequest]
20
+ # @option request_options [String] :base_url
21
+ # @option request_options [Hash{String => Object}] :additional_headers
22
+ # @option request_options [Hash{String => Object}] :additional_query_parameters
23
+ # @option request_options [Hash{String => Object}] :additional_body_parameters
24
+ # @option request_options [Integer] :timeout_in_seconds
25
+ #
26
+ # @return [Payabli::Types::PayabliAccessTokenResponse]
27
+ def create_server_side_token(request_options: {}, **params)
28
+ params = Payabli::Internal::Types::Utils.normalize_keys(params)
29
+ request = Payabli::Internal::JSON::Request.new(
30
+ base_url: request_options[:base_url],
31
+ method: "POST",
32
+ path: "v2/Token/serverside",
33
+ body: Payabli::Token::Types::CreateServerSideTokenRequest.new(params).to_h,
34
+ request_options: request_options
35
+ )
36
+ begin
37
+ response = @client.send(request)
38
+ rescue Net::HTTPRequestTimeout
39
+ raise Payabli::Errors::TimeoutError
40
+ end
41
+ code = response.code.to_i
42
+ if code.between?(200, 299)
43
+ Payabli::Types::PayabliAccessTokenResponse.load(response.body)
44
+ else
45
+ error_class = Payabli::Errors::ResponseError.subclass_for_code(code)
46
+ raise error_class.new(response.body, code: code)
47
+ end
48
+ end
49
+ end
50
+ end
51
+ end
@@ -0,0 +1,17 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Payabli
4
+ module Token
5
+ module Types
6
+ class CreateServerSideTokenRequest < Internal::Types::Model
7
+ field :client_id, -> { String }, optional: false, nullable: false, api_name: "clientId"
8
+
9
+ field :client_secret, -> { String }, optional: false, nullable: false, api_name: "clientSecret"
10
+
11
+ field :state, -> { String }, optional: true, nullable: false
12
+
13
+ field :permissions, -> { Internal::Types::Array[String] }, optional: true, nullable: false
14
+ end
15
+ end
16
+ end
17
+ end
@@ -3,6 +3,10 @@
3
3
  module Payabli
4
4
  module Types
5
5
  class AddDeviceResponse < Internal::Types::Model
6
+ field :is_success, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "isSuccess"
7
+
8
+ field :response_text, -> { String }, optional: false, nullable: false, api_name: "responseText"
9
+
6
10
  field :page_identifier, -> { String }, optional: true, nullable: false, api_name: "pageIdentifier"
7
11
 
8
12
  field :response_data, -> { String }, optional: true, nullable: false, api_name: "responseData"
@@ -3,6 +3,10 @@
3
3
  module Payabli
4
4
  module Types
5
5
  class AddMethodResponse < Internal::Types::Model
6
+ field :is_success, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "isSuccess"
7
+
8
+ field :response_text, -> { String }, optional: false, nullable: false, api_name: "responseText"
9
+
6
10
  field :response_data, -> { Payabli::Types::AddMethodResponseResponseData }, optional: true, nullable: false, api_name: "responseData"
7
11
  end
8
12
  end
@@ -3,6 +3,10 @@
3
3
  module Payabli
4
4
  module Types
5
5
  class AddResponseResponse < Internal::Types::Model
6
+ field :is_success, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "isSuccess"
7
+
8
+ field :response_text, -> { String }, optional: false, nullable: false, api_name: "responseText"
9
+
6
10
  field :response_data, -> { Integer }, optional: true, nullable: false, api_name: "responseData"
7
11
  end
8
12
  end
@@ -17,6 +17,8 @@ module Payabli
17
17
 
18
18
  field :customer_id, -> { Integer }, optional: false, nullable: false, api_name: "customerId"
19
19
 
20
+ field :vendor_id, -> { Integer }, optional: false, nullable: false, api_name: "vendorId"
21
+
20
22
  field :method_reference_id, -> { String }, optional: false, nullable: true, api_name: "methodReferenceId"
21
23
  end
22
24
  end
@@ -9,6 +9,10 @@ module Payabli
9
9
  # - `{ method: "ach", achHolder: "...", achRouting: "...", achAccount: "...", achAccountType: "..." }` - ACH payment
10
10
  # method with bank details
11
11
  # - `{ method: "ach", storedMethodId: "..." }` - ACH payment method using stored method ID
12
+ # - `{ method: "wire", achHolder: "...", achRouting: "...", achAccount: "...", achAccountType: "..." }` - Wire
13
+ # transfer payment method (US only, irrevocable)
14
+ # - `{ method: "rtp", achHolder: "...", achRouting: "...", achAccount: "...", achAccountType: "..." }` - Real-Time
15
+ # Payments method (US only, irrevocable)
12
16
  class AuthorizePaymentMethod < Internal::Types::Model
13
17
  field :method_, -> { String }, optional: false, nullable: false, api_name: "method"
14
18
 
@@ -5,27 +5,33 @@ module Payabli
5
5
  class BillPayOutData < Internal::Types::Model
6
6
  field :bill_id, -> { Integer }, optional: true, nullable: false, api_name: "billId"
7
7
 
8
- field :comments, -> { String }, optional: true, nullable: false
8
+ field :lot_number, -> { String }, optional: true, nullable: false, api_name: "LotNumber"
9
9
 
10
- field :due_date, -> { String }, optional: false, nullable: true, api_name: "dueDate"
10
+ field :accounting_field_1, -> { String }, optional: true, nullable: false, api_name: "AccountingField1"
11
11
 
12
- field :invoice_date, -> { String }, optional: false, nullable: true, api_name: "invoiceDate"
12
+ field :accounting_field_2, -> { String }, optional: true, nullable: false, api_name: "AccountingField2"
13
+
14
+ field :terms, -> { Payabli::Types::Terms }, optional: true, nullable: false, api_name: "Terms"
15
+
16
+ field :additional_data, -> { String }, optional: true, nullable: false, api_name: "AdditionalData"
17
+
18
+ field :attachments, -> { Internal::Types::Array[Payabli::Types::FileContent] }, optional: true, nullable: false
13
19
 
14
20
  field :invoice_number, -> { String }, optional: true, nullable: false, api_name: "invoiceNumber"
15
21
 
16
22
  field :net_amount, -> { String }, optional: true, nullable: false, api_name: "netAmount"
17
23
 
18
- field :discount, -> { String }, optional: true, nullable: false
24
+ field :invoice_date, -> { String }, optional: false, nullable: true, api_name: "invoiceDate"
19
25
 
20
- field :terms, -> { Payabli::Types::Terms }, optional: true, nullable: false, api_name: "Terms"
26
+ field :due_date, -> { String }, optional: false, nullable: true, api_name: "dueDate"
21
27
 
22
- field :accounting_field_1, -> { String }, optional: true, nullable: false, api_name: "AccountingField1"
28
+ field :comments, -> { String }, optional: true, nullable: false
23
29
 
24
- field :accounting_field_2, -> { String }, optional: true, nullable: false, api_name: "AccountingField2"
30
+ field :identifier, -> { String }, optional: true, nullable: false
25
31
 
26
- field :additional_data, -> { String }, optional: true, nullable: false, api_name: "AdditionalData"
32
+ field :discount, -> { String }, optional: true, nullable: false
27
33
 
28
- field :attachments, -> { Internal::Types::Array[Payabli::Types::FileContent] }, optional: true, nullable: false
34
+ field :total_amount, -> { String }, optional: true, nullable: false, api_name: "totalAmount"
29
35
  end
30
36
  end
31
37
  end
@@ -0,0 +1,27 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Payabli
4
+ module Types
5
+ # Response data for canceling a single payout transaction. Mirrors the general response data, with `VendorId` added
6
+ # alongside `CustomerId`.
7
+ class CancelPayoutResponseData < Internal::Types::Model
8
+ field :auth_code, -> { String }, optional: true, nullable: false, api_name: "AuthCode"
9
+
10
+ field :avs_response_text, -> { String }, optional: true, nullable: false, api_name: "avsResponseText"
11
+
12
+ field :customer_id, -> { Integer }, optional: true, nullable: false, api_name: "CustomerId"
13
+
14
+ field :vendor_id, -> { Integer }, optional: true, nullable: false, api_name: "VendorId"
15
+
16
+ field :cvv_response_text, -> { String }, optional: true, nullable: false, api_name: "cvvResponseText"
17
+
18
+ field :method_reference_id, -> { String }, optional: true, nullable: false, api_name: "methodReferenceId"
19
+
20
+ field :reference_id, -> { String }, optional: true, nullable: false, api_name: "ReferenceId"
21
+
22
+ field :result_code, -> { Integer }, optional: true, nullable: false, api_name: "ResultCode"
23
+
24
+ field :result_text, -> { String }, optional: true, nullable: false, api_name: "ResultText"
25
+ end
26
+ end
27
+ end
@@ -5,6 +5,8 @@ module Payabli
5
5
  class CaptureAllOutResponseResponseDataItem < Internal::Types::Model
6
6
  field :customer_id, -> { Integer }, optional: true, nullable: false, api_name: "CustomerId"
7
7
 
8
+ field :vendor_id, -> { Integer }, optional: true, nullable: false, api_name: "VendorId"
9
+
8
10
  field :reference_id, -> { String }, optional: true, nullable: false, api_name: "ReferenceId"
9
11
 
10
12
  field :result_code, -> { Integer }, optional: true, nullable: false, api_name: "ResultCode"
@@ -3,13 +3,13 @@
3
3
  module Payabli
4
4
  module Types
5
5
  class ContactsResponse < Internal::Types::Model
6
- field :contact_email, -> { String }, optional: true, nullable: false, api_name: "ContactEmail"
7
-
8
6
  field :contact_name, -> { String }, optional: true, nullable: false, api_name: "ContactName"
9
7
 
10
- field :contact_phone, -> { String }, optional: true, nullable: false, api_name: "ContactPhone"
8
+ field :contact_email, -> { String }, optional: true, nullable: false, api_name: "ContactEmail"
11
9
 
12
10
  field :contact_title, -> { String }, optional: true, nullable: false, api_name: "ContactTitle"
11
+
12
+ field :contact_phone, -> { String }, optional: true, nullable: false, api_name: "ContactPhone"
13
13
  end
14
14
  end
15
15
  end
@@ -0,0 +1,16 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Payabli
4
+ module Types
5
+ # Response for a deposit funds request.
6
+ class DepositFundsResponse < Internal::Types::Model
7
+ field :is_success, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "isSuccess"
8
+
9
+ field :response_text, -> { String }, optional: false, nullable: false, api_name: "responseText"
10
+
11
+ field :response_data, -> { Internal::Types::Hash[String, Object] }, optional: false, nullable: true, api_name: "responseData"
12
+
13
+ field :page_identifier, -> { String }, optional: false, nullable: true, api_name: "pageIdentifier"
14
+ end
15
+ end
16
+ end
@@ -3,6 +3,48 @@
3
3
  module Payabli
4
4
  module Types
5
5
  class GetMethodResponseResponseDataCustomersItem < Internal::Types::Model
6
+ field :additional_data, -> { Internal::Types::Hash[String, Internal::Types::Hash[String, Object]] }, optional: true, nullable: false, api_name: "additionalData"
7
+
8
+ field :billing_address_1, -> { String }, optional: true, nullable: false, api_name: "billingAddress1"
9
+
10
+ field :billing_address_2, -> { String }, optional: true, nullable: false, api_name: "billingAddress2"
11
+
12
+ field :billing_city, -> { String }, optional: true, nullable: false, api_name: "billingCity"
13
+
14
+ field :billing_country, -> { String }, optional: true, nullable: false, api_name: "billingCountry"
15
+
16
+ field :billing_email, -> { String }, optional: true, nullable: false, api_name: "billingEmail"
17
+
18
+ field :billing_phone, -> { String }, optional: true, nullable: false, api_name: "billingPhone"
19
+
20
+ field :billing_state, -> { String }, optional: true, nullable: false, api_name: "billingState"
21
+
22
+ field :billing_zip, -> { String }, optional: true, nullable: false, api_name: "billingZip"
23
+
24
+ field :company, -> { String }, optional: true, nullable: false
25
+
26
+ field :customer_id, -> { Integer }, optional: true, nullable: false, api_name: "customerId"
27
+
28
+ field :customer_number, -> { String }, optional: true, nullable: false, api_name: "customerNumber"
29
+
30
+ field :first_name, -> { String }, optional: true, nullable: false, api_name: "firstName"
31
+
32
+ field :identifier_fields, -> { Internal::Types::Array[String] }, optional: true, nullable: false, api_name: "identifierFields"
33
+
34
+ field :last_name, -> { String }, optional: true, nullable: false, api_name: "lastName"
35
+
36
+ field :shipping_address_1, -> { String }, optional: true, nullable: false, api_name: "shippingAddress1"
37
+
38
+ field :shipping_address_2, -> { String }, optional: true, nullable: false, api_name: "shippingAddress2"
39
+
40
+ field :shipping_city, -> { String }, optional: true, nullable: false, api_name: "shippingCity"
41
+
42
+ field :shipping_country, -> { String }, optional: true, nullable: false, api_name: "shippingCountry"
43
+
44
+ field :shipping_state, -> { String }, optional: true, nullable: false, api_name: "shippingState"
45
+
46
+ field :shipping_zip, -> { String }, optional: true, nullable: false, api_name: "shippingZip"
47
+
6
48
  field :balance, -> { Integer }, optional: true, nullable: false
7
49
 
8
50
  field :created, -> { String }, optional: true, nullable: false
@@ -3,6 +3,10 @@
3
3
  module Payabli
4
4
  module Types
5
5
  class GetPayLinkFromIdResponse < Internal::Types::Model
6
+ field :is_success, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "isSuccess"
7
+
8
+ field :response_text, -> { String }, optional: false, nullable: false, api_name: "responseText"
9
+
6
10
  field :response_data, -> { Payabli::Types::PayabliPages }, optional: true, nullable: false, api_name: "responseData"
7
11
  end
8
12
  end
@@ -13,7 +13,11 @@ module Payabli
13
13
 
14
14
  field :order, -> { Integer }, optional: true, nullable: false
15
15
 
16
+ field :payment_description, -> { String }, optional: true, nullable: false, api_name: "paymentDescription"
17
+
16
18
  field :settings, -> { Payabli::Types::MethodElementSettings }, optional: true, nullable: false
19
+
20
+ field :show_save_method, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "showSaveMethod"
17
21
  end
18
22
  end
19
23
  end
@@ -16,6 +16,12 @@ module Payabli
16
16
  field :mastercard, -> { Internal::Types::Boolean }, optional: true, nullable: false
17
17
 
18
18
  field :visa, -> { Internal::Types::Boolean }, optional: true, nullable: false
19
+
20
+ field :diners, -> { Internal::Types::Boolean }, optional: true, nullable: false
21
+
22
+ field :jcb, -> { Internal::Types::Boolean }, optional: true, nullable: false
23
+
24
+ field :rdc, -> { Internal::Types::Boolean }, optional: true, nullable: false
19
25
  end
20
26
  end
21
27
  end
@@ -4,6 +4,10 @@ module Payabli
4
4
  module Types
5
5
  # Response from approval-modification endpoints.
6
6
  class ModifyApprovalBillResponse < Internal::Types::Model
7
+ field :is_success, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "isSuccess"
8
+
9
+ field :response_text, -> { String }, optional: false, nullable: false, api_name: "responseText"
10
+
7
11
  field :response_data, -> { Integer }, optional: true, nullable: false, api_name: "responseData"
8
12
  end
9
13
  end
@@ -3,6 +3,30 @@
3
3
  module Payabli
4
4
  module Types
5
5
  class NotificationLogDetail < Internal::Types::Model
6
+ field :id, -> { String }, optional: false, nullable: false
7
+
8
+ field :org_id, -> { Integer }, optional: false, nullable: true, api_name: "orgId"
9
+
10
+ field :paypoint_id, -> { Integer }, optional: false, nullable: true, api_name: "paypointId"
11
+
12
+ field :notification_event, -> { String }, optional: false, nullable: true, api_name: "notificationEvent"
13
+
14
+ field :target, -> { String }, optional: false, nullable: true
15
+
16
+ field :response_status, -> { String }, optional: false, nullable: true, api_name: "responseStatus"
17
+
18
+ field :success, -> { Internal::Types::Boolean }, optional: false, nullable: false
19
+
20
+ field :job_data, -> { String }, optional: false, nullable: true, api_name: "jobData"
21
+
22
+ field :created_date, -> { String }, optional: false, nullable: false, api_name: "createdDate"
23
+
24
+ field :success_date, -> { String }, optional: false, nullable: true, api_name: "successDate"
25
+
26
+ field :last_failed_date, -> { String }, optional: false, nullable: true, api_name: "lastFailedDate"
27
+
28
+ field :is_in_progress, -> { Internal::Types::Boolean }, optional: false, nullable: false, api_name: "isInProgress"
29
+
6
30
  field :web_headers, -> { Internal::Types::Array[Payabli::Types::StringStringKeyValuePair] }, optional: true, nullable: false, api_name: "webHeaders"
7
31
 
8
32
  field :response_headers, -> { Internal::Types::Array[Payabli::Types::KeyValueArray] }, optional: true, nullable: false, api_name: "responseHeaders"
@@ -0,0 +1,17 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Payabli
4
+ module Types
5
+ # Successful response from the token endpoint. Returns the access token, its lifetime, and any state echoed from the
6
+ # request.
7
+ class PayabliAccessTokenResponse < Internal::Types::Model
8
+ field :token_type, -> { String }, optional: false, nullable: false
9
+
10
+ field :access_token, -> { String }, optional: false, nullable: false
11
+
12
+ field :expires_in, -> { Integer }, optional: false, nullable: false
13
+
14
+ field :state, -> { String }, optional: true, nullable: false
15
+ end
16
+ end
17
+ end
@@ -12,7 +12,7 @@ module Payabli
12
12
 
13
13
  field :response_code, -> { Integer }, optional: true, nullable: false, api_name: "responseCode"
14
14
 
15
- field :response_data, -> { Payabli::Types::PayabliApiResponse0ResponseData }, optional: true, nullable: false, api_name: "responseData"
15
+ field :response_data, -> { Payabli::Types::CancelPayoutResponseData }, optional: true, nullable: false, api_name: "responseData"
16
16
  end
17
17
  end
18
18
  end
@@ -3,83 +3,103 @@
3
3
  module Payabli
4
4
  module Types
5
5
  class QueryPayoutTransactionRecordsItem < Internal::Types::Model
6
- field :batch_number, -> { String }, optional: true, nullable: false, api_name: "BatchNumber"
7
-
8
- field :batch_id, -> { Integer }, optional: true, nullable: false, api_name: "BatchId"
9
-
10
- field :bills, -> { Internal::Types::Array[Payabli::Types::BillPayOutData] }, optional: true, nullable: false, api_name: "Bills"
6
+ field :id_out, -> { Integer }, optional: true, nullable: false, api_name: "IdOut"
11
7
 
12
- field :card_token, -> { String }, optional: true, nullable: false, api_name: "CardToken"
8
+ field :created_at, -> { String }, optional: true, nullable: false, api_name: "CreatedAt"
13
9
 
14
- field :check_data, -> { Payabli::Types::FileContent }, optional: true, nullable: false, api_name: "CheckData"
10
+ field :comments, -> { String }, optional: true, nullable: false, api_name: "Comments"
15
11
 
16
- field :check_number, -> { String }, optional: true, nullable: false, api_name: "CheckNumber"
12
+ field :vendor, -> { Payabli::Types::VendorQueryRecord }, optional: true, nullable: false, api_name: "Vendor"
17
13
 
18
- field :comments, -> { String }, optional: true, nullable: false, api_name: "Comments"
14
+ field :paypoint_dbaname, -> { String }, optional: true, nullable: false, api_name: "PaypointDbaname"
19
15
 
20
- field :created_at, -> { String }, optional: true, nullable: false, api_name: "CreatedAt"
16
+ field :paypoint_legalname, -> { String }, optional: true, nullable: false, api_name: "PaypointLegalname"
21
17
 
22
- field :entry_name, -> { String }, optional: true, nullable: false, api_name: "EntryName"
18
+ field :paypoint_id, -> { Integer }, optional: true, nullable: false, api_name: "PaypointId"
23
19
 
24
- field :events, -> { Internal::Types::Array[Payabli::Types::QueryTransactionEvents] }, optional: true, nullable: false, api_name: "Events"
20
+ field :status, -> { Integer }, optional: true, nullable: false, api_name: "Status"
25
21
 
26
- field :external_paypoint_id, -> { String }, optional: true, nullable: false, api_name: "externalPaypointID"
22
+ field :payment_id, -> { String }, optional: true, nullable: false, api_name: "PaymentId"
27
23
 
28
- field :fee_amount, -> { Integer }, optional: true, nullable: false, api_name: "FeeAmount"
24
+ field :trans_id, -> { String }, optional: true, nullable: false, api_name: "TransId"
29
25
 
30
- field :gateway, -> { String }, optional: true, nullable: false, api_name: "Gateway"
26
+ field :trans_status, -> { Integer }, optional: true, nullable: false, api_name: "TransStatus"
31
27
 
32
- field :has_vcard_transactions, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "HasVcardTransactions"
28
+ field :trans_status_detail, -> { String }, optional: true, nullable: false, api_name: "TransStatusDetail"
33
29
 
34
- field :id_out, -> { Integer }, optional: true, nullable: false, api_name: "IdOut"
30
+ field :trans_status_name, -> { String }, optional: true, nullable: false, api_name: "TransStatusName"
35
31
 
36
- field :is_same_day_ach, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "IsSameDayACH"
32
+ field :trans_status_category, -> { String }, optional: true, nullable: false, api_name: "TransStatusCategory"
37
33
 
38
34
  field :last_updated, -> { String }, optional: true, nullable: false, api_name: "LastUpdated"
39
35
 
36
+ field :total_amount, -> { Integer }, optional: true, nullable: false, api_name: "TotalAmount"
37
+
40
38
  field :net_amount, -> { Integer }, optional: true, nullable: false, api_name: "NetAmount"
41
39
 
40
+ field :fee_amount, -> { Integer }, optional: true, nullable: false, api_name: "FeeAmount"
41
+
42
+ field :source, -> { String }, optional: true, nullable: false, api_name: "Source"
43
+
42
44
  field :parent_org_name, -> { String }, optional: true, nullable: false, api_name: "ParentOrgName"
43
45
 
44
46
  field :parent_org_id, -> { Integer }, optional: true, nullable: false, api_name: "ParentOrgId"
45
47
 
46
- field :payment_data, -> { Payabli::Types::QueryPayoutTransactionRecordsItemPaymentData }, optional: true, nullable: false, api_name: "PaymentData"
48
+ field :batch_number, -> { String }, optional: true, nullable: false, api_name: "BatchNumber"
47
49
 
48
- field :payment_id, -> { String }, optional: true, nullable: false, api_name: "PaymentId"
50
+ field :payment_status, -> { String }, optional: true, nullable: false, api_name: "PaymentStatus"
49
51
 
50
52
  field :payment_method, -> { String }, optional: true, nullable: false, api_name: "PaymentMethod"
51
53
 
52
- field :payment_status, -> { String }, optional: true, nullable: false, api_name: "PaymentStatus"
54
+ field :card_token, -> { String }, optional: true, nullable: false, api_name: "CardToken"
53
55
 
54
- field :payout_program, -> { String }, optional: true, nullable: false, api_name: "PayoutProgram"
56
+ field :check_number, -> { String }, optional: true, nullable: false, api_name: "CheckNumber"
55
57
 
56
- field :paypoint_dbaname, -> { String }, optional: true, nullable: false, api_name: "PaypointDbaname"
58
+ field :check_data, -> { Payabli::Types::FileContent }, optional: true, nullable: false, api_name: "CheckData"
57
59
 
58
- field :paypoint_legalname, -> { String }, optional: true, nullable: false, api_name: "PaypointLegalname"
60
+ field :payment_data, -> { Payabli::Types::QueryPayoutTransactionRecordsItemPaymentData }, optional: true, nullable: false, api_name: "PaymentData"
59
61
 
60
- field :risk_action, -> { String }, optional: true, nullable: false, api_name: "RiskAction"
62
+ field :bills, -> { Internal::Types::Array[Payabli::Types::BillPayOutData] }, optional: true, nullable: false, api_name: "Bills"
61
63
 
62
- field :risk_action_code, -> { Integer }, optional: true, nullable: false, api_name: "RiskActionCode"
64
+ field :events, -> { Internal::Types::Array[Payabli::Types::QueryTransactionEvents] }, optional: true, nullable: false, api_name: "Events"
63
65
 
64
- field :risk_flagged, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "RiskFlagged"
66
+ field :external_paypoint_id, -> { String }, optional: true, nullable: false, api_name: "externalPaypointID"
65
67
 
66
- field :risk_flagged_on, -> { String }, optional: true, nullable: false, api_name: "RiskFlaggedOn"
68
+ field :entry_name, -> { String }, optional: true, nullable: false, api_name: "EntryName"
67
69
 
68
- field :risk_reason, -> { String }, optional: true, nullable: false, api_name: "RiskReason"
70
+ field :gateway, -> { String }, optional: true, nullable: false, api_name: "Gateway"
69
71
 
70
- field :risk_status, -> { String }, optional: true, nullable: false, api_name: "RiskStatus"
72
+ field :batch_id, -> { Integer }, optional: true, nullable: false, api_name: "BatchId"
73
+
74
+ field :has_vcard_transactions, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "HasVcardTransactions"
75
+
76
+ field :is_same_day_ach, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "IsSameDayACH"
71
77
 
72
78
  field :schedule_id, -> { Integer }, optional: true, nullable: false, api_name: "ScheduleId"
73
79
 
74
80
  field :settlement_status, -> { String }, optional: true, nullable: false, api_name: "SettlementStatus"
75
81
 
76
- field :source, -> { String }, optional: true, nullable: false, api_name: "Source"
82
+ field :settlement_status_name, -> { String }, optional: true, nullable: false, api_name: "SettlementStatusName"
77
83
 
78
- field :status, -> { Integer }, optional: true, nullable: false, api_name: "Status"
84
+ field :settlement_date, -> { String }, optional: true, nullable: false, api_name: "SettlementDate"
79
85
 
80
- field :total_amount, -> { Integer }, optional: true, nullable: false, api_name: "TotalAmount"
86
+ field :risk_flagged, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "RiskFlagged"
81
87
 
82
- field :vendor, -> { Payabli::Types::VendorQueryRecord }, optional: true, nullable: false, api_name: "Vendor"
88
+ field :risk_flagged_on, -> { String }, optional: true, nullable: false, api_name: "RiskFlaggedOn"
89
+
90
+ field :risk_status, -> { String }, optional: true, nullable: false, api_name: "RiskStatus"
91
+
92
+ field :risk_reason, -> { String }, optional: true, nullable: false, api_name: "RiskReason"
93
+
94
+ field :risk_action, -> { String }, optional: true, nullable: false, api_name: "RiskAction"
95
+
96
+ field :risk_action_code, -> { Integer }, optional: true, nullable: false, api_name: "RiskActionCode"
97
+
98
+ field :payout_program, -> { String }, optional: true, nullable: false, api_name: "PayoutProgram"
99
+
100
+ field :ach_trace_number, -> { String }, optional: true, nullable: false, api_name: "AchTraceNumber"
101
+
102
+ field :entity_id, -> { String }, optional: true, nullable: false, api_name: "EntityId"
83
103
  end
84
104
  end
85
105
  end
@@ -3,41 +3,41 @@
3
3
  module Payabli
4
4
  module Types
5
5
  class QueryPayoutTransactionRecordsItemPaymentData < Internal::Types::Model
6
- field :account_exp, -> { String }, optional: true, nullable: false, api_name: "AccountExp"
7
-
8
- field :account_id, -> { String }, optional: true, nullable: false, api_name: "accountId"
6
+ field :masked_account, -> { String }, optional: true, nullable: false, api_name: "MaskedAccount"
9
7
 
10
8
  field :account_type, -> { String }, optional: true, nullable: false, api_name: "AccountType"
11
9
 
12
- field :account_zip, -> { String }, optional: true, nullable: false, api_name: "AccountZip"
10
+ field :account_exp, -> { String }, optional: true, nullable: false, api_name: "AccountExp"
13
11
 
14
- field :bank_account, -> { String }, optional: true, nullable: false, api_name: "bankAccount"
12
+ field :account_zip, -> { String }, optional: true, nullable: false, api_name: "AccountZip"
15
13
 
16
- field :bin_data, -> { Payabli::Types::BinData }, optional: true, nullable: false, api_name: "binData"
14
+ field :holder_name, -> { String }, optional: true, nullable: false, api_name: "HolderName"
17
15
 
18
- field :cloud_signature_data, -> { String }, optional: true, nullable: false, api_name: "cloudSignatureData"
16
+ field :stored_id, -> { String }, optional: true, nullable: false, api_name: "StoredId"
19
17
 
20
- field :cloud_signature_format, -> { String }, optional: true, nullable: false, api_name: "cloudSignatureFormat"
18
+ field :initiator, -> { String }, optional: true, nullable: false, api_name: "Initiator"
21
19
 
22
- field :gateway_connector, -> { Payabli::Types::PayoutGatewayConnector }, optional: true, nullable: false, api_name: "gatewayConnector"
20
+ field :stored_method_usage_type, -> { String }, optional: true, nullable: false, api_name: "StoredMethodUsageType"
23
21
 
24
- field :holder_name, -> { String }, optional: true, nullable: false, api_name: "HolderName"
22
+ field :sequence, -> { String }, optional: true, nullable: false, api_name: "Sequence"
25
23
 
26
- field :initiator, -> { String }, optional: true, nullable: false, api_name: "Initiator"
24
+ field :order_description, -> { String }, optional: true, nullable: false, api_name: "orderDescription"
27
25
 
28
- field :masked_account, -> { String }, optional: true, nullable: false, api_name: "MaskedAccount"
26
+ field :cloud_signature_data, -> { String }, optional: true, nullable: false, api_name: "cloudSignatureData"
29
27
 
30
- field :order_description, -> { String }, optional: true, nullable: false, api_name: "orderDescription"
28
+ field :cloud_signature_format, -> { String }, optional: true, nullable: false, api_name: "cloudSignatureFormat"
31
29
 
32
30
  field :payment_details, -> { Payabli::Types::PaymentDetail }, optional: true, nullable: false, api_name: "paymentDetails"
33
31
 
34
32
  field :payor_data, -> { String }, optional: true, nullable: false, api_name: "payorData"
35
33
 
36
- field :sequence, -> { String }, optional: true, nullable: false, api_name: "Sequence"
34
+ field :account_id, -> { String }, optional: true, nullable: false, api_name: "accountId"
37
35
 
38
- field :stored_id, -> { String }, optional: true, nullable: false, api_name: "StoredId"
36
+ field :bank_account, -> { String }, optional: true, nullable: false, api_name: "bankAccount"
39
37
 
40
- field :stored_method_usage_type, -> { String }, optional: true, nullable: false, api_name: "StoredMethodUsageType"
38
+ field :gateway_connector, -> { Payabli::Types::PayoutGatewayConnector }, optional: true, nullable: false, api_name: "gatewayConnector"
39
+
40
+ field :bin_data, -> { Payabli::Types::BinData }, optional: true, nullable: false, api_name: "binData"
41
41
  end
42
42
  end
43
43
  end