Module: Crowdin::ApiResources::Bundles

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

Instance Method Summary collapse

Instance Method Details

#add_bundle(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
35
36
37
 
# File 'lib/crowdin-api/api_resources/bundles.rb', line 24

def add_bundle(query = {}, project_id = config.project_id)
  project_id || raise_project_id_is_required_error
  %i[name format sourcePatterns exportPattern].each do |param|
    query[param] || raise_parameter_is_required_error(param)
  end

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

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

Parameters:

  • bundle_id (Integer) —

    Bundle ID

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

    Request Body



140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/crowdin-api/api_resources/bundles.rb', line 140

def bundle_list_files(bundle_id, query = {}, project_id = config.project_id)
  bundle_id  || raise_parameter_is_required_error(:bundle_id)
  project_id || raise_project_id_is_required_error

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

#check_bundle_export_status(bundle_id, export_id, project_id = config.project_id) ⇒ Object

Parameters:

  • bundle_id (Integer) —

    Bundle ID

  • export_id (String) —

    Export ID



58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/crowdin-api/api_resources/bundles.rb', line 58

def check_bundle_export_status(bundle_id, export_id, project_id = config.project_id)
  bundle_id || raise_parameter_is_required_error(:bundle_id)
  export_id || raise_parameter_is_required_error(:export_id)
  project_id || raise_project_id_is_required_error

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

#delete_bundle(bundle_id, project_id = config.project_id) ⇒ Object

Parameters:

  • bundle_id (Integer) —

    Bundle ID



107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/crowdin-api/api_resources/bundles.rb', line 107

def delete_bundle(bundle_id, project_id = config.project_id)
  bundle_id  || raise_parameter_is_required_error(:bundle_id)
  project_id || raise_project_id_is_required_error

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

#download_bundle(bundle_id, export_id, destination = nil, project_id = config.project_id) ⇒ Object

Parameters:

  • bundle_id (Integer) —

    Bundle ID

  • export_id (String) —

    Export ID

  • destination (String) (defaults to: nil) —

    Destination of File



76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/crowdin-api/api_resources/bundles.rb', line 76

def download_bundle(bundle_id, export_id, destination = nil, project_id = config.project_id)
  bundle_id  || raise_parameter_is_required_error(:bundle_id)
  export_id  || raise_parameter_is_required_error(:export_id)
  project_id || raise_project_id_is_required_error

  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/projects/#{project_id}/bundles/#{bundle_id}/exports/#{export_id}/download"
  )
  Web::SendRequest.new(request, destination).perform
end

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

Parameters:

  • bundle_id (Integer) —

    Bundle ID

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

    Request Body



123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/crowdin-api/api_resources/bundles.rb', line 123

def edit_bundle(bundle_id, query = {}, project_id = config.project_id)
  bundle_id  || raise_parameter_is_required_error(:bundle_id)
  project_id || raise_project_id_is_required_error

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

#export_bundle(bundle_id, project_id = config.project_id) ⇒ Object

Parameters:

  • bundle_id (Integer) —

    Bundle ID



42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/crowdin-api/api_resources/bundles.rb', line 42

def export_bundle(bundle_id, project_id = config.project_id)
  bundle_id  || raise_parameter_is_required_error(:bundle_id)
  project_id || raise_project_id_is_required_error

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

#get_bundle(bundle_id, project_id = config.project_id) ⇒ Object

Parameters:

  • bundle_id (Integer) —

    Bundle ID



92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/crowdin-api/api_resources/bundles.rb', line 92

def get_bundle(bundle_id, project_id = config.project_id)
  bundle_id  || raise_parameter_is_required_error(:bundle_id)
  project_id || raise_project_id_is_required_error

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

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

Parameters:

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

    Request Body



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

def list_bundles(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}/bundles",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end