ultracart_api 4.1.136 → 4.1.140

data/docs/SfvbLibraryFacet.md

@@ -0,0 +1,22 @@
+# UltracartClient::SfvbLibraryFacet
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **display_name** | **String** | Human readable facet name. | [optional] |
+| **name** | **String** | Facet key.  Pass a chosen option back as facet_{name}={option}. | [optional] |
+| **options** | **Array<String>** | Available values for this facet. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbLibraryFacet.new(
+  display_name: null,
+  name: null,
+  options: null
+)
+```
+

data/docs/SfvbLibraryResponse.md

@@ -0,0 +1,28 @@
+# UltracartClient::SfvbLibraryResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **facets** | [**Array<SfvbLibraryFacet>**](SfvbLibraryFacet.md) | Available narrowing dimensions.  Send a chosen option back as facet_{name}={option}. | [optional] |
+| **first_result_number** | **Integer** | 1-indexed position of the first result on this page. | [optional] |
+| **last_result_number** | **Integer** | 1-indexed position of the last result on this page. | [optional] |
+| **results** | [**Array<SfvbLibraryEntry>**](SfvbLibraryEntry.md) | Matching library entries, without their CJSON.  Fetch a single entry to get the fragment itself. | [optional] |
+| **total_pages** | **Integer** | Total pages available. | [optional] |
+| **total_results** | **Integer** | Total matches across all pages. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbLibraryResponse.new(
+  facets: null,
+  first_result_number: null,
+  last_result_number: null,
+  results: null,
+  total_pages: null,
+  total_results: null
+)
+```
+

data/docs/SfvbPreviewSessionRequest.md

@@ -0,0 +1,20 @@
+# UltracartClient::SfvbPreviewSessionRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **containers** | **Object** | Containers to preview, keyed by container id.  Each value is a full container document. | [optional] |
+| **theme_oid** | **Integer** | Theme to compile against.  Supplies the inherit groups configuration.  Defaults to the active theme. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbPreviewSessionRequest.new(
+  containers: null,
+  theme_oid: null
+)
+```
+

data/docs/SfvbPreviewSessionResponse.md

@@ -0,0 +1,30 @@
+# UltracartClient::SfvbPreviewSessionResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **bytes_stored** | **Integer** | Bytes stored in this session by the request that returned this response. | [optional] |
+| **expires_in_seconds** | **Integer** | Seconds until this session expires. | [optional] |
+| **max_bytes** | **Integer** | Maximum bytes one preview session may hold. | [optional] |
+| **owner_login** | **String** | Login this session belongs to.  Sessions are keyed by user, not by token. | [optional] |
+| **preview_session_id** | **String** | The preview session id. | [optional] |
+| **skipped** | [**Array<SfvbErrorDetail>**](SfvbErrorDetail.md) | Containers that were sent but could not be stored, with the reason. | [optional] |
+| **stored_keys** | **Array<String>** | Preview map keys that were stored.  A container whose owner type could not be resolved is silently dropped by the underlying store, so compare this against what you sent. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbPreviewSessionResponse.new(
+  bytes_stored: null,
+  expires_in_seconds: null,
+  max_bytes: null,
+  owner_login: null,
+  preview_session_id: null,
+  skipped: null,
+  stored_keys: null
+)
+```
+

data/docs/SfvbPreviewUrlResponse.md

@@ -0,0 +1,30 @@
+# UltracartClient::SfvbPreviewUrlResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **expires_in_seconds** | **Integer** | Seconds until the session expires. | [optional] |
+| **path** | **String** | Storefront path being previewed. | [optional] |
+| **preview_session_id** | **String** | The preview session id used. | [optional] |
+| **preview_url** | **String** | URL that renders the storefront page with the preview session's containers substituted for the stored ones. | [optional] |
+| **requires_browser_session** | **Boolean** | Always true.  The preview only applies to a request carrying the UltraCart admin session cookie of the user who authorised this token.  Fetched without it, the URL returns the LIVE page with a 200 and no error, so a successful fetch is not evidence the preview was applied.  Present this URL for a human to open; do not fetch it. | [optional] |
+| **shareable** | **Boolean** | Always false.  The session is keyed by individual login, so anyone else opening this URL sees the live page rather than the preview. | [optional] |
+| **usage_note** | **String** | Plain language restatement of the two flags above, safe to show a user. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbPreviewUrlResponse.new(
+  expires_in_seconds: null,
+  path: null,
+  preview_session_id: null,
+  preview_url: null,
+  requires_browser_session: null,
+  shareable: null,
+  usage_note: null
+)
+```
+

data/docs/SfvbRenderRequest.md

@@ -0,0 +1,40 @@
+# UltracartClient::SfvbRenderRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ancestors_cjson** | **String** | The chain of ancestor nodes above this one, as CJSON.  Elements that inherit layout or styling from a parent render differently without it, so supply it when rendering a node from inside a container rather than a standalone fragment. | [optional] |
+| **child_containers_json** | **String** | Child containers this node references, as a JSON object keyed by container id.  Compiled into the render context so nested containers resolve. | [optional] |
+| **cjson** | **String** | The CJSON node to render. | [optional] |
+| **context_affiliate_oid** | **Integer** | Affiliate oid for the rendering context. | [optional] |
+| **context_blog_post_oid** | **Integer** | Blog post oid for the rendering context. | [optional] |
+| **context_group_path** | **String** | Catalog group path for the rendering context. | [optional] |
+| **context_item_id** | **String** | Item id for the rendering context.  Required for item bound elements. | [optional] |
+| **context_order_id** | **String** | Order id for the rendering context. | [optional] |
+| **context_page_number** | **String** | Page number for paginated elements.  Defaults to 1. | [optional] |
+| **context_upsell_offer_oid** | **Integer** | Upsell offer oid for the rendering context. | [optional] |
+| **language_iso_code** | **String** | Language ISO code.  Defaults to ENG. | [optional] |
+| **uri** | **String** | Storefront URI the node would appear on.  Affects rendering of anything page relative. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbRenderRequest.new(
+  ancestors_cjson: null,
+  child_containers_json: null,
+  cjson: null,
+  context_affiliate_oid: null,
+  context_blog_post_oid: null,
+  context_group_path: null,
+  context_item_id: null,
+  context_order_id: null,
+  context_page_number: null,
+  context_upsell_offer_oid: null,
+  language_iso_code: null,
+  uri: null
+)
+```
+

data/docs/SfvbRenderResponse.md

@@ -0,0 +1,28 @@
+# UltracartClient::SfvbRenderResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **errors** | [**Array<SfvbErrorDetail>**](SfvbErrorDetail.md) | Why the render failed.  Always populated when success is false. | [optional] |
+| **html** | **String** | Rendered HTML. | [optional] |
+| **pending_translation_count** | **Integer** | Number of strings still awaiting translation in the requested language. | [optional] |
+| **success** | **Boolean** | True when HTML was produced. | [optional] |
+| **truncated** | **Boolean** | True when the HTML was cut short. | [optional] |
+| **warnings** | [**Array<SfvbErrorDetail>**](SfvbErrorDetail.md) | Quality warnings about the rendered node. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbRenderResponse.new(
+  errors: null,
+  html: null,
+  pending_translation_count: null,
+  success: null,
+  truncated: null,
+  warnings: null
+)
+```
+

data/docs/SfvbStorefront.md

@@ -0,0 +1,22 @@
+# UltracartClient::SfvbStorefront
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **active_theme_oid** | **Integer** | Oid of the theme currently serving live traffic. | [optional] |
+| **host_name** | **String** | Host name of the storefront. | [optional] |
+| **storefront_oid** | **Integer** | StoreFront oid. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbStorefront.new(
+  active_theme_oid: null,
+  host_name: null,
+  storefront_oid: null
+)
+```
+

data/docs/SfvbStorefrontsResponse.md

@@ -0,0 +1,18 @@
+# UltracartClient::SfvbStorefrontsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **storefronts** | [**Array<SfvbStorefront>**](SfvbStorefront.md) | Storefronts reachable with this token. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbStorefrontsResponse.new(
+  storefronts: null
+)
+```
+

data/docs/SfvbTheme.md

@@ -0,0 +1,36 @@
+# UltracartClient::SfvbTheme
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **active** | **Boolean** | True when this theme is the one serving live traffic.  Writing to an active theme requires the sfvb_publish scope. | [optional] |
+| **description** | **String** | What the theme is, where the author supplied a description. | [optional] |
+| **fs_directory_oid** | **Integer** | Oid of the theme root directory in the storefront file system. | [optional] |
+| **path** | **String** | Root path of the theme in the storefront file system, for example /themes/mytheme/ | [optional] |
+| **storefront_oid** | **Integer** | StoreFront oid this theme belongs to. | [optional] |
+| **theme_name** | **String** | Theme name. | [optional] |
+| **theme_oid** | **Integer** | StoreFront theme oid. | [optional] |
+| **upgrade_available** | **Boolean** | True when a newer version of this theme exists.  Relevant because an upgrade is what produces the merge conflicts that block activation. | [optional] |
+| **valid** | **Boolean** | False when the theme contains templates that failed validation.  Worth checking before choosing a theme to work in. | [optional] |
+| **version** | **String** | Theme version. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbTheme.new(
+  active: null,
+  description: null,
+  fs_directory_oid: null,
+  path: null,
+  storefront_oid: null,
+  theme_name: null,
+  theme_oid: null,
+  upgrade_available: null,
+  valid: null,
+  version: null
+)
+```
+

data/docs/SfvbThemeDuplicateRequest.md

@@ -0,0 +1,22 @@
+# UltracartClient::SfvbThemeDuplicateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **folder** | **String** | Directory name for the new theme under /themes/.  Letters and numbers; it is cleansed before use.  Must not already exist - a collision is refused rather than resolved, because silently creating a differently named theme leaves you unsure what you made. | [optional] |
+| **target_storefront_oid** | **Integer** | Storefront to create the copy on.  Defaults to the storefront in the path.  Supply it only when copying a theme between storefronts you own. | [optional] |
+| **theme_name** | **String** | Name for the new theme. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbThemeDuplicateRequest.new(
+  folder: null,
+  target_storefront_oid: null,
+  theme_name: null
+)
+```
+

data/docs/SfvbThemeJobResponse.md

@@ -0,0 +1,40 @@
+# UltracartClient::SfvbThemeJobResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **complete** | **Boolean** | True once the job has stopped, whether it succeeded or failed. | [optional] |
+| **description** | **String** | Human readable description of the job. | [optional] |
+| **error_message** | **String** | Failure detail.  Populated only when status is error. | [optional] |
+| **finished_dts** | **String** | When the job stopped.  Null until it does. | [optional] |
+| **job_id** | **Integer** | Job handle.  Poll getSfvbThemeJob with this. | [optional] |
+| **progress** | **Integer** | Percent complete, 0-100. | [optional] |
+| **progress_description** | **String** | What the job is doing right now, for example 'Duplicating locale text'. | [optional] |
+| **started_dts** | **String** | When the job started running.  Null until it does. | [optional] |
+| **status** | **String** | Raw job status. | [optional] |
+| **submitted_dts** | **String** | When the job was queued. | [optional] |
+| **success** | **Boolean** | True only when the job finished successfully.  Check complete first. | [optional] |
+| **target_path** | **String** | Path the new theme was created at.  Returned when the job is started; the theme oid itself is NOT returned, because the job's product is a plain text report rather than a structured result.  Once the job completes, list themes and match on this path. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbThemeJobResponse.new(
+  complete: null,
+  description: null,
+  error_message: null,
+  finished_dts: null,
+  job_id: null,
+  progress: null,
+  progress_description: null,
+  started_dts: null,
+  status: null,
+  submitted_dts: null,
+  success: null,
+  target_path: null
+)
+```
+

data/docs/SfvbThemesResponse.md

@@ -0,0 +1,20 @@
+# UltracartClient::SfvbThemesResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **active_theme_oid** | **Integer** | Oid of the active theme, repeated here so a caller does not have to scan the list. | [optional] |
+| **themes** | [**Array<SfvbTheme>**](SfvbTheme.md) | Themes belonging to the storefront.  Exactly one is flagged active. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbThemesResponse.new(
+  active_theme_oid: null,
+  themes: null
+)
+```
+

data/docs/SfvbUpsellOffer.md

@@ -0,0 +1,34 @@
+# UltracartClient::SfvbUpsellOffer
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **active** | **Boolean** | Whether the offer is switched on. | [optional] |
+| **active_overall** | **Boolean** | Whether the offer is active once its date window and daily pricing are taken into account.  This is the one that says whether shoppers are actually seeing it. | [optional] |
+| **cjson_size** | **Integer** | Size of the offer's container JSON in bytes.  A large value here alongside a low element count is the signature of a hand pasted HTML dump. | [optional] |
+| **has_container** | **Boolean** | Whether a container has been authored for this offer. | [optional] |
+| **name** | **String** | Offer name. | [optional] |
+| **path_name** | **String** | Name of the upsell path this offer sits on. | [optional] |
+| **storefront_oid** | **Integer** | Storefront oid. | [optional] |
+| **test_only** | **Boolean** | Whether the offer is restricted to test traffic. | [optional] |
+| **upsell_offer_oid** | **Integer** | Upsell offer oid. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbUpsellOffer.new(
+  active: null,
+  active_overall: null,
+  cjson_size: null,
+  has_container: null,
+  name: null,
+  path_name: null,
+  storefront_oid: null,
+  test_only: null,
+  upsell_offer_oid: null
+)
+```
+

data/docs/SfvbUpsellOffersResponse.md

@@ -0,0 +1,18 @@
+# UltracartClient::SfvbUpsellOffersResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **upsell_offers** | [**Array<SfvbUpsellOffer>**](SfvbUpsellOffer.md) | Upsell offers on this storefront. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbUpsellOffersResponse.new(
+  upsell_offers: null
+)
+```
+

data/docs/SfvbValidateRequest.md

@@ -0,0 +1,26 @@
+# UltracartClient::SfvbValidateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cjson** | **String** | The container JSON to validate. | [optional] |
+| **container_name** | **String** | Container name it will be stored under, for example upsell-offer or email-footer.  Some rules key off the name. | [optional] |
+| **include_warnings** | **Boolean** | Include quality warnings as well as errors.  Defaults to true. | [optional] |
+| **marketing_email** | **Boolean** | For email containers, whether this is a marketing email.  Marketing emails carry CAN-SPAM footer requirements that transactional emails do not. | [optional] |
+| **owner_type** | **String** | Where this container is destined to live.  Determines which contextual rules apply. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbValidateRequest.new(
+  cjson: null,
+  container_name: null,
+  include_warnings: null,
+  marketing_email: null,
+  owner_type: null
+)
+```
+

data/docs/SfvbValidationResponse.md

@@ -0,0 +1,24 @@
+# UltracartClient::SfvbValidationResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **errors** | [**Array<SfvbErrorDetail>**](SfvbErrorDetail.md) | Problems that will prevent a write. | [optional] |
+| **used_elements** | **Array<String>** | Element types found in the document, sorted. | [optional] |
+| **valid** | **Boolean** | True when there are no errors.  Warnings do not affect this flag. | [optional] |
+| **warnings** | [**Array<SfvbErrorDetail>**](SfvbErrorDetail.md) | Quality problems that will not prevent a write but should be addressed. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbValidationResponse.new(
+  errors: null,
+  used_elements: null,
+  valid: null,
+  warnings: null
+)
+```
+

data/docs/SfvbVelocityValidateRequest.md

@@ -0,0 +1,20 @@
+# UltracartClient::SfvbVelocityValidateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **path** | **String** | Optional path the template would be written to.  Used only to improve error messages. | [optional] |
+| **template** | **String** | The Velocity template source to validate. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbVelocityValidateRequest.new(
+  path: null,
+  template: null
+)
+```
+

data/docs/SfvbVersionResponse.md

@@ -0,0 +1,36 @@
+# UltracartClient::SfvbVersionResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **container_manager_version** | **String** | Container manager version used to compile for this merchant. | [optional] |
+| **container_versions_retained** | **Integer** | Versions kept per non-file container before the oldest are pruned.  Beyond this, history is gone - not merely paginated. | [optional] |
+| **element_count** | **Integer** | Number of element types this version recognizes. | [optional] |
+| **max_cjson_bytes** | **Integer** | Largest CJSON document that will be parsed, in bytes. | [optional] |
+| **max_preview_session_bytes** | **Integer** | Largest payload one preview session may hold, in bytes. | [optional] |
+| **max_search_results** | **Integer** | Hard ceiling on file search results per page. | [optional] |
+| **max_template_bytes** | **Integer** | Largest template file that can be written, in bytes. | [optional] |
+| **max_widget_ids_per_request** | **Integer** | Most widget ids that can be reserved in one call. | [optional] |
+| **preview_session_ttl_seconds** | **Integer** | Seconds a preview session survives before expiring. | [optional] |
+| **release** | **String** | Release channel selected for this merchant. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbVersionResponse.new(
+  container_manager_version: null,
+  container_versions_retained: null,
+  element_count: null,
+  max_cjson_bytes: null,
+  max_preview_session_bytes: null,
+  max_search_results: null,
+  max_template_bytes: null,
+  max_widget_ids_per_request: null,
+  preview_session_ttl_seconds: null,
+  release: null
+)
+```
+

data/docs/SfvbWhoamiResponse.md

@@ -0,0 +1,36 @@
+# UltracartClient::SfvbWhoamiResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **acting_as_user** | **Boolean** | True when this token resolves to a merchant user.  Preview sessions and file writes need one, because they are recorded against the person who approved the token.  Only device flow tokens resolve a user, so a plain API key will see this false. | [optional] |
+| **application_name** | **String** | Description of the application this credential belongs to. | [optional] |
+| **authentication_type** | **String** | How this token authenticated - Oauth2, Simple Key, Public/Private Key or Browser Key. | [optional] |
+| **device_scope** | **String** | Device scope name, when this is a device flow token. | [optional] |
+| **login** | **String** | Login of the user who approved this token.  Populated for device flow tokens; null for plain API key credentials. | [optional] |
+| **merchant_id** | **String** | Merchant id this token acts against. | [optional] |
+| **scopes** | **Array<String>** | Scopes granted to this token. | [optional] |
+| **storefronts** | [**Array<SfvbStorefront>**](SfvbStorefront.md) | Storefronts reachable with this token.  Empty unless the token holds sfvb_read, because storefront inventory is resource data rather than identity. | [optional] |
+| **storefronts_withheld** | **Boolean** | True when storefronts was emptied because the token lacks sfvb_read, rather than because the account has none.  Without this the two look identical. | [optional] |
+| **user_name** | **String** | Display name of the approving user, when known. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbWhoamiResponse.new(
+  acting_as_user: null,
+  application_name: null,
+  authentication_type: null,
+  device_scope: null,
+  login: null,
+  merchant_id: null,
+  scopes: null,
+  storefronts: null,
+  storefronts_withheld: null,
+  user_name: null
+)
+```
+

data/docs/SfvbWidgetIdsResponse.md

@@ -0,0 +1,22 @@
+# UltracartClient::SfvbWidgetIdsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **count** | **Integer** | How many were reserved. | [optional] |
+| **first_id** | **Integer** | First reserved number. | [optional] |
+| **ids** | **Array<Integer>** | Reserved id numbers.  Combine with an element type to form a widget id, for example headline-4271. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbWidgetIdsResponse.new(
+  count: null,
+  first_id: null,
+  ids: null
+)
+```
+

data/lib/ultracart_api/api/conversation_api.rb

@@ -4432,6 +4432,64 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # Get pbx pay connectors
+    # Retrieve the Twilio Pay Connectors installed in the Twilio account for this merchant.  This list is refreshed each time the PBX configuration is deployed. 
+    # @param [Hash] opts the optional parameters
+    # @return [ConversationPbxPayConnectorsResponse]
+    def get_pbx_pay_connectors(opts = {})
+      data, _status_code, _headers = get_pbx_pay_connectors_with_http_info(opts)
+      data
+    end
+
+    # Get pbx pay connectors
+    # Retrieve the Twilio Pay Connectors installed in the Twilio account for this merchant.  This list is refreshed each time the PBX configuration is deployed. 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ConversationPbxPayConnectorsResponse, Integer, Hash)>] ConversationPbxPayConnectorsResponse data, response status code and response headers
+    def get_pbx_pay_connectors_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConversationApi.get_pbx_pay_connectors ...'
+      end
+      # resource path
+      local_var_path = '/conversation/pbx/pay_connector'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ConversationPbxPayConnectorsResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"ConversationApi.get_pbx_pay_connectors",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConversationApi#get_pbx_pay_connectors\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get pbx phoneNumber
     # Retrieve a pbx phoneNumber 
     # @param conversation_pbx_phone_number_uuid [String]