Skip to content

diligenstech/yext-api

BranchesTags

Repository files navigation

yext

Yext - the Ruby gem for the Yext API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

This SDK is automatically generated by the OpenAPI Generator project:

  • API version: 2.0
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build yext.gemspec

Then either install the gem locally:

gem install ./yext-1.0.0.gem

(for development, run gem install --dev ./yext-1.0.0.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'yext', '~> 1.0.0'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:

gem 'yext', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'yext'

# Setup authorization
Yext.configure do |config|
  # Configure API key authorization: api-key
  config.api_key['api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['api-key'] = 'Bearer'

  # Configure API key authorization: api_key
  config.api_key['api_key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['api_key'] = 'Bearer'
end

api_instance = Yext::AccountSettingsApi.new
account_id = 'account_id_example' # String | 
linked_account_id = 'linked_account_id_example' # String | 
v = 'v_example' # String | A date in `YYYYMMDD` format.
assign_linked_account_request = Yext::AssignLinkedAccountRequest.new({destination_account_id: 'destination_account_id_example'}) # AssignLinkedAccountRequest | 

begin
  #LinkedAccounts: Assign
  result = api_instance.assign_linked_account(account_id, linked_account_id, v, assign_linked_account_request)
  p result
rescue Yext::ApiError => e
  puts "Exception when calling AccountSettingsApi->assign_linked_account: #{e}"
end

api_instance = Yext::AdministrativeAPIApi.new
account_id = 'account_id_example' # String | The ID of the account.  **NOTE:** Enter the ID of the *main account* rather than the sub-account to cancel all of the services provisioned on the sub-account. 
v = 'v_example' # String | A date in `YYYYMMDD` format.
cancel_all_sub_account_services_request = Yext::CancelAllSubAccountServicesRequest.new({sub_account_id: 'B093879'}) # CancelAllSubAccountServicesRequest | 

begin
  #Services: Cancel All (Sub-Account)
  result = api_instance.cancel_all_sub_account_services(account_id, v, cancel_all_sub_account_services_request)
  p result
rescue Yext::ApiError => e
  puts "Exception when calling AdministrativeAPIApi->cancel_all_sub_account_services: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://api.yext.com/v2

Class Method HTTP request Description
Yext::AdministrativeAPIApi cancel_all_sub_account_services POST /accounts/{accountId}/cancelallsubaccountservices Services: Cancel All (Sub-Account)
Yext::AdministrativeAPIApi cancel_services POST /accounts/{accountId}/cancelservices Services: Cancel (Location)
Yext::AdministrativeAPIApi cancel_sub_account_services POST /accounts/{accountId}/cancelsubaccountservices Services: Cancel (Sub-Account)
Yext::AdministrativeAPIApi create_existing_location_add_request POST /accounts/{accountId}/existinglocationaddrequests Add Requests: Create (Existing Location)
Yext::AdministrativeAPIApi create_existing_sub_account_add_request POST /accounts/{accountId}/existingsubaccountaddrequests Add Requests: Create (Existing Sub-Account)
Yext::AdministrativeAPIApi create_new_location_add_request POST /accounts/{accountId}/newlocationaddrequests Add Requests: Create (New Location)
Yext::AdministrativeAPIApi create_process_review_add_request POST /accounts/{accountId}/processaddrequest Add Requests: Process (Sandbox API Only)
Yext::AdministrativeAPIApi create_sub_account POST /accounts/{accountId}/createsubaccount Accounts: Create Sub-Account
Yext::AdministrativeAPIApi get_account GET /accounts/{accountId} Accounts: Get
Yext::AdministrativeAPIApi get_add_request GET /accounts/{accountId}/addrequests/{addRequestId} Add Requests: Get (Location)
Yext::AdministrativeAPIApi get_resources_apply_request_status GET /accounts/{accountId}/resourcesapplyrequests/{requestId} Resources Apply Request Status: Get (Account)
Yext::AdministrativeAPIApi get_sub_account_add_request GET /accounts/{accountId}/subaccountaddrequests/{addRequestId} Add Requests: Get (Sub-Account)
Yext::AdministrativeAPIApi list_accounts GET /accounts Accounts: List
Yext::AdministrativeAPIApi list_add_requests GET /accounts/{accountId}/addrequests Add Requests: List (Location)
Yext::AdministrativeAPIApi list_available_services GET /accounts/{accountId}/availableservices Available Services: List
Yext::AdministrativeAPIApi list_services GET /accounts/{accountId}/services Services: List (Location)
Yext::AdministrativeAPIApi list_sub_account_add_requests GET /accounts/{accountId}/subaccountaddrequests Add Requests: List (Sub-Account)
Yext::AdministrativeAPIApi list_sub_account_services GET /accounts/{accountId}/subaccountservices Services: List (Sub-Account)
Yext::AdministrativeAPIApi resources_apply_request POST /accounts/{accountId}/resourcesapplyrequests Resources Apply Request: Create (Account)
Yext::AdministrativeAPIApi update_account PUT /accounts/{accountId} Accounts: Update
Yext::AccountSettingsApi assign_linked_account PUT /accounts/{accountId}/linkedaccounts/{linkedAccountId}/assign LinkedAccounts: Assign
Yext::AccountSettingsApi create_approval_group POST /accounts/{accountId}/approvalgroups Approval Groups: Create
Yext::AccountSettingsApi create_user POST /accounts/{accountId}/users Users: Create
Yext::AccountSettingsApi delete_approval_group DELETE /accounts/{accountId}/approvalgroups/{approvalGroupId} ApprovalGroups: Delete
Yext::AccountSettingsApi delete_user DELETE /accounts/{accountId}/users/{userId} Users: Delete
Yext::AccountSettingsApi get_account GET /accounts/{accountId} Accounts: Get
Yext::AccountSettingsApi get_approval_group GET /accounts/{accountId}/approvalgroups/{approvalGroupId} ApprovalGroups: Get
Yext::AccountSettingsApi get_approval_groups GET /accounts/{accountId}/approvalgroups ApprovalGroups: List
Yext::AccountSettingsApi get_linked_account GET /accounts/{accountId}/linkedaccounts/{linkedAccountId} LinkedAccounts: Get
Yext::AccountSettingsApi get_roles GET /accounts/{accountId}/roles Roles: Get
Yext::AccountSettingsApi get_user GET /accounts/{accountId}/users/{userId} Users: Get
Yext::AccountSettingsApi get_users GET /accounts/{accountId}/users Users: List
Yext::AccountSettingsApi list_accounts GET /accounts Accounts: List
Yext::AccountSettingsApi list_linked_accounts GET /accounts/{accountId}/linkedaccounts LinkedAccounts: List
Yext::AccountSettingsApi update_approval_group PUT /accounts/{accountId}/approvalgroups/{approvalGroupId} ApprovalGroups: Update
Yext::AccountSettingsApi update_user PUT /accounts/{accountId}/users/{userId} Users: Update
Yext::AccountSettingsApi update_user_password PUT /accounts/{accountId}/users/{userId}/password Users: Update Password
Yext::AnalyticsApi activity_log POST /accounts/{accountId}/analytics/activity Activity Log
Yext::AnalyticsApi create_reports POST /accounts/{accountId}/analytics/reports Reports
Yext::AnalyticsApi get_catalog GET /accounts/{accountId}/analytics/catalog Catalog
Yext::AnalyticsApi get_max_dates GET /accounts/{accountId}/analytics/maxdates Max Dates
Yext::AnalyticsApi report_status GET /accounts/{accountId}/analytics/standardreports/{reportId} Report Status
Yext::ConnectorsApi push_data POST /accounts/{accountId}/connectors/{connectorId}/pushData Connectors: Push Data
Yext::ConnectorsApi trigger_connector POST /accounts/{accountId}/connectors/{connectorId}/trigger Connectors: Trigger
Yext::HealthCheckApi health_check GET /healthy Health Check
Yext::KnowledgeManagerApi create_asset POST /accounts/{accountId}/assets Assets: Create
Yext::KnowledgeManagerApi create_bio POST /accounts/{accountId}/bios Bios: Create
Yext::KnowledgeManagerApi create_custom_field POST /accounts/{accountId}/customfields Custom Fields: Create
Yext::KnowledgeManagerApi create_entity POST /accounts/{accountId}/entities Entities: Create
Yext::KnowledgeManagerApi create_event POST /accounts/{accountId}/events Events (Legacy): Create
Yext::KnowledgeManagerApi create_location POST /accounts/{accountId}/locations Locations (Legacy): Create
Yext::KnowledgeManagerApi create_menu POST /accounts/{accountId}/menus Menus: Create
Yext::KnowledgeManagerApi create_product POST /accounts/{accountId}/products Products: Create
Yext::KnowledgeManagerApi delete_asset DELETE /accounts/{accountId}/assets/{assetId} Assets: Delete
Yext::KnowledgeManagerApi delete_bio_list DELETE /accounts/{accountId}/bios/{listId} Bios: Delete
Yext::KnowledgeManagerApi delete_custom_field DELETE /accounts/{accountId}/customfields/{customFieldId} Custom Fields: Delete
Yext::KnowledgeManagerApi delete_entity DELETE /accounts/{accountId}/entities/{entityId} Entities: Delete
Yext::KnowledgeManagerApi delete_event_list DELETE /accounts/{accountId}/events/{listId} Events (Legacy): Delete
Yext::KnowledgeManagerApi delete_language_profile DELETE /accounts/{accountId}/entityprofiles/{entityId}/{languageCode} Entity Language Profiles: Delete
Yext::KnowledgeManagerApi delete_location_language_profile DELETE /accounts/{accountId}/locations/{locationId}/profiles/{language_code} Language Profiles (Legacy): Delete
Yext::KnowledgeManagerApi delete_menu_list DELETE /accounts/{accountId}/menus/{listId} Menus: Delete
Yext::KnowledgeManagerApi delete_product_list DELETE /accounts/{accountId}/products/{listId} Products: Delete
Yext::KnowledgeManagerApi get_asset GET /accounts/{accountId}/assets/{assetId} Assets: Get
Yext::KnowledgeManagerApi get_bio GET /accounts/{accountId}/bios/{listId} Bios: Get
Yext::KnowledgeManagerApi get_bios GET /accounts/{accountId}/bios Bios: List
Yext::KnowledgeManagerApi get_business_categories GET /categories Categories: List
Yext::KnowledgeManagerApi get_custom_field GET /accounts/{accountId}/customfields/{customFieldId} Custom Fields: Get
Yext::KnowledgeManagerApi get_custom_fields GET /accounts/{accountId}/customfields Custom Fields: List
Yext::KnowledgeManagerApi get_entity GET /accounts/{accountId}/entities/{entityId} Entities: Get
Yext::KnowledgeManagerApi get_event GET /accounts/{accountId}/events/{listId} Events (Legacy): Get
Yext::KnowledgeManagerApi get_events GET /accounts/{accountId}/events Events (Legacy): List
Yext::KnowledgeManagerApi get_google_keywords GET /googlefields Google Fields: List
Yext::KnowledgeManagerApi get_language_profile GET /accounts/{accountId}/entityprofiles/{entityId}/{languageCode} Entity Language Profiles: Get
Yext::KnowledgeManagerApi get_language_profiles GET /accounts/{accountId}/locations/{locationId}/profiles Language Profiles (Legacy): List
Yext::KnowledgeManagerApi get_location GET /accounts/{accountId}/locations/{locationId} Locations (Legacy): Get
Yext::KnowledgeManagerApi get_location_folders GET /accounts/{accountId}/folders Folders: List
Yext::KnowledgeManagerApi get_location_language_profile GET /accounts/{accountId}/locations/{locationId}/profiles/{language_code} Language Profiles (Legacy): Get
Yext::KnowledgeManagerApi get_locations GET /accounts/{accountId}/locations Locations (Legacy): List
Yext::KnowledgeManagerApi get_menu GET /accounts/{accountId}/menus/{listId} Menus: Get
Yext::KnowledgeManagerApi get_menus GET /accounts/{accountId}/menus Menus: List
Yext::KnowledgeManagerApi get_product GET /accounts/{accountId}/products/{listId} Products: Get
Yext::KnowledgeManagerApi get_products GET /accounts/{accountId}/products Products: List
Yext::KnowledgeManagerApi list_all_language_profiles GET /accounts/{accountId}/entityprofiles Entity Language Profiles: List All
Yext::KnowledgeManagerApi list_assets GET /accounts/{accountId}/assets Assets: List
Yext::KnowledgeManagerApi list_entities GET /accounts/{accountId}/entities Entities: List
Yext::KnowledgeManagerApi list_language_profiles GET /accounts/{accountId}/entityprofiles/{entityId} Entity Language Profiles: List
Yext::KnowledgeManagerApi search_locations GET /accounts/{accountId}/locationsearch Locations (Legacy): Search
Yext::KnowledgeManagerApi update_asset PUT /accounts/{accountId}/assets/{assetId} Assets: Update
Yext::KnowledgeManagerApi update_bio PUT /accounts/{accountId}/bios/{listId} Bios: Update
Yext::KnowledgeManagerApi update_custom_field PUT /accounts/{accountId}/customfields/{customFieldId} Custom Fields: Update
Yext::KnowledgeManagerApi update_entity PUT /accounts/{accountId}/entities/{entityId} Entities: Update
Yext::KnowledgeManagerApi update_event PUT /accounts/{accountId}/events/{listId} Events (Legacy): Update
Yext::KnowledgeManagerApi update_location PUT /accounts/{accountId}/locations/{locationId} Locations (Legacy): Update
Yext::KnowledgeManagerApi update_menu PUT /accounts/{accountId}/menus/{listId} Menus: Update
Yext::KnowledgeManagerApi update_product PUT /accounts/{accountId}/products/{listId} Products: Update
Yext::KnowledgeManagerApi upsert_language_profile PUT /accounts/{accountId}/entityprofiles/{entityId}/{languageCode} Entity Language Profiles: Upsert
Yext::KnowledgeManagerApi upsert_location_language_profile PUT /accounts/{accountId}/locations/{locationId}/profiles/{language_code} Language Profiles (Legacy): Upsert
Yext::KnowledgeManagerApi upsert_suggestion POST /accounts/{accountId}/suggestions Suggestion: Upsert
Yext::ListingsApi complete_verification POST /accounts/{accountId}/listings/verifications/{publisherId}/complete Verification: Complete
Yext::ListingsApi create_answer POST /accounts/{accountId}/questions/{questionId}/answers Answer: Create
Yext::ListingsApi create_duplicate POST /accounts/{accountId}/listings/duplicates Duplicates: Create
Yext::ListingsApi delete_answer DELETE /accounts/{accountId}/questions/{questionId}/answers/{answerId} Answer: Delete
Yext::ListingsApi delete_duplicate DELETE /accounts/{accountId}/listings/duplicates/{duplicateId} Duplicates: Delete
Yext::ListingsApi delete_listings DELETE /accounts/{accountId}/listings/delete Entity Listings: Delete
Yext::ListingsApi get_publisher_suggestion GET /accounts/{accountId}/listings/publishersuggestions/{suggestionId} Publisher Suggestions: Get
Yext::ListingsApi get_question GET /accounts/{accountId}/questions/{questionId} Question: Get
Yext::ListingsApi initiate_verification POST /accounts/{accountId}/listings/verifications/{publisherId}/{locale}/initiate Verification: Initiate
Yext::ListingsApi invite_admins POST /accounts/{accountId}/listings/admins/{publisherId}/invite Listing Admin: Invite
Yext::ListingsApi list_admins GET /accounts/{accountId}/listings/admins/{publisherId} Listing Admins: List
Yext::ListingsApi list_duplicates GET /accounts/{accountId}/listings/duplicates Duplicates: List
Yext::ListingsApi list_entity_listings GET /accounts/{accountId}/listings/entitylistings Entity Listings: List
Yext::ListingsApi list_listings GET /accounts/{accountId}/listings/listings Listings: List
Yext::ListingsApi list_methods GET /accounts/{accountId}/listings/verifications/{publisherId}/{locale}/methods Verification Methods: List
Yext::ListingsApi list_publisher_suggestions GET /accounts/{accountId}/listings/publishersuggestions Publisher Suggestions: List
Yext::ListingsApi list_publishers GET /accounts/{accountId}/listings/publishers Publishers: List
Yext::ListingsApi list_questions GET /accounts/{accountId}/questions Questions: List
Yext::ListingsApi list_statuses GET /accounts/{accountId}/listings/verifications/{publisherId}/statuses Verification Statuses: List
Yext::ListingsApi opt_in_listings PUT /accounts/{accountId}/listings/listings/optin Listings: Opt In
Yext::ListingsApi opt_out_listings PUT /accounts/{accountId}/listings/listings/optout Listings: Opt Out
Yext::ListingsApi suppress_duplicate PUT /accounts/{accountId}/listings/duplicates/{duplicateId} Duplicates: Suppress
Yext::ListingsApi update_answer PUT /accounts/{accountId}/questions/{questionId}/answers/{answerId} Answer: Update
Yext::ListingsApi update_publisher_suggestion PUT /accounts/{accountId}/listings/publishersuggestions/{suggestionId} Publisher Suggestions: Update
Yext::LogsAPIApi get_table GET /accounts/{accountId}/logs/tables/{table} Table Schema
Yext::LogsAPIApi get_tables GET /accounts/{accountId}/logs/tables Tables
Yext::LogsAPIApi post_query POST /accounts/{accountId}/logs/tables/{table}/query Query
Yext::OptimizationTasksApi get_link_optimization_task GET /accounts/{accountId}/optimizationlink Optimization Tasks: Get Link
Yext::OptimizationTasksApi get_optimization_tasks GET /accounts/{accountId}/optimizationtasks Optimization Tasks: List
Yext::ReviewsApi create_comment POST /accounts/{accountId}/reviews/{reviewId}/comments Comment: Create
Yext::ReviewsApi create_review POST /accounts/{accountId}/reviews Reviews: Create
Yext::ReviewsApi create_review_invites POST /accounts/{accountId}/reviewinvites Review Invitations: Create
Yext::ReviewsApi delete_comment DELETE /accounts/{accountId}/reviews/{reviewId}/comments/{commentId} Comment: Delete
Yext::ReviewsApi delete_invitation DELETE /accounts/{accountId}/reviewinvites/{invitationUid} Review Invitation: Delete
Yext::ReviewsApi get_review GET /accounts/{accountId}/reviews/{reviewId} Review: Get
Yext::ReviewsApi get_review_generation_settings GET /accounts/{accountId}/reviews/settings/generation Review Generation Settings: Get
Yext::ReviewsApi get_review_invitation GET /accounts/{accountId}/reviewinvites/{invitationUid} Review Invitation: Get
Yext::ReviewsApi list_review_invitations GET /accounts/{accountId}/reviewinvites Review Invitations: List
Yext::ReviewsApi list_reviews GET /accounts/{accountId}/reviews Reviews: List
Yext::ReviewsApi update_comment PUT /accounts/{accountId}/reviews/{reviewId}/comments/{commentId} Comment: Update
Yext::ReviewsApi update_review PUT /accounts/{accountId}/reviews/{reviewId} Review: Update
Yext::ReviewsApi update_review_generation_settings POST /accounts/{accountId}/reviews/settings/generation Review Generation Settings: Update
Yext::ReviewsApi update_review_invitation PUT /accounts/{accountId}/reviewinvites/{invitationUid} Review Invitation: Update
Yext::ReviewsApi update_review_labels PUT /accounts/{accountId}/reviews/{reviewId}/labels Review Labels: Update
Yext::SocialApi create_entity_post_comment POST /accounts/{accountId}/entityPosts/{entityPostId}/comments Entity Post: Create Comment
Yext::SocialApi create_posts POST /accounts/{accountId}/posts Post: Create
Yext::SocialApi delete_entity_post DELETE /accounts/{accountId}/entityPosts/{entityPostId} Entity Post: Delete
Yext::SocialApi delete_post DELETE /accounts/{accountId}/posts/{postId} Post: Delete
Yext::SocialApi get_post GET /accounts/{accountId}/posts/{postId} Post: Get
Yext::SocialApi list_posts GET /accounts/{accountId}/posts Posts: List
Yext::SocialApi update_post PUT /accounts/{accountId}/posts/{postId} Post: Update

Documentation for Models

Documentation for Authorization

api-key

  • Type: API key
  • API key parameter name: api-key
  • Location: HTTP header

api_key

  • Type: API key
  • API key parameter name: api_key
  • Location: URL query string

About

No description, website, or topics provided.

Resources

Readme
Activity
Custom properties

Stars

0 stars

Watchers

2 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

 
 
 

Contributors

Languages