payabli 3.0.20 → 3.0.21

data/lib/payabli.rb

@@ -52,6 +52,11 @@ require_relative "payabli/types/create_paypoint_with_business_reference"
 require_relative "payabli/types/create_paypoint_with_inline_business"
 require_relative "payabli/types/create_paypoint_all_fields"
 require_relative "payabli/paypoints/types/create_paypoint_paypoints_request"
+require_relative "payabli/types/organization_writable_fields"
+require_relative "payabli/types/create_organization_with_inline_business"
+require_relative "payabli/types/create_organization_with_business_reference"
+require_relative "payabli/types/create_organization_all_fields"
+require_relative "payabli/organizations/types/create_organization_organizations_request"
 require_relative "payabli/billing/types/get_profile_billing_request_service_group"
 require_relative "payabli/billing/types/get_profile_billing_request_entity_type"
 require_relative "payabli/types/idempotency_key"
@@ -559,8 +564,7 @@ require_relative "payabli/types/statusnotification"
 require_relative "payabli/types/target"
 require_relative "payabli/types/query_response_notifications_records_item"
 require_relative "payabli/types/query_response_notifications"
-require_relative "payabli/types/organization_query_record_services_item"
-require_relative "payabli/types/instrument"
+require_relative "payabli/types/instrument_response"
 require_relative "payabli/types/is_root"
 require_relative "payabli/types/orgcity"
 require_relative "payabli/types/orgcountry"
@@ -573,6 +577,7 @@ require_relative "payabli/types/orgzip"
 require_relative "payabli/types/recipient_email_notification"
 require_relative "payabli/types/reply_to_email"
 require_relative "payabli/types/resumable"
+require_relative "payabli/types/organization_query_record_services_item"
 require_relative "payabli/types/summary_org"
 require_relative "payabli/types/usr_access"
 require_relative "payabli/types/language"
@@ -953,9 +958,11 @@ require_relative "payabli/types/template_query_record"
 require_relative "payabli/types/template_query_response"
 require_relative "payabli/types/export_format_1"
 require_relative "payabli/types/service_cost"
+require_relative "payabli/types/instrument"
 require_relative "payabli/types/add_organization_response"
 require_relative "payabli/types/edit_organization_response"
 require_relative "payabli/types/delete_organization_response"
+require_relative "payabli/types/get_basic_organization_response"
 require_relative "payabli/types/bank_account_verification_details_response"
 require_relative "payabli/types/verify_account_details_response"
 require_relative "payabli/types/stat_basic_extended_query_record"
@@ -1264,6 +1271,9 @@ require_relative "payabli/people/types/search_people_unmasked_request"
 require_relative "payabli/paypoints/client"
 require_relative "payabli/paypoints/types/list_paypoints_paypoints_request"
 require_relative "payabli/paypoints/types/update_paypoint_request"
+require_relative "payabli/organizations/client"
+require_relative "payabli/organizations/types/list_organizations_organizations_request"
+require_relative "payabli/organizations/types/update_organization_request"
 require_relative "payabli/payment_methods/client"
 require_relative "payabli/payment_methods/types/list_payment_methods_payment_methods_request"
 require_relative "payabli/payment_methods/types/create_payment_methods_request"

data/reference.md

@@ -824,8 +824,8 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
 **Accepted field names:**
 - `frequency` (`in`, `nin`, `ne`, `eq`)
 - `method` (`in`, `nin`, `eq`, `ne`)
-- `event` (`in`, `nin`, `eq`, `ne`)
-- `target` (`ct`, `nct`, `eq`, `ne`)
+- `vendorNumber` (`eq`)
+- `vendorId` (`eq`)
 - `status` (`eq`, `ne`)
 - `approvalUserId` (`eq`, `ne`)
 - `parentOrgId` (`ne`, `eq`, `nin`, `in`)
@@ -973,8 +973,8 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
 **Accepted field names:**
 - `frequency` (in, nin, ne, eq)
 - `method` (in, nin, eq, ne)
-- `event` (in, nin, eq, ne)
-- `target` (ct, nct, eq, ne)
+- `vendorNumber` (eq)
+- `vendorId` (eq)
 - `status` (eq, ne)
 - `parentOrgId` (ne, eq, nin, in)
 - `approvalUserId` (eq, ne)
@@ -19014,7 +19014,7 @@ client.paypoints.list_paypoints(
 <dl>
 <dd>
 
-**status:** `String` — Filter by paypoint status.
+**status:** `String` — Filter by paypoint status. One of `active`, `inactive`, `suspended`, or `closed`. Any other value, including `pending`, returns `400`.
     
 </dd>
 </dl>
@@ -19326,6 +19326,377 @@ client.paypoints.update_paypoint(
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+## Organizations
+<details><summary><code>client.organizations.<a href="/lib/payabli/organizations/client.rb">list_organizations</a>() -> Payabli::Types::ListPaypointsEnvelope</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Lists organizations with optional filtering and pagination. Only
+organizations are returned. Other paypoints never appear in this list.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.organizations.list_organizations(business_reference: "6e2b9d14-7a3c-4f58-b1e6-0c9d3a5f8e27")
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**business_reference:** `String` — Filter by the business the organization belongs to.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**status:** `String` — Filter by organization status. One of `active`, `inactive`, `suspended`, or `closed`. Any other value returns `400`.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**search:** `String` — Free-text search across organizations.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**limit:** `Integer` — Number of results per page.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**page:** `Integer` — Page number to return.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `Payabli::Organizations::RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.organizations.<a href="/lib/payabli/organizations/client.rb">create_organization</a>(request) -> Payabli::Types::PaypointCreatedEnvelope</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Creates an organization. Provide exactly one of `business` (to create
+the business inline, recommended) or `businessReference` (an existing
+business). In intelligent boarding, an organization is a kind of paypoint, so the
+request takes the paypoint create fields except `paypointType`. Payabli
+sets the organization type itself. An organization isn't underwritten,
+so only the fields needed to create the records are required. New
+organizations start in `pending`. If you don't set
+`parentPaypointReference`, the organization nests under the
+organization your credential belongs to. Returns `409` if an
+organization with the same `externalId` already exists.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.organizations.create_organization(
+  doing_business_as: "PropertyManager Pro",
+  description: "Property management software partner",
+  website: "https://example.com",
+  customer_service_phone: "3055551212",
+  customer_service_email: "support@example.com",
+  timezone: "America/New_York",
+  external_id: "pmp-org-001",
+  business: {
+    legal_name: "PropertyManager Pro LLC",
+    legal_structure: "llc",
+    external_id: "pmp-biz-001"
+  }
+)
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Payabli::Organizations::Types::CreateOrganizationOrganizationsRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `Payabli::Organizations::RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.organizations.<a href="/lib/payabli/organizations/client.rb">get_organization</a>(organization_reference:) -> Payabli::Types::PaypointDetailEnvelope</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Retrieves an organization by reference.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.organizations.get_organization(organization_reference: "a8806f02-23b3-4f6d-bba3-42e1b94326ea")
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**organization_reference:** `String` — The organization reference.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `Payabli::Organizations::RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.organizations.<a href="/lib/payabli/organizations/client.rb">update_organization</a>(organization_reference:, request) -> Payabli::Types::PaypointUpdatedEnvelope</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Applies a partial update to an organization. Send only the fields you want to change. You can't change an organization's type. If you send `paypointType`, the request ignores it and doesn't return an error.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.organizations.update_organization(
+  organization_reference: "a8806f02-23b3-4f6d-bba3-42e1b94326ea",
+  description: "Updated description"
+)
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**organization_reference:** `String` — The organization reference.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**doing_business_as:** `String` — The name the organization does business as (DBA).
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**description:** `String` — A free-text description of the organization.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**website:** `String` — The organization's website URL.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**customer_service_phone:** `String` — The customer service phone number.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**customer_service_email:** `String` — The customer service email address.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**timezone:** `String` — The organization's time zone, as an IANA identifier such as `America/Chicago`.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**external_id:** `String` — Your own identifier for the organization.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**custom_data:** `Internal::Types::Hash[String, Object]` — Arbitrary key-value data you attach to the organization.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `Payabli::Organizations::RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>
@@ -28299,7 +28670,7 @@ client.organization.delete_organization(org_id: 123)
 </dl>
 </details>
 
-<details><summary><code>client.organization.<a href="/lib/payabli/organization/client.rb">get_basic_organization</a>(entry:) -> Payabli::Types::OrganizationQueryRecord</code></summary>
+<details><summary><code>client.organization.<a href="/lib/payabli/organization/client.rb">get_basic_organization</a>(entry:) -> Payabli::Types::GetBasicOrganizationResponse</code></summary>
 <dl>
 <dd>
 
@@ -28326,7 +28697,7 @@ Gets an organization's basic information by entry name (entrypoint identifier).
 <dd>
 
 ```ruby
-client.organization.get_basic_organization(entry: "8cfec329267")
+client.organization.get_basic_organization(entry: "pilgrim-planner")
 ```
 </dd>
 </dl>
@@ -28341,7 +28712,7 @@ client.organization.get_basic_organization(entry: "8cfec329267")
 <dl>
 <dd>
 
-**entry:** `String` — The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
+**entry:** `String` — The organization's entry name (`OrgEntryName`).
     
 </dd>
 </dl>
@@ -28361,7 +28732,7 @@ client.organization.get_basic_organization(entry: "8cfec329267")
 </dl>
 </details>
 
-<details><summary><code>client.organization.<a href="/lib/payabli/organization/client.rb">get_basic_organization_by_id</a>(org_id:) -> Payabli::Types::OrganizationQueryRecord</code></summary>
+<details><summary><code>client.organization.<a href="/lib/payabli/organization/client.rb">get_basic_organization_by_id</a>(org_id:) -> Payabli::Types::GetBasicOrganizationResponse</code></summary>
 <dl>
 <dd>