Class: Weblate::ChangesApi

Inherits:

Object

Object
Weblate::ChangesApi

show all

Defined in:: lib/weblate/api/changes_api.rb

Instance Attribute Summary collapse

#api_client ⇒ Object

Returns the value of attribute api_client.

Instance Method Summary collapse

#changes_list(opts = {}) ⇒ PaginatedChangeList

Changes API.
#changes_list_with_http_info(opts = {}) ⇒ Array<(PaginatedChangeList, Integer, Hash)>

Changes API.
#changes_retrieve(id, opts = {}) ⇒ Change

Changes API.
#changes_retrieve_with_http_info(id, opts = {}) ⇒ Array<(Change, Integer, Hash)>

Changes API.
#initialize(api_client = ApiClient.default) ⇒ ChangesApi constructor

A new instance of ChangesApi.

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ `ChangesApi`

Returns a new instance of ChangesApi.



19
20
21

# File 'lib/weblate/api/changes_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ `Object`

Returns the value of attribute api_client.



17
18
19

# File 'lib/weblate/api/changes_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#changes_list(opts = {}) ⇒ `PaginatedChangeList`

Changes API.

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:action (Array<Integer>) —
- `0` - Resource updated * `1` - Translation completed * `2` - Translation changed * `5` - Translation added * `3` - Comment added * `4` - Suggestion added * `6` - Automatically translated * `7` - Suggestion accepted * `8` - Translation reverted * `9` - Translation uploaded * `13` - Source string added * `14` - Component locked * `15` - Component unlocked * `17` - Changes committed * `18` - Changes pushed * `19` - Repository reset * `20` - Repository merged * `21` - Repository rebased * `22` - Repository merge failed * `23` - Repository rebase failed * `28` - Repository push failed * `24` - Parsing failed * `25` - Translation removed * `26` - Suggestion removed * `27` - Translation replaced * `29` - Suggestion removed during cleanup * `30` - Source string changed * `31` - String added * `32` - Bulk status changed * `33` - Visibility changed * `34` - User added * `35` - User removed * `36` - Translation approved * `37` - Marked for edit * `38` - Component removed * `39` - Project removed * `41` - Project renamed * `42` - Component renamed * `43` - Moved component * `45` - Contributor joined * `46` - Announcement posted * `47` - Alert triggered * `48` - Language added * `49` - Language requested * `50` - Project created * `51` - Component created * `52` - User invited * `53` - Repository notification received * `54` - Translation replaced file by upload * `55` - License changed * `56` - Contributor agreement changed * `57` - Screenshot added * `58` - Screenshot uploaded * `59` - String updated in the repository * `60` - Add-on installed * `61` - Add-on configuration changed * `62` - Add-on uninstalled * `63` - String removed * `64` - Comment removed * `65` - Comment resolved * `66` - Explanation updated * `67` - Category removed * `68` - Category renamed * `69` - Category moved * `70` - Saving string failed * `71` - String added in the repository * `72` - String updated in the upload * `73` - String added in the upload * `74` - Translation updated by source upload * `75` - Component translation completed
:page (Integer) —

A page number within the paginated result set.
:page_size (Integer) —

Number of results to return per page.
:timestamp_after (Time)
:timestamp_before (Time)
:user (String)

Returns:

(PaginatedChangeList)

# File 'lib/weblate/api/changes_api.rb', line 31

def changes_list(opts = {})
  data, _status_code, _headers = changes_list_with_http_info(opts)
  data
end

#changes_list_with_http_info(opts = {}) ⇒ `Array<(PaginatedChangeList, Integer, Hash)>`

Changes API.

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:action (Array<Integer>) —
- `0` - Resource updated * `1` - Translation completed * `2` - Translation changed * `5` - Translation added * `3` - Comment added * `4` - Suggestion added * `6` - Automatically translated * `7` - Suggestion accepted * `8` - Translation reverted * `9` - Translation uploaded * `13` - Source string added * `14` - Component locked * `15` - Component unlocked * `17` - Changes committed * `18` - Changes pushed * `19` - Repository reset * `20` - Repository merged * `21` - Repository rebased * `22` - Repository merge failed * `23` - Repository rebase failed * `28` - Repository push failed * `24` - Parsing failed * `25` - Translation removed * `26` - Suggestion removed * `27` - Translation replaced * `29` - Suggestion removed during cleanup * `30` - Source string changed * `31` - String added * `32` - Bulk status changed * `33` - Visibility changed * `34` - User added * `35` - User removed * `36` - Translation approved * `37` - Marked for edit * `38` - Component removed * `39` - Project removed * `41` - Project renamed * `42` - Component renamed * `43` - Moved component * `45` - Contributor joined * `46` - Announcement posted * `47` - Alert triggered * `48` - Language added * `49` - Language requested * `50` - Project created * `51` - Component created * `52` - User invited * `53` - Repository notification received * `54` - Translation replaced file by upload * `55` - License changed * `56` - Contributor agreement changed * `57` - Screenshot added * `58` - Screenshot uploaded * `59` - String updated in the repository * `60` - Add-on installed * `61` - Add-on configuration changed * `62` - Add-on uninstalled * `63` - String removed * `64` - Comment removed * `65` - Comment resolved * `66` - Explanation updated * `67` - Category removed * `68` - Category renamed * `69` - Category moved * `70` - Saving string failed * `71` - String added in the repository * `72` - String updated in the upload * `73` - String added in the upload * `74` - Translation updated by source upload * `75` - Component translation completed
:page (Integer) —

A page number within the paginated result set.
:page_size (Integer) —

Number of results to return per page.
:timestamp_after (Time)
:timestamp_before (Time)
:user (String)

Returns:

(Array<(PaginatedChangeList, Integer, Hash)>) —

PaginatedChangeList data, response status code and response headers

# File 'lib/weblate/api/changes_api.rb', line 45

def changes_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ChangesApi.changes_list ...'
  end
  allowable_values = [0, 1, 13, 14, 15, 17, 18, 19, 2, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 3, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 4, 41, 42, 43, 45, 46, 47, 48, 49, 5, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 6, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 7, 70, 71, 72, 73, 74, 75, 8, 9]
  if @api_client.config.client_side_validation && opts[:'action'] && !opts[:'action'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"action\", must include one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/changes/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'action'] = @api_client.build_collection_param(opts[:'action'], :multi) if !opts[:'action'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'timestamp_after'] = opts[:'timestamp_after'] if !opts[:'timestamp_after'].nil?
  query_params[:'timestamp_before'] = opts[:'timestamp_before'] if !opts[:'timestamp_before'].nil?
  query_params[:'user'] = opts[:'user'] if !opts[:'user'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'PaginatedChangeList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['tokenAuth']

  new_options = opts.merge(
    :operation => :"ChangesApi.changes_list",
    :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: ChangesApi#changes_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#changes_retrieve(id, opts = {}) ⇒ `Change`

Changes API.

Parameters:

id (String)
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(Change)

# File 'lib/weblate/api/changes_api.rb', line 103

def changes_retrieve(id, opts = {})
  data, _status_code, _headers = changes_retrieve_with_http_info(id, opts)
  data
end

#changes_retrieve_with_http_info(id, opts = {}) ⇒ `Array<(Change, Integer, Hash)>`

Changes API.

Parameters:

id (String)
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(Array<(Change, Integer, Hash)>) —

Change data, response status code and response headers

# File 'lib/weblate/api/changes_api.rb', line 112

def changes_retrieve_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ChangesApi.changes_retrieve ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling ChangesApi.changes_retrieve"
  end
  pattern = Regexp.new(/^[^\/]+$/)
  if @api_client.config.client_side_validation && id !~ pattern
    fail ArgumentError, "invalid value for 'id' when calling ChangesApi.changes_retrieve, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/changes/{id}/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Change'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['tokenAuth']

  new_options = opts.merge(
    :operation => :"ChangesApi.changes_retrieve",
    :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: ChangesApi#changes_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

Class: Weblate::ChangesApi

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ChangesApi

Instance Attribute Details

#api_client ⇒ Object

Instance Method Details

#changes_list(opts = {}) ⇒ PaginatedChangeList

#changes_list_with_http_info(opts = {}) ⇒ Array<(PaginatedChangeList, Integer, Hash)>

#changes_retrieve(id, opts = {}) ⇒ Change

#changes_retrieve_with_http_info(id, opts = {}) ⇒ Array<(Change, Integer, Hash)>

#initialize(api_client = ApiClient.default) ⇒ `ChangesApi`

#api_client ⇒ `Object`

#changes_list(opts = {}) ⇒ `PaginatedChangeList`

#changes_list_with_http_info(opts = {}) ⇒ `Array<(PaginatedChangeList, Integer, Hash)>`

#changes_retrieve(id, opts = {}) ⇒ `Change`

#changes_retrieve_with_http_info(id, opts = {}) ⇒ `Array<(Change, Integer, Hash)>`