Class: RubyLokaliseApi::BaseClient

Inherits:
Object
  • Object
show all
Includes:
Rest
Defined in:
lib/ruby_lokalise_api/base_client.rb

Overview

This class contains the base client. Inherited by Client (regular API client) and OAuth2Client (used for OAuth-2 based authentication)

Direct Known Subclasses

Client

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Rest::Webhooks

#create_webhook, #destroy_webhook, #regenerate_webhook_secret, #update_webhook, #webhook, #webhooks

Methods included from Rest::Translations

#translation, #translations, #update_translation

Methods included from Rest::TranslationProviders

#translation_provider, #translation_providers

Methods included from Rest::TeamUserGroups

#add_members_to_group, #add_projects_to_group, #create_team_user_group, #destroy_team_user_group, #remove_members_from_group, #remove_projects_from_group, #team_user_group, #team_user_groups, #update_team_user_group

Methods included from Rest::TeamUsers

#destroy_team_user, #team_user, #team_users, #update_team_user

Methods included from Rest::Teams

#teams

Methods included from Rest::TeamUserBillingDetails

#create_team_user_billing_details, #team_user_billing_details, #update_team_user_billing_details

Methods included from Rest::Tasks

#create_task, #destroy_task, #task, #tasks, #update_task

Methods included from Rest::Snapshots

#create_snapshot, #destroy_snapshot, #restore_snapshot, #snapshots

Methods included from Rest::Screenshots

#create_screenshots, #destroy_screenshot, #screenshot, #screenshots, #update_screenshot

Methods included from Rest::Segments

#segment, #segments, #update_segment

Methods included from Rest::QueuedProcesses

#queued_process, #queued_processes

Methods included from Rest::Projects

#create_project, #destroy_project, #empty_project, #project, #projects, #update_project

Methods included from Rest::PaymentCards

#create_payment_card, #destroy_payment_card, #payment_card, #payment_cards

Methods included from Rest::Orders

#create_order, #order, #orders

Methods included from Rest::Languages

#create_project_languages, #destroy_project_language, #project_language, #project_languages, #system_languages, #update_project_language

Methods included from Rest::Keys

#create_keys, #destroy_key, #destroy_keys, #key, #keys, #update_key, #update_keys

Methods included from Rest::Jwts

#create_jwt

Methods included from Rest::Files

#destroy_file, #download_files, #files, #upload_file

Methods included from Rest::CustomTranslationStatuses

#create_custom_translation_status, #custom_translation_status, #custom_translation_status_colors, #custom_translation_statuses, #destroy_custom_translation_status, #update_custom_translation_status

Methods included from Rest::Contributors

#contributor, #contributors, #create_contributors, #destroy_contributor, #update_contributor

Methods included from Rest::Comments

#comment, #comments, #create_comments, #destroy_comment, #project_comments

Methods included from Rest::Branches

#branch, #branches, #create_branch, #destroy_branch, #merge_branch, #update_branch

Constructor Details

#initialize(token, params = {}) ⇒ BaseClient

Returns a new instance of BaseClient.



12
13
14
15
16
17
 
# File 'lib/ruby_lokalise_api/base_client.rb', line 12

def initialize(token, params = {})
  @token = token
  @timeout = params.fetch(:timeout, nil)
  @open_timeout = params.fetch(:open_timeout, nil)
  @token_header = ''
end

Instance Attribute Details

#open_timeout ⇒ Object

Returns the value of attribute open_timeout.



10
11
12
 
# File 'lib/ruby_lokalise_api/base_client.rb', line 10

def open_timeout
  @open_timeout
end

#timeout ⇒ Object

Returns the value of attribute timeout.



10
11
12
 
# File 'lib/ruby_lokalise_api/base_client.rb', line 10

def timeout
  @timeout
end

#token ⇒ Object (readonly)

Returns the value of attribute token.



9
10
11
 
# File 'lib/ruby_lokalise_api/base_client.rb', line 9

def token
  @token
end

#token_header ⇒ Object (readonly)

Returns the value of attribute token_header.



9
10
11
 
# File 'lib/ruby_lokalise_api/base_client.rb', line 9

def token_header
  @token_header
end