Module: Crowdin::ApiResources::Screenshots

Defined in:
lib/crowdin-api/api_resources/screenshots.rb

Instance Method Summary collapse

Instance Method Details

#add_screenshot(query = {}, project_id = config.project_id) ⇒ Object

Parameters:

  • query (Hash) (defaults to: {}) —

    Request Body



24
25
26
27
28
29
30
31
32
33
34
 
# File 'lib/crowdin-api/api_resources/screenshots.rb', line 24

def add_screenshot(query = {}, project_id = config.project_id)
  project_id || raise_project_id_is_required_error

  request = Web::Request.new(
    connection,
    :post,
    "#{config.target_api_url}/projects/#{project_id}/screenshots",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end

#add_tag(screenshot_id = nil, query = {}, project_id = config.project_id) ⇒ Object

Parameters:

  • screenshot_id (Integer) (defaults to: nil) —

    Screenshot Identifier

  • query (Hash) (defaults to: {}) —

    Request Body



138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/crowdin-api/api_resources/screenshots.rb', line 138

def add_tag(screenshot_id = nil, query = {}, project_id = config.project_id)
  screenshot_id || raise_parameter_is_required_error(:screenshot_id)
  project_id    || raise_project_id_is_required_error

  request = Web::Request.new(
    connection,
    :post,
    "#{config.target_api_url}/projects/#{project_id}/screenshots/#{screenshot_id}/tags",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end

#clear_tags(screenshot_id = nil, project_id = config.project_id) ⇒ Object

Parameters:

  • screenshot_id (Integer) (defaults to: nil) —

    Screenshot Identifier



154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/crowdin-api/api_resources/screenshots.rb', line 154

def clear_tags(screenshot_id = nil, project_id = config.project_id)
  screenshot_id || raise_parameter_is_required_error(:screenshot_id)
  project_id    || raise_project_id_is_required_error

  request = Web::Request.new(
    connection,
    :delete,
    "#{config.target_api_url}/projects/#{project_id}/screenshots/#{screenshot_id}/tags"
  )
  Web::SendRequest.new(request).perform
end

#delete_screenshot(screenshot_id = nil, project_id = config.project_id) ⇒ Object

Parameters:

  • screenshot_id (Integer) (defaults to: nil) —

    Screenshot Identifier



71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/crowdin-api/api_resources/screenshots.rb', line 71

def delete_screenshot(screenshot_id = nil, project_id = config.project_id)
  screenshot_id || raise_parameter_is_required_error(:screenshot_id)
  project_id    || raise_project_id_is_required_error

  request = Web::Request.new(
    connection,
    :delete,
    "#{config.target_api_url}/projects/#{project_id}/screenshots/#{screenshot_id}"
  )
  Web::SendRequest.new(request).perform
end

#delete_tag(screenshot_id = nil, tag_id = nil, project_id = config.project_id) ⇒ Object

Parameters:

  • screenshot_id (Integer) (defaults to: nil) —

    Screenshot Identifier

  • tag_id (Integer) (defaults to: nil) —

    Tag Identifier



187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/crowdin-api/api_resources/screenshots.rb', line 187

def delete_tag(screenshot_id = nil, tag_id = nil, project_id = config.project_id)
  screenshot_id || raise_parameter_is_required_error(:screenshot_id)
  tag_id        || raise_parameter_is_required_error(:tag_id)
  project_id    || raise_project_id_is_required_error

  request = Web::Request.new(
    connection,
    :delete,
    "#{config.target_api_url}/projects/#{project_id}/screenshots/#{screenshot_id}/tags/#{tag_id}"
  )
  Web::SendRequest.new(request).perform
end

#edit_screenshot(screenshot_id = nil, query = {}, project_id = config.project_id) ⇒ Object

Parameters:

  • screenshot_id (Integer) (defaults to: nil) —

    Screenshot Identifier

  • query (Hash) (defaults to: {}) —

    Request Body



87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/crowdin-api/api_resources/screenshots.rb', line 87

def edit_screenshot(screenshot_id = nil, query = {}, project_id = config.project_id)
  screenshot_id || raise_parameter_is_required_error(:screenshot_id)
  project_id    || raise_project_id_is_required_error

  request = Web::Request.new(
    connection,
    :patch,
    "#{config.target_api_url}/projects/#{project_id}/screenshots/#{screenshot_id}",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end

#edit_tag(screenshot_id = nil, tag_id = nil, query = {}, project_id = config.project_id) ⇒ Object

Parameters:

  • screenshot_id (Integer) (defaults to: nil) —

    Screenshot Identifier

  • tag_id (Integer) (defaults to: nil) —

    Tag Identifier

  • query (Hash) (defaults to: {}) —

    Request Body



205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/crowdin-api/api_resources/screenshots.rb', line 205

def edit_tag(screenshot_id = nil, tag_id = nil, query = {}, project_id = config.project_id)
  screenshot_id || raise_parameter_is_required_error(:screenshot_id)
  tag_id        || raise_parameter_is_required_error(:tag_id)
  project_id    || raise_project_id_is_required_error

  request = Web::Request.new(
    connection,
    :patch,
    "#{config.target_api_url}/projects/#{project_id}/screenshots/#{screenshot_id}/tags/#{tag_id}",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end

#get_screenshot(screenshot_id = nil, project_id = config.project_id) ⇒ Object

Parameters:

  • screenshot_id (Integer) (defaults to: nil) —

    Screenshot Identifier



39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/crowdin-api/api_resources/screenshots.rb', line 39

def get_screenshot(screenshot_id = nil, project_id = config.project_id)
  screenshot_id || raise_parameter_is_required_error(:screenshot_id)
  project_id    || raise_project_id_is_required_error

  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/projects/#{project_id}/screenshots/#{screenshot_id}"
  )
  Web::SendRequest.new(request).perform
end

#get_tag(screenshot_id = nil, tag_id = nil, project_id = config.project_id) ⇒ Object

Parameters:

  • screenshot_id (Integer) (defaults to: nil) —

    Screenshot Identifier

  • tag_id (Integer) (defaults to: nil) —

    Tag Identifier



170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/crowdin-api/api_resources/screenshots.rb', line 170

def get_tag(screenshot_id = nil, tag_id = nil, project_id = config.project_id)
  screenshot_id || raise_parameter_is_required_error(:screenshot_id)
  tag_id        || raise_parameter_is_required_error(:tag_id)
  project_id    || raise_project_id_is_required_error

  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/projects/#{project_id}/screenshots/#{screenshot_id}/tags/#{tag_id}"
  )
  Web::SendRequest.new(request).perform
end

#list_screenshots(query = {}, project_id = config.project_id) ⇒ Object

Parameters:

  • query (Hash) (defaults to: {}) —

    Request Query Parameters



9
10
11
12
13
14
15
16
17
18
19
 
# File 'lib/crowdin-api/api_resources/screenshots.rb', line 9

def list_screenshots(query = {}, project_id = config.project_id)
  project_id || raise_project_id_is_required_error

  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/projects/#{project_id}/screenshots",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end

#list_tags(screenshot_id = nil, query = {}, project_id = config.project_id) ⇒ Object

Parameters:

  • screenshot_id (Integer) (defaults to: nil) —

    Screenshot Identifier

  • query (Hash) (defaults to: {}) —

    Request Query Parameters



104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/crowdin-api/api_resources/screenshots.rb', line 104

def list_tags(screenshot_id = nil, query = {}, project_id = config.project_id)
  screenshot_id || raise_parameter_is_required_error(:screenshot_id)
  project_id    || raise_project_id_is_required_error

  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/projects/#{project_id}/screenshots/#{screenshot_id}/tags",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end

#replace_tags(screenshot_id = nil, query = {}, project_id = config.project_id) ⇒ Object

Parameters:

  • screenshot_id (Integer) (defaults to: nil) —

    Screenshot Identifier

  • query (Hash) (defaults to: {}) —

    Request Body



121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/crowdin-api/api_resources/screenshots.rb', line 121

def replace_tags(screenshot_id = nil, query = {}, project_id = config.project_id)
  screenshot_id || raise_parameter_is_required_error(:screenshot_id)
  project_id    || raise_project_id_is_required_error

  request = Web::Request.new(
    connection,
    :put,
    "#{config.target_api_url}/projects/#{project_id}/screenshots/#{screenshot_id}/tags",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end

#update_screenshot(screenshot_id = nil, query = {}, project_id = config.project_id) ⇒ Object

Parameters:

  • screenshot_id (Integer) (defaults to: nil) —

    Screenshot Identifier

  • query (Hash) (defaults to: {}) —

    Request Body



55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/crowdin-api/api_resources/screenshots.rb', line 55

def update_screenshot(screenshot_id = nil, query = {}, project_id = config.project_id)
  screenshot_id || raise_parameter_is_required_error(:screenshot_id)
  project_id    || raise_project_id_is_required_error

  request = Web::Request.new(
    connection,
    :put,
    "#{config.target_api_url}/projects/#{project_id}/screenshots/#{screenshot_id}",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end