Module: RubyLokaliseApi::Rest::Orders

Included in:

Client

Defined in:

lib/ruby_lokalise_api/rest/orders.rb

Instance Method Summary

• #create_order(team_id, params) ⇒ RubyLokaliseApi::Resources::Order

  Creates an order for the given team.

• #order(team_id, order_id) ⇒ RubyLokaliseApi::Resources::Order

  Returns a single order for the given team.

• #orders(team_id, params = {}) ⇒ RubyLokaliseApi::Collection::Order<RubyLokaliseApi::Resources::Order>

  Returns all orders for the given team.

Instance Method Details

#create_order(team_id, params) ⇒ RubyLokaliseApi::Resources::Order

Creates an order for the given team

Parameters:

• team_id (String)
• params (Hash)

Returns:

• (RubyLokaliseApi::Resources::Order)

See Also:

• https://developers.lokalise.com/reference/create-an-order

# File 'lib/ruby_lokalise_api/rest/orders.rb', line 32

def create_order(team_id, params)
  c_r RubyLokaliseApi::Resources::Order, :create, team_id, params
end

#order(team_id, order_id) ⇒ RubyLokaliseApi::Resources::Order

Returns a single order for the given team

Parameters:

• team_id (String)
• order_id (String, Integer)

Returns:

• (RubyLokaliseApi::Resources::Order)

See Also:

• https://developers.lokalise.com/reference/retrieve-an-order

# File 'lib/ruby_lokalise_api/rest/orders.rb', line 22

def order(team_id, order_id)
  c_r RubyLokaliseApi::Resources::Order, :find, [team_id, order_id]
end

#orders(team_id, params = {}) ⇒ RubyLokaliseApi::Collection::Order<RubyLokaliseApi::Resources::Order>

Returns all orders for the given team

Parameters:

• team_id (String)
• params (Hash) (defaults to: {})

Returns:

• (RubyLokaliseApi::Collection::Order<RubyLokaliseApi::Resources::Order>)

See Also:

• https://developers.lokalise.com/reference/list-all-orders

# File 'lib/ruby_lokalise_api/rest/orders.rb', line 12

def orders(team_id, params = {})
  c_r RubyLokaliseApi::Collections::Order, :all, team_id, params
end