payabli 3.0.6 → 3.0.7

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 (52) hide show
  1. checksums.yaml +4 -4
  2. data/.fern/metadata.json +3 -3
  3. data/lib/payabli/case_management/client.rb +662 -0
  4. data/lib/payabli/case_management/types/assign_case_request.rb +15 -0
  5. data/lib/payabli/case_management/types/create_bank_account_change_case_request.rb +31 -0
  6. data/lib/payabli/case_management/types/list_cases_case_management_request.rb +17 -0
  7. data/lib/payabli/case_management/types/list_messages_case_management_request.rb +15 -0
  8. data/lib/payabli/case_management/types/post_case_message_request.rb +13 -0
  9. data/lib/payabli/case_management/types/transition_case_request.rb +17 -0
  10. data/lib/payabli/case_management/types/upload_attachment_case_management_request.rb +11 -0
  11. data/lib/payabli/case_management/types/validate_bank_account_change_request.rb +23 -0
  12. data/lib/payabli/client.rb +6 -1
  13. data/lib/payabli/money_out/client.rb +17 -3
  14. data/lib/payabli/money_out/types/capture_all_out_request.rb +2 -0
  15. data/lib/payabli/money_out/types/capture_out_request.rb +2 -0
  16. data/lib/payabli/money_out/types/request_out_authorize.rb +2 -0
  17. data/lib/payabli/notification/client.rb +2 -2
  18. data/lib/payabli/types/attachment_response.rb +24 -0
  19. data/lib/payabli/types/available_transitions_response.rb +10 -0
  20. data/lib/payabli/types/bank_account_change_parameters.rb +30 -0
  21. data/lib/payabli/types/bank_account_change_parameters_type.rb +11 -0
  22. data/lib/payabli/types/bank_account_services.rb +12 -0
  23. data/lib/payabli/types/bank_review_decision_reason.rb +14 -0
  24. data/lib/payabli/types/bank_verification_metadata.rb +14 -0
  25. data/lib/payabli/types/case_list_response.rb +12 -0
  26. data/lib/payabli/types/case_list_summary.rb +20 -0
  27. data/lib/payabli/types/case_management_bank_account_function.rb +17 -0
  28. data/lib/payabli/types/case_metadata.rb +12 -0
  29. data/lib/payabli/types/case_response.rb +50 -0
  30. data/lib/payabli/types/case_state.rb +22 -0
  31. data/lib/payabli/types/case_trigger.rb +22 -0
  32. data/lib/payabli/types/case_type.rb +11 -0
  33. data/lib/payabli/types/message_page.rb +12 -0
  34. data/lib/payabli/types/money_in_service.rb +17 -0
  35. data/lib/payabli/types/money_out_service.rb +17 -0
  36. data/lib/payabli/types/notification_content.rb +1 -1
  37. data/lib/payabli/types/notification_content_event_type.rb +14 -80
  38. data/lib/payabli/types/notification_standard_request_content_event_type.rb +97 -111
  39. data/lib/payabli/types/org_ref.rb +12 -0
  40. data/lib/payabli/types/paypoint_ref.rb +12 -0
  41. data/lib/payabli/types/posted_message.rb +14 -0
  42. data/lib/payabli/types/pre_creation_validation_result.rb +16 -0
  43. data/lib/payabli/types/review_decision_metadata.rb +12 -0
  44. data/lib/payabli/types/room_message_view.rb +18 -0
  45. data/lib/payabli/types/state_transition_response.rb +26 -0
  46. data/lib/payabli/types/user_ref.rb +12 -0
  47. data/lib/payabli/types/verification_code.rb +14 -0
  48. data/lib/payabli/version.rb +1 -1
  49. data/lib/payabli.rb +36 -0
  50. data/reference.md +1182 -4
  51. data/wiremock/wiremock-mappings.json +418 -1
  52. metadata +38 -2
data/reference.md CHANGED
@@ -24070,7 +24070,7 @@ Create a new notification or auto-generated report.
24070
24070
  ```ruby
24071
24071
  client.notification.add_notification(
24072
24072
  content: {
24073
- event_type: "CreatedApplication"
24073
+ event_type: "createdapplication"
24074
24074
  },
24075
24075
  frequency: "untilcancelled",
24076
24076
  method_: "web",
@@ -24205,7 +24205,7 @@ Update a notification or auto-generated report.
24205
24205
  client.notification.update_notification(
24206
24206
  n_id: "1717",
24207
24207
  content: {
24208
- event_type: "ApprovedPayment"
24208
+ event_type: "approvedpayment"
24209
24209
  },
24210
24210
  frequency: "untilcancelled",
24211
24211
  method_: "email",
@@ -26185,7 +26185,7 @@ Authorizes a transaction for payout.
26185
26185
 
26186
26186
  If you don't pass `autoCapture` with a value of `true`, authorized transactions aren't flagged for settlement until captured. Use the `referenceId` returned in the response to capture the transaction.
26187
26187
 
26188
- When `autoCapture` is `true`, Payabli captures the transaction asynchronously after authorization. The response confirms only that the transaction was authorized; it doesn't confirm that capture succeeded. To confirm capture, listen for the [`payout_transaction_approvedcaptured`](/developers/api-reference/webhooks-overview/payout-transaction-approved-captured) webhook event.
26188
+ When `autoCapture` is `true`, Payabli captures the transaction asynchronously after authorization. The response confirms only that the transaction was authorized; it doesn't confirm that capture succeeded. To confirm capture, listen for the [`payout_transaction_approvedcaptured`](/developers/webhooks/payout-transaction-approved-captured) webhook event.
26189
26189
 
26190
26190
  If a velocity fraud alert is triggered, the endpoint returns a `202` response with `responseCode` `9051`, and the authorization is held for risk review rather than rejected. If a risk policy blocks the transaction, the endpoint returns a `422` response with `responseCode` `9005`, a terminal rejection.
26191
26191
 
@@ -26260,6 +26260,18 @@ client.money_out.authorize_out(
26260
26260
  <dl>
26261
26261
  <dd>
26262
26262
 
26263
+ **same_day_ach:** `Internal::Types::Boolean`
26264
+
26265
+ When `true`, Payabli authorizes the payout for same-day ACH processing instead of standard ACH. Same-day ACH must be enabled for the paypoint, otherwise the authorization fails with a `400` response and `responseCode` `3492`. Only ACH payouts honor this flag. Wire and RTP payouts ignore it.
26266
+
26267
+ Same-day ACH has a daily cutoff. Capture the transaction before the cutoff, or pass `autoConvertSameDayAch` with a value of `true` when you capture it.
26268
+
26269
+ </dd>
26270
+ </dl>
26271
+
26272
+ <dl>
26273
+ <dd>
26274
+
26263
26275
  **idempotency_key:** `String` — _Optional but recommended_ A unique ID that you can include to prevent duplicating objects or transactions in the case that a request is sent more than once. This key isn't generated in Payabli, you must generate it yourself. This key persists for 2 minutes. After 2 minutes, you can reuse the key if needed.
26264
26276
 
26265
26277
  </dd>
@@ -26604,6 +26616,18 @@ client.money_out.capture_all_out(body: %w[2-29 2-28 2-27])
26604
26616
  <dl>
26605
26617
  <dd>
26606
26618
 
26619
+ **auto_convert_same_day_ach:** `Internal::Types::Boolean`
26620
+
26621
+ Controls what happens to a payout authorized with `sameDayACH` set to `true` when you capture it after the same-day ACH cutoff. When `true`, Payabli converts the payout to a standard ACH payment and captures it. When `false`, the capture is declined.
26622
+
26623
+ This parameter has no effect on payouts that weren't authorized for same-day ACH.
26624
+
26625
+ </dd>
26626
+ </dl>
26627
+
26628
+ <dl>
26629
+ <dd>
26630
+
26607
26631
  **idempotency_key:** `String` — _Optional but recommended_ A unique ID that you can include to prevent duplicating objects or transactions in the case that a request is sent more than once. This key isn't generated in Payabli, you must generate it yourself. This key persists for 2 minutes. After 2 minutes, you can reuse the key if needed.
26608
26632
 
26609
26633
  </dd>
@@ -26684,6 +26708,18 @@ client.money_out.capture_out(reference_id: "129-219")
26684
26708
  <dl>
26685
26709
  <dd>
26686
26710
 
26711
+ **auto_convert_same_day_ach:** `Internal::Types::Boolean`
26712
+
26713
+ Controls what happens to a payout authorized with `sameDayACH` set to `true` when you capture it after the same-day ACH cutoff. When `true`, Payabli converts the payout to a standard ACH payment and captures it. When `false`, the capture is declined.
26714
+
26715
+ This parameter has no effect on payouts that weren't authorized for same-day ACH.
26716
+
26717
+ </dd>
26718
+ </dl>
26719
+
26720
+ <dl>
26721
+ <dd>
26722
+
26687
26723
  **idempotency_key:** `String` — _Optional but recommended_ A unique ID that you can include to prevent duplicating objects or transactions in the case that a request is sent more than once. This key isn't generated in Payabli, you must generate it yourself. This key persists for 2 minutes. After 2 minutes, you can reuse the key if needed.
26688
26724
 
26689
26725
  </dd>
@@ -28168,7 +28204,7 @@ client.charge_backs.get_chargeback(id: 1000000)
28168
28204
  <dl>
28169
28205
  <dd>
28170
28206
 
28171
- **id:** `Integer` — ID of the chargeback or return record. This is returned as `chargebackID` in the [ReceivedChargeBack](/guides/pay-ops-webhooks-payloads#receivedchargeback) and [ReceivedAchReturn](/guides/pay-ops-webhooks-payloads#receivedachreturn) webhook notifications.
28207
+ **id:** `Integer` — ID of the chargeback or return record. This is returned as `chargebackID` in the [ReceivedChargeBack](/developers/webhooks/payops-chargeback-received) and [ReceivedAchReturn](/developers/webhooks/payops-ach-return-received) webhook notifications.
28172
28208
 
28173
28209
  </dd>
28174
28210
  </dl>
@@ -28261,3 +28297,1145 @@ client.charge_backs.get_chargeback_attachment(
28261
28297
  </dl>
28262
28298
  </details>
28263
28299
 
28300
+ ## Case Management
28301
+ <details><summary><code>client.case_management.<a href="/lib/payabli/case_management/client.rb">validate_bank_account_change</a>(paypoint_id:, request) -> Payabli::Types::PreCreationValidationResult</code></summary>
28302
+ <dl>
28303
+ <dd>
28304
+
28305
+ #### 📝 Description
28306
+
28307
+ <dl>
28308
+ <dd>
28309
+
28310
+ <dl>
28311
+ <dd>
28312
+
28313
+ Validates a bank account change for a paypoint without creating a case.
28314
+ Runs the same checks the create endpoint runs, and returns blocking
28315
+ conditions and warnings. Blocking conditions prevent creation; warnings
28316
+ don't.
28317
+
28318
+ Available to both Platform and Enterprise Partners.
28319
+ </dd>
28320
+ </dl>
28321
+ </dd>
28322
+ </dl>
28323
+
28324
+ #### 🔌 Usage
28325
+
28326
+ <dl>
28327
+ <dd>
28328
+
28329
+ <dl>
28330
+ <dd>
28331
+
28332
+ ```ruby
28333
+ client.case_management.validate_bank_account_change(
28334
+ paypoint_id: 3040,
28335
+ routing_number: "123456789",
28336
+ account_number: "987654321",
28337
+ account_type: "checking",
28338
+ bank_account_holder_type: "business",
28339
+ bank_account_function: "Deposits",
28340
+ services: {
28341
+ money_in: ["Ach"],
28342
+ money_out: ["Ach"]
28343
+ }
28344
+ )
28345
+ ```
28346
+ </dd>
28347
+ </dl>
28348
+ </dd>
28349
+ </dl>
28350
+
28351
+ #### ⚙️ Parameters
28352
+
28353
+ <dl>
28354
+ <dd>
28355
+
28356
+ <dl>
28357
+ <dd>
28358
+
28359
+ **paypoint_id:** `Integer` — The paypoint's numeric identifier.
28360
+
28361
+ </dd>
28362
+ </dl>
28363
+
28364
+ <dl>
28365
+ <dd>
28366
+
28367
+ **routing_number:** `String` — The 9-digit bank routing number.
28368
+
28369
+ </dd>
28370
+ </dl>
28371
+
28372
+ <dl>
28373
+ <dd>
28374
+
28375
+ **account_number:** `String` — The bank account number (4 to 17 digits).
28376
+
28377
+ </dd>
28378
+ </dl>
28379
+
28380
+ <dl>
28381
+ <dd>
28382
+
28383
+ **account_type:** `String` — The account type. Must be `checking` or `savings`.
28384
+
28385
+ </dd>
28386
+ </dl>
28387
+
28388
+ <dl>
28389
+ <dd>
28390
+
28391
+ **bank_account_holder_type:** `String` — The account holder type. Must be `personal` or `business`.
28392
+
28393
+ </dd>
28394
+ </dl>
28395
+
28396
+ <dl>
28397
+ <dd>
28398
+
28399
+ **bank_account_function:** `Payabli::Types::CaseManagementBankAccountFunction`
28400
+
28401
+ </dd>
28402
+ </dl>
28403
+
28404
+ <dl>
28405
+ <dd>
28406
+
28407
+ **services:** `Payabli::Types::BankAccountServices`
28408
+
28409
+ </dd>
28410
+ </dl>
28411
+
28412
+ <dl>
28413
+ <dd>
28414
+
28415
+ **request_options:** `Payabli::CaseManagement::RequestOptions`
28416
+
28417
+ </dd>
28418
+ </dl>
28419
+ </dd>
28420
+ </dl>
28421
+
28422
+
28423
+ </dd>
28424
+ </dl>
28425
+ </details>
28426
+
28427
+ <details><summary><code>client.case_management.<a href="/lib/payabli/case_management/client.rb">create_bank_account_change</a>(paypoint_id:, request) -> Payabli::Types::CaseResponse</code></summary>
28428
+ <dl>
28429
+ <dd>
28430
+
28431
+ #### 📝 Description
28432
+
28433
+ <dl>
28434
+ <dd>
28435
+
28436
+ <dl>
28437
+ <dd>
28438
+
28439
+ Creates a bank-account-change case for a paypoint. The account and
28440
+ routing numbers are validated and tokenized before the case is saved —
28441
+ the raw numbers are never stored or returned. The account holder name is
28442
+ taken from the paypoint's legal name. On success the case is created in
28443
+ `Submitted` and asynchronous verification starts.
28444
+
28445
+ Available to both Platform and Enterprise Partners.
28446
+ </dd>
28447
+ </dl>
28448
+ </dd>
28449
+ </dl>
28450
+
28451
+ #### 🔌 Usage
28452
+
28453
+ <dl>
28454
+ <dd>
28455
+
28456
+ <dl>
28457
+ <dd>
28458
+
28459
+ ```ruby
28460
+ client.case_management.create_bank_account_change(
28461
+ paypoint_id: 3040,
28462
+ nickname: "Main Settlement Account",
28463
+ bank_name: "First National Bank",
28464
+ routing_number: "123456789",
28465
+ account_number: "987654321",
28466
+ account_type: "checking",
28467
+ bank_account_holder_type: "business",
28468
+ bank_account_function: "Deposits",
28469
+ services: {
28470
+ money_in: ["Ach"],
28471
+ money_out: ["Ach"]
28472
+ },
28473
+ default: true
28474
+ )
28475
+ ```
28476
+ </dd>
28477
+ </dl>
28478
+ </dd>
28479
+ </dl>
28480
+
28481
+ #### ⚙️ Parameters
28482
+
28483
+ <dl>
28484
+ <dd>
28485
+
28486
+ <dl>
28487
+ <dd>
28488
+
28489
+ **paypoint_id:** `Integer` — The paypoint's numeric identifier.
28490
+
28491
+ </dd>
28492
+ </dl>
28493
+
28494
+ <dl>
28495
+ <dd>
28496
+
28497
+ **nickname:** `String` — A label for the account.
28498
+
28499
+ </dd>
28500
+ </dl>
28501
+
28502
+ <dl>
28503
+ <dd>
28504
+
28505
+ **bank_name:** `String` — The name of the bank.
28506
+
28507
+ </dd>
28508
+ </dl>
28509
+
28510
+ <dl>
28511
+ <dd>
28512
+
28513
+ **routing_number:** `String` — The 9-digit bank routing number.
28514
+
28515
+ </dd>
28516
+ </dl>
28517
+
28518
+ <dl>
28519
+ <dd>
28520
+
28521
+ **account_number:** `String` — The bank account number (4 to 17 digits).
28522
+
28523
+ </dd>
28524
+ </dl>
28525
+
28526
+ <dl>
28527
+ <dd>
28528
+
28529
+ **account_type:** `String` — The account type. Must be `checking` or `savings`.
28530
+
28531
+ </dd>
28532
+ </dl>
28533
+
28534
+ <dl>
28535
+ <dd>
28536
+
28537
+ **bank_account_holder_type:** `String` — The account holder type. Must be `personal` or `business`.
28538
+
28539
+ </dd>
28540
+ </dl>
28541
+
28542
+ <dl>
28543
+ <dd>
28544
+
28545
+ **bank_account_function:** `Payabli::Types::CaseManagementBankAccountFunction`
28546
+
28547
+ </dd>
28548
+ </dl>
28549
+
28550
+ <dl>
28551
+ <dd>
28552
+
28553
+ **services:** `Payabli::Types::BankAccountServices`
28554
+
28555
+ </dd>
28556
+ </dl>
28557
+
28558
+ <dl>
28559
+ <dd>
28560
+
28561
+ **default:** `Internal::Types::Boolean` — Whether this is the default account for the selected services.
28562
+
28563
+ </dd>
28564
+ </dl>
28565
+
28566
+ <dl>
28567
+ <dd>
28568
+
28569
+ **schedule_for:** `String`
28570
+
28571
+ When to run the change, as a UTC timestamp (trailing `Z`). Must be at
28572
+ least 1 hour and at most 30 days in the future. Omit to run as soon as
28573
+ the case is approved.
28574
+
28575
+ </dd>
28576
+ </dl>
28577
+
28578
+ <dl>
28579
+ <dd>
28580
+
28581
+ **request_options:** `Payabli::CaseManagement::RequestOptions`
28582
+
28583
+ </dd>
28584
+ </dl>
28585
+ </dd>
28586
+ </dl>
28587
+
28588
+
28589
+ </dd>
28590
+ </dl>
28591
+ </details>
28592
+
28593
+ <details><summary><code>client.case_management.<a href="/lib/payabli/case_management/client.rb">get_case</a>(uuid:) -> Payabli::Types::CaseResponse</code></summary>
28594
+ <dl>
28595
+ <dd>
28596
+
28597
+ #### 📝 Description
28598
+
28599
+ <dl>
28600
+ <dd>
28601
+
28602
+ <dl>
28603
+ <dd>
28604
+
28605
+ Returns a case by its UUID, including its current state, parameters,
28606
+ state history, verification metadata, and attachments.
28607
+
28608
+ Available to both Platform and Enterprise Partners.
28609
+ </dd>
28610
+ </dl>
28611
+ </dd>
28612
+ </dl>
28613
+
28614
+ #### 🔌 Usage
28615
+
28616
+ <dl>
28617
+ <dd>
28618
+
28619
+ <dl>
28620
+ <dd>
28621
+
28622
+ ```ruby
28623
+ client.case_management.get_case(uuid: "9c2b7e14-3a5f-4d21-b8e0-1f6a4c9d2e70")
28624
+ ```
28625
+ </dd>
28626
+ </dl>
28627
+ </dd>
28628
+ </dl>
28629
+
28630
+ #### ⚙️ Parameters
28631
+
28632
+ <dl>
28633
+ <dd>
28634
+
28635
+ <dl>
28636
+ <dd>
28637
+
28638
+ **uuid:** `String` — The case's UUID.
28639
+
28640
+ </dd>
28641
+ </dl>
28642
+
28643
+ <dl>
28644
+ <dd>
28645
+
28646
+ **request_options:** `Payabli::CaseManagement::RequestOptions`
28647
+
28648
+ </dd>
28649
+ </dl>
28650
+ </dd>
28651
+ </dl>
28652
+
28653
+
28654
+ </dd>
28655
+ </dl>
28656
+ </details>
28657
+
28658
+ <details><summary><code>client.case_management.<a href="/lib/payabli/case_management/client.rb">list_cases</a>(organization_id:) -> Payabli::Types::CaseListResponse</code></summary>
28659
+ <dl>
28660
+ <dd>
28661
+
28662
+ #### 📝 Description
28663
+
28664
+ <dl>
28665
+ <dd>
28666
+
28667
+ <dl>
28668
+ <dd>
28669
+
28670
+ Lists cases for an organization, climbing the platform org hierarchy.
28671
+ Supports pagination and sorting through query parameters, and filtering
28672
+ through repeatable `parameters[field(op)]=value` query parameters (for
28673
+ example `parameters[state(in)]=Assigned|PendingReview`). Filterable
28674
+ fields include `state`, `caseType`, `paypointId`, `createdAt`,
28675
+ `updatedAt`, `scheduleFor`, and `createdBy`.
28676
+
28677
+ Available to both Platform and Enterprise Partners.
28678
+ </dd>
28679
+ </dl>
28680
+ </dd>
28681
+ </dl>
28682
+
28683
+ #### 🔌 Usage
28684
+
28685
+ <dl>
28686
+ <dd>
28687
+
28688
+ <dl>
28689
+ <dd>
28690
+
28691
+ ```ruby
28692
+ client.case_management.list_cases(
28693
+ organization_id: 123,
28694
+ from_record: 0,
28695
+ limit_record: 20
28696
+ )
28697
+ ```
28698
+ </dd>
28699
+ </dl>
28700
+ </dd>
28701
+ </dl>
28702
+
28703
+ #### ⚙️ Parameters
28704
+
28705
+ <dl>
28706
+ <dd>
28707
+
28708
+ <dl>
28709
+ <dd>
28710
+
28711
+ **organization_id:** `Integer` — The organization's numeric identifier.
28712
+
28713
+ </dd>
28714
+ </dl>
28715
+
28716
+ <dl>
28717
+ <dd>
28718
+
28719
+ **from_record:** `Integer` — The zero-based index of the first record to return.
28720
+
28721
+ </dd>
28722
+ </dl>
28723
+
28724
+ <dl>
28725
+ <dd>
28726
+
28727
+ **limit_record:** `Integer` — The maximum number of records to return (1 to 200).
28728
+
28729
+ </dd>
28730
+ </dl>
28731
+
28732
+ <dl>
28733
+ <dd>
28734
+
28735
+ **sort_by:** `String` — Sort expression, such as `desc(createdAt)` or `asc(state)`. Defaults to `desc(createdAt)`.
28736
+
28737
+ </dd>
28738
+ </dl>
28739
+
28740
+ <dl>
28741
+ <dd>
28742
+
28743
+ **request_options:** `Payabli::CaseManagement::RequestOptions`
28744
+
28745
+ </dd>
28746
+ </dl>
28747
+ </dd>
28748
+ </dl>
28749
+
28750
+
28751
+ </dd>
28752
+ </dl>
28753
+ </details>
28754
+
28755
+ <details><summary><code>client.case_management.<a href="/lib/payabli/case_management/client.rb">list_messages</a>(case_uuid:) -> Payabli::Types::MessagePage</code></summary>
28756
+ <dl>
28757
+ <dd>
28758
+
28759
+ #### 📝 Description
28760
+
28761
+ <dl>
28762
+ <dd>
28763
+
28764
+ <dl>
28765
+ <dd>
28766
+
28767
+ Lists the notes on a case, ordered oldest to newest. Cursor-paginated.
28768
+
28769
+ Available to both Platform and Enterprise Partners.
28770
+ </dd>
28771
+ </dl>
28772
+ </dd>
28773
+ </dl>
28774
+
28775
+ #### 🔌 Usage
28776
+
28777
+ <dl>
28778
+ <dd>
28779
+
28780
+ <dl>
28781
+ <dd>
28782
+
28783
+ ```ruby
28784
+ client.case_management.list_messages(case_uuid: "9c2b7e14-3a5f-4d21-b8e0-1f6a4c9d2e70")
28785
+ ```
28786
+ </dd>
28787
+ </dl>
28788
+ </dd>
28789
+ </dl>
28790
+
28791
+ #### ⚙️ Parameters
28792
+
28793
+ <dl>
28794
+ <dd>
28795
+
28796
+ <dl>
28797
+ <dd>
28798
+
28799
+ **case_uuid:** `String` — The case's UUID.
28800
+
28801
+ </dd>
28802
+ </dl>
28803
+
28804
+ <dl>
28805
+ <dd>
28806
+
28807
+ **limit:** `Integer` — The maximum number of notes to return (default 50, max 200).
28808
+
28809
+ </dd>
28810
+ </dl>
28811
+
28812
+ <dl>
28813
+ <dd>
28814
+
28815
+ **cursor:** `String` — An opaque cursor for the next page.
28816
+
28817
+ </dd>
28818
+ </dl>
28819
+
28820
+ <dl>
28821
+ <dd>
28822
+
28823
+ **request_options:** `Payabli::CaseManagement::RequestOptions`
28824
+
28825
+ </dd>
28826
+ </dl>
28827
+ </dd>
28828
+ </dl>
28829
+
28830
+
28831
+ </dd>
28832
+ </dl>
28833
+ </details>
28834
+
28835
+ <details><summary><code>client.case_management.<a href="/lib/payabli/case_management/client.rb">post_message</a>(case_uuid:, request) -> Payabli::Types::PostedMessage</code></summary>
28836
+ <dl>
28837
+ <dd>
28838
+
28839
+ #### 📝 Description
28840
+
28841
+ <dl>
28842
+ <dd>
28843
+
28844
+ <dl>
28845
+ <dd>
28846
+
28847
+ Adds a note to a case.
28848
+
28849
+ Available to both Platform and Enterprise Partners.
28850
+
28851
+ This endpoint is in development and not yet available for API use. To
28852
+ add a note for now, use Case Management in the
28853
+ [Payabli Portal](/guides/pay-ops-portal-bank-account-changes-manage).
28854
+ To read existing notes on a case, use
28855
+ [List case notes](/developers/api-reference/caseManagement/list-case-notes).
28856
+ </dd>
28857
+ </dl>
28858
+ </dd>
28859
+ </dl>
28860
+
28861
+ #### 🔌 Usage
28862
+
28863
+ <dl>
28864
+ <dd>
28865
+
28866
+ <dl>
28867
+ <dd>
28868
+
28869
+ ```ruby
28870
+ client.case_management.post_message(
28871
+ case_uuid: "9c2b7e14-3a5f-4d21-b8e0-1f6a4c9d2e70",
28872
+ content: "Reviewed supporting documents; account ownership confirmed."
28873
+ )
28874
+ ```
28875
+ </dd>
28876
+ </dl>
28877
+ </dd>
28878
+ </dl>
28879
+
28880
+ #### ⚙️ Parameters
28881
+
28882
+ <dl>
28883
+ <dd>
28884
+
28885
+ <dl>
28886
+ <dd>
28887
+
28888
+ **case_uuid:** `String` — The case's UUID.
28889
+
28890
+ </dd>
28891
+ </dl>
28892
+
28893
+ <dl>
28894
+ <dd>
28895
+
28896
+ **content:** `String` — The note text (1 to 4000 characters).
28897
+
28898
+ </dd>
28899
+ </dl>
28900
+
28901
+ <dl>
28902
+ <dd>
28903
+
28904
+ **request_options:** `Payabli::CaseManagement::RequestOptions`
28905
+
28906
+ </dd>
28907
+ </dl>
28908
+ </dd>
28909
+ </dl>
28910
+
28911
+
28912
+ </dd>
28913
+ </dl>
28914
+ </details>
28915
+
28916
+ <details><summary><code>client.case_management.<a href="/lib/payabli/case_management/client.rb">list_transitions</a>(uuid:) -> Payabli::Types::AvailableTransitionsResponse</code></summary>
28917
+ <dl>
28918
+ <dd>
28919
+
28920
+ #### 📝 Description
28921
+
28922
+ <dl>
28923
+ <dd>
28924
+
28925
+ <dl>
28926
+ <dd>
28927
+
28928
+ Lists the review actions currently available on a case. The list is
28929
+ empty when no user action is available (for example while the case is
28930
+ mid-automation).
28931
+
28932
+ Available to both Platform and Enterprise Partners, though only
28933
+ Enterprise Partners can fire the returned actions.
28934
+ </dd>
28935
+ </dl>
28936
+ </dd>
28937
+ </dl>
28938
+
28939
+ #### 🔌 Usage
28940
+
28941
+ <dl>
28942
+ <dd>
28943
+
28944
+ <dl>
28945
+ <dd>
28946
+
28947
+ ```ruby
28948
+ client.case_management.list_transitions(uuid: "9c2b7e14-3a5f-4d21-b8e0-1f6a4c9d2e70")
28949
+ ```
28950
+ </dd>
28951
+ </dl>
28952
+ </dd>
28953
+ </dl>
28954
+
28955
+ #### ⚙️ Parameters
28956
+
28957
+ <dl>
28958
+ <dd>
28959
+
28960
+ <dl>
28961
+ <dd>
28962
+
28963
+ **uuid:** `String` — The case's UUID.
28964
+
28965
+ </dd>
28966
+ </dl>
28967
+
28968
+ <dl>
28969
+ <dd>
28970
+
28971
+ **request_options:** `Payabli::CaseManagement::RequestOptions`
28972
+
28973
+ </dd>
28974
+ </dl>
28975
+ </dd>
28976
+ </dl>
28977
+
28978
+
28979
+ </dd>
28980
+ </dl>
28981
+ </details>
28982
+
28983
+ <details><summary><code>client.case_management.<a href="/lib/payabli/case_management/client.rb">transition</a>(uuid:, request) -> Payabli::Types::CaseResponse</code></summary>
28984
+ <dl>
28985
+ <dd>
28986
+
28987
+ #### 📝 Description
28988
+
28989
+ <dl>
28990
+ <dd>
28991
+
28992
+ <dl>
28993
+ <dd>
28994
+
28995
+ Fires a review action on a case, such as `Approve`, `Deny`, `Escalate`,
28996
+ or `RequestReview`. Assigning a case uses the dedicated assign endpoint,
28997
+ not this one. Firing an action that isn't valid for the case's current
28998
+ state returns `409`.
28999
+
29000
+ Available to Enterprise Partners only.
29001
+ </dd>
29002
+ </dl>
29003
+ </dd>
29004
+ </dl>
29005
+
29006
+ #### 🔌 Usage
29007
+
29008
+ <dl>
29009
+ <dd>
29010
+
29011
+ <dl>
29012
+ <dd>
29013
+
29014
+ ```ruby
29015
+ client.case_management.transition(
29016
+ uuid: "9c2b7e14-3a5f-4d21-b8e0-1f6a4c9d2e70",
29017
+ trigger: "Approve",
29018
+ reason: "Account ownership confirmed with the merchant by phone."
29019
+ )
29020
+ ```
29021
+ </dd>
29022
+ </dl>
29023
+ </dd>
29024
+ </dl>
29025
+
29026
+ #### ⚙️ Parameters
29027
+
29028
+ <dl>
29029
+ <dd>
29030
+
29031
+ <dl>
29032
+ <dd>
29033
+
29034
+ **uuid:** `String` — The case's UUID.
29035
+
29036
+ </dd>
29037
+ </dl>
29038
+
29039
+ <dl>
29040
+ <dd>
29041
+
29042
+ **trigger:** `Payabli::Types::CaseTrigger`
29043
+
29044
+ </dd>
29045
+ </dl>
29046
+
29047
+ <dl>
29048
+ <dd>
29049
+
29050
+ **reason:** `String` — The reason for the action.
29051
+
29052
+ </dd>
29053
+ </dl>
29054
+
29055
+ <dl>
29056
+ <dd>
29057
+
29058
+ **decline_reason:** `Payabli::Types::BankReviewDecisionReason` — The decline reason. Required when the trigger is `Deny`, and must be omitted otherwise.
29059
+
29060
+ </dd>
29061
+ </dl>
29062
+
29063
+ <dl>
29064
+ <dd>
29065
+
29066
+ **request_options:** `Payabli::CaseManagement::RequestOptions`
29067
+
29068
+ </dd>
29069
+ </dl>
29070
+ </dd>
29071
+ </dl>
29072
+
29073
+
29074
+ </dd>
29075
+ </dl>
29076
+ </details>
29077
+
29078
+ <details><summary><code>client.case_management.<a href="/lib/payabli/case_management/client.rb">assign_case</a>(uuid:, request) -> Payabli::Types::CaseResponse</code></summary>
29079
+ <dl>
29080
+ <dd>
29081
+
29082
+ #### 📝 Description
29083
+
29084
+ <dl>
29085
+ <dd>
29086
+
29087
+ <dl>
29088
+ <dd>
29089
+
29090
+ Assigns a case to a reviewer.
29091
+
29092
+ Available to Enterprise Partners only.
29093
+ </dd>
29094
+ </dl>
29095
+ </dd>
29096
+ </dl>
29097
+
29098
+ #### 🔌 Usage
29099
+
29100
+ <dl>
29101
+ <dd>
29102
+
29103
+ <dl>
29104
+ <dd>
29105
+
29106
+ ```ruby
29107
+ client.case_management.assign_case(
29108
+ uuid: "9c2b7e14-3a5f-4d21-b8e0-1f6a4c9d2e70",
29109
+ assignee_id: 4238,
29110
+ reason: "Routing to the risk team for review."
29111
+ )
29112
+ ```
29113
+ </dd>
29114
+ </dl>
29115
+ </dd>
29116
+ </dl>
29117
+
29118
+ #### ⚙️ Parameters
29119
+
29120
+ <dl>
29121
+ <dd>
29122
+
29123
+ <dl>
29124
+ <dd>
29125
+
29126
+ **uuid:** `String` — The case's UUID.
29127
+
29128
+ </dd>
29129
+ </dl>
29130
+
29131
+ <dl>
29132
+ <dd>
29133
+
29134
+ **assignee_id:** `Integer` — The numeric id of the reviewer to assign the case to.
29135
+
29136
+ </dd>
29137
+ </dl>
29138
+
29139
+ <dl>
29140
+ <dd>
29141
+
29142
+ **reason:** `String` — An optional reason for the assignment.
29143
+
29144
+ </dd>
29145
+ </dl>
29146
+
29147
+ <dl>
29148
+ <dd>
29149
+
29150
+ **request_options:** `Payabli::CaseManagement::RequestOptions`
29151
+
29152
+ </dd>
29153
+ </dl>
29154
+ </dd>
29155
+ </dl>
29156
+
29157
+
29158
+ </dd>
29159
+ </dl>
29160
+ </details>
29161
+
29162
+ <details><summary><code>client.case_management.<a href="/lib/payabli/case_management/client.rb">list_attachments</a>(case_uuid:) -> Internal::Types::Array[Payabli::Types::AttachmentResponse]</code></summary>
29163
+ <dl>
29164
+ <dd>
29165
+
29166
+ #### 📝 Description
29167
+
29168
+ <dl>
29169
+ <dd>
29170
+
29171
+ <dl>
29172
+ <dd>
29173
+
29174
+ Lists the files attached to a case.
29175
+
29176
+ Available to both Platform and Enterprise Partners.
29177
+ </dd>
29178
+ </dl>
29179
+ </dd>
29180
+ </dl>
29181
+
29182
+ #### 🔌 Usage
29183
+
29184
+ <dl>
29185
+ <dd>
29186
+
29187
+ <dl>
29188
+ <dd>
29189
+
29190
+ ```ruby
29191
+ client.case_management.list_attachments(case_uuid: "9c2b7e14-3a5f-4d21-b8e0-1f6a4c9d2e70")
29192
+ ```
29193
+ </dd>
29194
+ </dl>
29195
+ </dd>
29196
+ </dl>
29197
+
29198
+ #### ⚙️ Parameters
29199
+
29200
+ <dl>
29201
+ <dd>
29202
+
29203
+ <dl>
29204
+ <dd>
29205
+
29206
+ **case_uuid:** `String` — The case's UUID.
29207
+
29208
+ </dd>
29209
+ </dl>
29210
+
29211
+ <dl>
29212
+ <dd>
29213
+
29214
+ **request_options:** `Payabli::CaseManagement::RequestOptions`
29215
+
29216
+ </dd>
29217
+ </dl>
29218
+ </dd>
29219
+ </dl>
29220
+
29221
+
29222
+ </dd>
29223
+ </dl>
29224
+ </details>
29225
+
29226
+ <details><summary><code>client.case_management.<a href="/lib/payabli/case_management/client.rb">upload_attachment</a>(case_uuid:, request) -> Payabli::Types::AttachmentResponse</code></summary>
29227
+ <dl>
29228
+ <dd>
29229
+
29230
+ #### 📝 Description
29231
+
29232
+ <dl>
29233
+ <dd>
29234
+
29235
+ <dl>
29236
+ <dd>
29237
+
29238
+ Uploads a file to a case as multipart form data. The maximum size is
29239
+ 25 MiB, and the content type must be an allowed type such as PDF, PNG,
29240
+ JPEG, CSV, XLSX, DOCX, or plain text.
29241
+
29242
+ Available to both Platform and Enterprise Partners.
29243
+ </dd>
29244
+ </dl>
29245
+ </dd>
29246
+ </dl>
29247
+
29248
+ #### 🔌 Usage
29249
+
29250
+ <dl>
29251
+ <dd>
29252
+
29253
+ <dl>
29254
+ <dd>
29255
+
29256
+ ```ruby
29257
+ client.case_management.upload_attachment(case_uuid: "caseUuid")
29258
+ ```
29259
+ </dd>
29260
+ </dl>
29261
+ </dd>
29262
+ </dl>
29263
+
29264
+ #### ⚙️ Parameters
29265
+
29266
+ <dl>
29267
+ <dd>
29268
+
29269
+ <dl>
29270
+ <dd>
29271
+
29272
+ **case_uuid:** `String` — The case's UUID.
29273
+
29274
+ </dd>
29275
+ </dl>
29276
+
29277
+ <dl>
29278
+ <dd>
29279
+
29280
+ **request_options:** `Payabli::CaseManagement::RequestOptions`
29281
+
29282
+ </dd>
29283
+ </dl>
29284
+ </dd>
29285
+ </dl>
29286
+
29287
+
29288
+ </dd>
29289
+ </dl>
29290
+ </details>
29291
+
29292
+ <details><summary><code>client.case_management.<a href="/lib/payabli/case_management/client.rb">get_attachment</a>(case_uuid:, attachment_id:) -> String</code></summary>
29293
+ <dl>
29294
+ <dd>
29295
+
29296
+ #### 📝 Description
29297
+
29298
+ <dl>
29299
+ <dd>
29300
+
29301
+ <dl>
29302
+ <dd>
29303
+
29304
+ Streams the file content of an attachment.
29305
+
29306
+ Available to both Platform and Enterprise Partners.
29307
+ </dd>
29308
+ </dl>
29309
+ </dd>
29310
+ </dl>
29311
+
29312
+ #### 🔌 Usage
29313
+
29314
+ <dl>
29315
+ <dd>
29316
+
29317
+ <dl>
29318
+ <dd>
29319
+
29320
+ ```ruby
29321
+ client.case_management.get_attachment(
29322
+ case_uuid: "caseUuid",
29323
+ attachment_id: "attachmentId"
29324
+ )
29325
+ ```
29326
+ </dd>
29327
+ </dl>
29328
+ </dd>
29329
+ </dl>
29330
+
29331
+ #### ⚙️ Parameters
29332
+
29333
+ <dl>
29334
+ <dd>
29335
+
29336
+ <dl>
29337
+ <dd>
29338
+
29339
+ **case_uuid:** `String` — The case's UUID.
29340
+
29341
+ </dd>
29342
+ </dl>
29343
+
29344
+ <dl>
29345
+ <dd>
29346
+
29347
+ **attachment_id:** `String` — The attachment's UUID.
29348
+
29349
+ </dd>
29350
+ </dl>
29351
+
29352
+ <dl>
29353
+ <dd>
29354
+
29355
+ **request_options:** `Payabli::CaseManagement::RequestOptions`
29356
+
29357
+ </dd>
29358
+ </dl>
29359
+ </dd>
29360
+ </dl>
29361
+
29362
+
29363
+ </dd>
29364
+ </dl>
29365
+ </details>
29366
+
29367
+ <details><summary><code>client.case_management.<a href="/lib/payabli/case_management/client.rb">delete_attachment</a>(case_uuid:, attachment_id:) -> </code></summary>
29368
+ <dl>
29369
+ <dd>
29370
+
29371
+ #### 📝 Description
29372
+
29373
+ <dl>
29374
+ <dd>
29375
+
29376
+ <dl>
29377
+ <dd>
29378
+
29379
+ Deletes an attachment from a case.
29380
+
29381
+ Available to both Platform and Enterprise Partners.
29382
+ </dd>
29383
+ </dl>
29384
+ </dd>
29385
+ </dl>
29386
+
29387
+ #### 🔌 Usage
29388
+
29389
+ <dl>
29390
+ <dd>
29391
+
29392
+ <dl>
29393
+ <dd>
29394
+
29395
+ ```ruby
29396
+ client.case_management.delete_attachment(
29397
+ case_uuid: "caseUuid",
29398
+ attachment_id: "attachmentId"
29399
+ )
29400
+ ```
29401
+ </dd>
29402
+ </dl>
29403
+ </dd>
29404
+ </dl>
29405
+
29406
+ #### ⚙️ Parameters
29407
+
29408
+ <dl>
29409
+ <dd>
29410
+
29411
+ <dl>
29412
+ <dd>
29413
+
29414
+ **case_uuid:** `String` — The case's UUID.
29415
+
29416
+ </dd>
29417
+ </dl>
29418
+
29419
+ <dl>
29420
+ <dd>
29421
+
29422
+ **attachment_id:** `String` — The attachment's UUID.
29423
+
29424
+ </dd>
29425
+ </dl>
29426
+
29427
+ <dl>
29428
+ <dd>
29429
+
29430
+ **request_options:** `Payabli::CaseManagement::RequestOptions`
29431
+
29432
+ </dd>
29433
+ </dl>
29434
+ </dd>
29435
+ </dl>
29436
+
29437
+
29438
+ </dd>
29439
+ </dl>
29440
+ </details>
29441
+