Contents

# frozen_string_literal: true

module Lokalise
  class Client
    # Returns all segments for the given key and language ISO code
    #
    # @see https://app.lokalise.com/api2docs/curl/#transition-list-all-segments-for-key-language-get
    # @return [Lokalise::Collection::Segments<Lokalise::Resources::Segment>]
    # @param project_id [String]
    # @param key_id [String, Integer]
    # @param lang_iso [String]
    # @param params [Hash]
    def segments(project_id, key_id, lang_iso, params = {})
      c_r Lokalise::Collections::Segment, :all, [project_id, key_id, lang_iso], params
    end

    # Returns a segment under a given number for the given key and language ISO code
    #
    # @see https://app.lokalise.com/api2docs/curl/#transition-retrieve-a-segment-for-key-language-get
    # @return [Lokalise::Resources::Segment]
    # @param project_id [String]
    # @param key_id [String, Integer]
    # @param lang_iso [String]
    # @params segment_number [Integer, String]
    # @param params [Hash]
    def segment(project_id, key_id, lang_iso, segment_number, params = {})
      c_r Lokalise::Resources::Segment, :find, [project_id, key_id, lang_iso, segment_number], params
    end

    # Updates a segment under a given number for the given key and language ISO code
    #
    # @see https://app.lokalise.com/api2docs/curl/#transition-update-a-segment-post
    # @return [Lokalise::Resources::Segment]
    # @param project_id [String]
    # @param key_id [String, Integer]
    # @param lang_iso [String]
    # @params segment_number [Integer, String]
    # @param params [Hash]
    def update_segment(project_id, key_id, lang_iso, segment_number, params = {})
      c_r Lokalise::Resources::Segment, :update, [project_id, key_id, lang_iso, segment_number], params
    end
  end
end

Version data entries

3 entries across 3 versions & 1 rubygems

Version	Path
ruby-lokalise-api-5.0.0	lib/ruby-lokalise-api/rest/segments.rb
ruby-lokalise-api-4.5.1	lib/ruby-lokalise-api/rest/segments.rb
ruby-lokalise-api-4.5.0	lib/ruby-lokalise-api/rest/segments.rb