crowdin-api 1.1.1 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4ec79bf0a2483fca9502087888c52323ebe12c0c755897f0c71759722f74fd89
-  data.tar.gz: b38ea8b69348734224f7631403f2ac0c6b33496c9098556688c4e648c85cbb6c
+  metadata.gz: 92b7e78f934fe0170055ff679da134b9b4444caba51677c19ba8903a1eaf55ec
+  data.tar.gz: 22ebff0813e0d4d1c0217a3c9163e738f3b58fa6124d09f5cfff4cf3ddb3330c
 SHA512:
-  metadata.gz: aea9c98831b8abfacb4fe670d4d9025cee21cf33334083645ad9f4767f5d375249a9d2fde8ab7739fec3ca61f1ade03496f23b12377414ce18f62eea2819f453
-  data.tar.gz: 5e69bf63d256bb96faaa11d749635253ad4625b6741d3d312cd7b61af127bd09d494ee87350b7b589e9c8c78de807bccba25286480627aa0e80153554e81fd1f
+  metadata.gz: e0705ea1264b498c2a8080445ab79ccc353347e65f928acd68008ea96a1a8a97c0c947b332d88fb9171ba1d02001e231498cc34102d2c8dd6967d1b858204f7a
+  data.tar.gz: 81c748f6b6cf1090bb218d486548634c37c2a10594d937745abdd07e2cea097a8e9dd64617a85e85c06cc35b97b7ac4a5f4ffa3bc7846970efa860ef99fe3522

data/.github/workflows/docs.yml

@@ -0,0 +1,31 @@
+name: Docs
+
+on:
+  push:
+    tags:
+      - '*'
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby 2.6
+        uses: ruby/setup-ruby@477b21f02be01bcb8030d50f37cfec92bfa615b6
+        with:
+          ruby-version: 2.6
+      - run: bundle install
+
+      - name: Cleanup the Readme
+        run: |
+          sed -i /\<div/d README.md
+          sed -i /\<\\/div/d README.md
+
+      - name: Generate Docs
+        run: yardoc lib/crowdin-api/api_resources/*.rb
+
+      - name: Deploy 🚀
+        uses: JamesIves/github-pages-deploy-action@v4.4.1
+        with:
+          branch: gh-pages
+          folder: doc

data/.github/workflows/test-and-lint.yml

@@ -12,7 +12,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['2.6', '2.7', '3.0']
+        ruby-version: [ '2.6', '2.7', '3.0' ]
     steps:
       - name: Checkout code
         uses: actions/checkout@v2

data/.gitignore

@@ -1,12 +1,12 @@
 # Ignore Ruby logs
-.ruby-version
 .idea
 
 # Ignore MacOS logs
 .DS_Store
 
-# Ignore versioning file
+# Ignore versioning files
 Gemfile.lock
+.ruby-version
 
 # Ignore tests coverage folder
 coverage

data/.rubocop_todo.yml

@@ -1,13 +1,13 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2021-12-13 20:26:23 UTC using RuboCop version 1.23.0.
+# on 2022-08-12 15:14:54 UTC using RuboCop version 1.26.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
 # Offense count: 1
-# Cop supports --auto-correct.
+# This cop supports safe auto-correction (--auto-correct).
 # Configuration parameters: Include.
 # Include: **/*.gemspec
 Gemspec/RequireMFA:
@@ -22,118 +22,184 @@ Gemspec/RequiredRubyVersion:
     - 'crowdin-api.gemspec'
 
 # Offense count: 2
-# Cop supports --auto-correct.
-# Configuration parameters: AllowForAlignment, AllowBeforeTrailingComments, ForceEqualSignAlignment.
-Layout/ExtraSpacing:
+# This cop supports safe auto-correction (--auto-correct).
+# Configuration parameters: EnforcedStyle, IndentOneStep, IndentationWidth.
+# SupportedStyles: case, end
+Layout/CaseIndentation:
   Exclude:
-    - 'bin/crowdin-console'
+    - 'lib/crowdin-api/client/client.rb'
 
 # Offense count: 1
-# Cop supports --auto-correct.
+# This cop supports safe auto-correction (--auto-correct).
+# Configuration parameters: EnforcedStyleAlignWith, Severity.
+# SupportedStylesAlignWith: keyword, variable, start_of_line
+Layout/EndAlignment:
+  Exclude:
+    - 'lib/crowdin-api/client/client.rb'
+
+# Offense count: 4
+# This cop supports safe auto-correction (--auto-correct).
+# Configuration parameters: AllowMultipleStyles, EnforcedHashRocketStyle, EnforcedColonStyle, EnforcedLastArgumentHashStyle.
+# SupportedHashRocketStyles: key, separator, table
+# SupportedColonStyles: key, separator, table
+# SupportedLastArgumentHashStyles: always_inspect, always_ignore, ignore_implicit, ignore_explicit
+Layout/HashAlignment:
+  Exclude:
+    - 'lib/crowdin-api/client/configuration.rb'
+
+# Offense count: 14
+# This cop supports safe auto-correction (--auto-correct).
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: normal, indented_internal_methods
+Layout/IndentationConsistency:
+  Exclude:
+    - 'lib/crowdin-api/client/client.rb'
+    - 'lib/crowdin-api/core/request.rb'
+    - 'lib/crowdin-api/core/send_request.rb'
+
+# Offense count: 14
+# This cop supports safe auto-correction (--auto-correct).
+# Configuration parameters: Width, IgnoredPatterns.
+Layout/IndentationWidth:
+  Exclude:
+    - 'lib/crowdin-api/client/client.rb'
+    - 'lib/crowdin-api/core/request.rb'
+    - 'lib/crowdin-api/core/send_request.rb'
+
+# Offense count: 4
+# This cop supports safe auto-correction (--auto-correct).
 # Configuration parameters: AllowForAlignment, EnforcedStyleForExponentOperator.
 # SupportedStylesForExponentOperator: space, no_space
 Layout/SpaceAroundOperators:
   Exclude:
     - 'crowdin-api.gemspec'
+    - 'spec/api_resources/projects_spec.rb'
 
-# Offense count: 2
+# Offense count: 3
 # Configuration parameters: IgnoredMethods, CountRepeatedAttributes.
 Metrics/AbcSize:
-  Max: 23
+  Max: 42
 
-# Offense count: 1
+# Offense count: 46
 # Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
 # IgnoredMethods: refine
 Metrics/BlockLength:
-  Max: 54
+  Max: 171
 
-# Offense count: 4
+# Offense count: 1
+# Configuration parameters: CountComments, CountAsOne.
+Metrics/ClassLength:
+  Max: 101
+
+# Offense count: 1
+# Configuration parameters: IgnoredMethods.
+Metrics/CyclomaticComplexity:
+  Max: 18
+
+# Offense count: 6
 # Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
 Metrics/MethodLength:
-  Max: 18
+  Max: 41
 
-# Offense count: 2
+# Offense count: 8
 # Configuration parameters: CountComments, CountAsOne.
 Metrics/ModuleLength:
-  Max: 205
+  Max: 256
 
-# Offense count: 1
-# Configuration parameters: CountKeywordArgs, MaxOptionalParameters.
+# Offense count: 2
+# Configuration parameters: Max, CountKeywordArgs.
 Metrics/ParameterLists:
-  Max: 6
+  MaxOptionalParameters: 4
+
+# Offense count: 1
+# Configuration parameters: IgnoredMethods.
+Metrics/PerceivedComplexity:
+  Max: 19
 
 # Offense count: 1
 Naming/AccessorMethodName:
   Exclude:
-    - 'lib/crowdin-api/core/request.rb'
+    - 'lib/crowdin-api/api_resources/users.rb'
 
-# Offense count: 3
+# Offense count: 1
 # Configuration parameters: ExpectMatchingDefinition, CheckDefinitionPathHierarchy, CheckDefinitionPathHierarchyRoots, Regex, IgnoreExecutableScripts, AllowedAcronyms.
 # CheckDefinitionPathHierarchyRoots: lib, spec, test, src
 # AllowedAcronyms: CLI, DSL, ACL, API, ASCII, CPU, CSS, DNS, EOF, GUID, HTML, HTTP, HTTPS, ID, IP, JSON, LHS, QPS, RAM, RHS, RPC, SLA, SMTP, SQL, SSH, TCP, TLS, TTL, UDP, UI, UID, UUID, URI, URL, UTF8, VM, XML, XMPP, XSRF, XSS
 Naming/FileName:
   Exclude:
     - 'lib/crowdin-api.rb'
-    - 'spec/core/config-instance_spec.rb'
-    - 'spec/crowdin-api_spec.rb'
 
-# Offense count: 3
+# Offense count: 2
 # Configuration parameters: EnforcedStyleForLeadingUnderscores.
 # SupportedStylesForLeadingUnderscores: disallowed, required, optional
 Naming/MemoizedInstanceVariableName:
   Exclude:
     - 'lib/crowdin-api/client/client.rb'
 
-# Offense count: 3
-# Cop supports --auto-correct.
-# Configuration parameters: PreferredName.
-Naming/RescuedExceptionsVariableName:
-  Exclude:
-    - 'lib/crowdin-api/core/request.rb'
-
 # Offense count: 7
-# Cop supports --auto-correct.
+# This cop supports safe auto-correction (--auto-correct).
 # Configuration parameters: EnforcedStyle.
 # SupportedStyles: separated, grouped
 Style/AccessorGrouping:
   Exclude:
-    - 'lib/crowdin-api/client/client.rb'
     - 'lib/crowdin-api/client/configuration.rb'
+    - 'lib/crowdin-api/core/request.rb'
 
 # Offense count: 2
-# Cop supports --auto-correct.
+# This cop supports unsafe auto-correction (--auto-correct-all).
 Style/CollectionCompact:
   Exclude:
     - 'lib/crowdin-api/core/request.rb'
 
-# Offense count: 12
+# Offense count: 27
 # Configuration parameters: AllowedConstants.
 Style/Documentation:
+  Enabled: false
+
+# Offense count: 1
+# This cop supports safe auto-correction (--auto-correct).
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: allowed_in_returns, forbidden
+Style/DoubleNegation:
   Exclude:
-    - 'spec/**/*'
-    - 'test/**/*'
-    - 'lib/crowdin-api/api-resources/languages.rb'
-    - 'lib/crowdin-api/api-resources/projects.rb'
-    - 'lib/crowdin-api/api-resources/source_files.rb'
-    - 'lib/crowdin-api/api-resources/source_strings.rb'
-    - 'lib/crowdin-api/api-resources/storages.rb'
-    - 'lib/crowdin-api/api-resources/translation_status.rb'
-    - 'lib/crowdin-api/api-resources/translations.rb'
-    - 'lib/crowdin-api/api-resources/workflows.rb'
-    - 'lib/crowdin-api/client/client.rb'
     - 'lib/crowdin-api/client/configuration.rb'
-    - 'lib/crowdin-api/core/api_errors_raiser.rb'
-    - 'lib/crowdin-api/core/request.rb'
 
 # Offense count: 1
-# Cop supports --auto-correct.
+# This cop supports safe auto-correction (--auto-correct).
 # Configuration parameters: EnforcedStyle.
 # SupportedStyles: always, always_true, never
 Style/FrozenStringLiteralComment:
   Exclude:
     - 'bin/crowdin-console'
 
+# Offense count: 1
+# Configuration parameters: MinBodyLength.
+Style/GuardClause:
+  Exclude:
+    - 'lib/crowdin-api/client/client.rb'
+
 # Offense count: 1
 Style/MixinUsage:
   Exclude:
     - 'bin/crowdin-console'
+
+# Offense count: 1
+# This cop supports safe auto-correction (--auto-correct).
+Style/RedundantFreeze:
+  Exclude:
+    - 'lib/crowdin-api/core/fetch_all_extensions.rb'
+
+# Offense count: 8
+# This cop supports safe auto-correction (--auto-correct).
+# Configuration parameters: EnforcedStyle, ConsistentQuotesInMultiline.
+# SupportedStyles: single_quotes, double_quotes
+Style/StringLiterals:
+  Exclude:
+    - 'spec/api_resources/projects_spec.rb'
+
+# Offense count: 2
+# This cop supports safe auto-correction (--auto-correct).
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Layout/LineLength:
+  Max: 122

data/Gemfile

@@ -2,4 +2,7 @@
 
 source 'https://rubygems.org'
 
+# For Documentation
+gem 'yard', '~> 0.9.28'
+
 gemspec

data/README.md

@@ -1,4 +1,4 @@
-[<p align='center'><img src='https://support.crowdin.com/assets/logos/crowdin-dark-symbol.png' data-canonical-src='https://support.crowdin.com/assets/logos/crowdin-dark-symbol.png' width='200' height='200' align='center'/></p>](https://crowdin.com)
+[<p align='center'><img src='https://support.crowdin.com/assets/logos/crowdin-dark-symbol.png' data-canonical-src='https://support.crowdin.com/assets/logos/crowdin-dark-symbol.png' width='150' height='150' align='center'/></p>](https://crowdin.com)
 
 # Crowdin Ruby client
 
@@ -6,11 +6,11 @@ The Crowdin Ruby client is a lightweight interface to the Crowdin API v2. It pro
 
 Crowdin API is a full-featured RESTful API that helps you to integrate localization into your development process. The endpoints that we use allow you to easily make calls to retrieve information and to execute actions needed.
 
-For more about Crowdin API v2 see the documentation:
-- [Crowdin](https://support.crowdin.com/api/v2/)
-- [Crowdin Enterprise](https://support.crowdin.com/enterprise/api/)
+<div align="center">
 
-### Status
+[**`API Client Docs`**](http://crowdin.github.io/crowdin-api-client-ruby/) &nbsp;|&nbsp;
+[**`Crowdin API`**](https://developer.crowdin.com/api/v2/) &nbsp;|&nbsp;
+[**`Crowdin Enterprise API`**](https://developer.crowdin.com/enterprise/api/v2/)
 
 [![Gem](https://img.shields.io/gem/v/crowdin-api?logo=ruby&cacheSeconds=1800)](https://rubygems.org/gems/crowdin-api)
 [![Gem](https://img.shields.io/gem/dt/crowdin-api?cacheSeconds=1800)](https://rubygems.org/gems/crowdin-api)
@@ -21,22 +21,29 @@ For more about Crowdin API v2 see the documentation:
 [![GitHub issues](https://img.shields.io/github/issues/crowdin/crowdin-api-client-ruby?cacheSeconds=1800)](https://github.com/crowdin/crowdin-api-client-ruby/issues)
 [![GitHub](https://img.shields.io/github/license/crowdin/crowdin-api-client-ruby?cacheSeconds=1800)](https://github.com/crowdin/crowdin-api-client-ruby/blob/main/LICENSE)
 
+</div>
+
 ## Table of Contents
+* [Requirements](#requirements)
 * [Installation](#installation)
 * [Quick Start](#quick-start)
   * [Initialization](#initialization)
-  * [How to call methods](#how-to-call-methods)
+  * [Usage](#usage)
+  * [Fetch all records](#fetch-all-records)
   * [Command-Line Client](#command-line-client)
 * [Seeking Assistance](#seeking-assistance)
 * [Contributing](#contributing)
 * [License](#license)
 
+## Requirements
+* Ruby >= 2.4
+
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```gemfile
-gem 'crowdin-api', '~> 1.1.0'
+gem 'crowdin-api', '~> 1.5.0'
 ```
 
 And then execute:
@@ -62,6 +69,7 @@ gem install crowdin-api
 ## Quick start
 
 ### Initialization
+
 ```ruby
 require 'crowdin-api'
 
@@ -70,14 +78,15 @@ crowdin = Crowdin::Client.new do |config|
   config.api_token = 'YourApiToken'
 end
 
-# Or you can intialize Enterprise Client instance by specifying your organization_domain in config options
+# Or you can initialize Enterprise Client instance by specifying your
+# organization_domain in config options
 crowdin = Crowdin::Client.new do |config|
   config.api_token = 'YourEnterpriseApiToken'
   config.organization_domain = 'YourOrganizationDomain'
 end
-# Note: we use full specified organization domain if that includes .com
+# Note: we use full specified organization domain if that includes '.com'
 # config.organization_domain = your_domain -> https://your_domain.api.crowdin.com
-# config.organization_domain = your_domain.com -> your_domain.com
+# config.organization_domain = your_domain.com -> https://your_domain.com
 
 # All supported Crowdin Client config options now:
 crowdin = Crowdin::Client.new do |config|
@@ -86,8 +95,8 @@ crowdin = Crowdin::Client.new do |config|
   config.project_id = 'YourProjectId' # [Integer] nil by default
   config.enable_logger = true # [Boolean] false by default
 end
-# Note: Client will initialize default Logger instance if you have specify enable_logger to true,
-# you can change it by crowdin.logger = YourLogger
+# Note: Client will initialize default Logger instance if you have specify
+# enable_logger to true, you can change it by crowdin.logger = YourLogger
 
 # Also you can specify proxy by adding it to ENV['http_proxy'] before Client initialization
 ```
@@ -115,14 +124,20 @@ projects = crowdin.list_projects(offset: 10, limit: 20)
 # Get specified project
 project = crowdin.get_project(your_project_id)
 
+# Edit project
+project = crowdin.edit_project(project_id, [{ op: 'replace',
+                                              path: '/name',
+                                              value: 'your_new_project_name' }])
+
 # Add Storage
 storage = crowdin.add_storage(File.open('YourFilename.extension', 'r'))
-# or you can specify only filename
+# or you can specify only absolute path to file
 storage = crowdin.add_storage('YourFilename.extension')
 
 # Download file
-filename = crowdin.download_file(your_file_id, your_destination, your_project_id)
-# your_destination - filename or full path to file, default - saving to currect directory with default filename
+file = crowdin.download_file(your_file_id, your_destination, your_project_id)
+# your_destination - filename or absolute path to file, optional
+# Without destination option file will be saved to the current directory with a default filename
 # project_id is optional, as it can be initialized with a Crowdin Client
 
 # File revisions
@@ -130,6 +145,35 @@ filename = crowdin.download_file(your_file_id, your_destination, your_project_id
 file_revisions = crowdin.list_file_revisions(your_file_id, limit: 10)
 # or you can specify your project_id
 file_revisions = crowdin.list_file_revisions(your_file_id, { limit: 10 }, your_project_id)
+
+# Note: more examples you can find in spec folder
+```
+
+### Fetch all records
+
+There is a possibility to fetch all records from paginatable methods using `fetch_all` method.
+
+```ruby
+# FetchAll options:
+# * limit, Integer, default: 500 | How many records need to load per one request
+# * offset, Integer, default: 0
+# * request_delay, Integer (seconds), default: 0 | Delay between requests. To specify a delay in milliseconds use float values like 0.100
+
+# Examples:
+
+@crowdin.fetch_all(:list_projects)
+
+# with options
+@crowdin.fetch_all(:list_projects, { limit: 10, request_delay: 1 })
+
+# playing with response per fetch
+# Note: the block actually don't make any effect to finite result
+@crowdin.fetch_all(:list_projects, { limit: 10, request_delay: 1 }) { |response| puts response['data'] }
+
+# also, you could specify a retry configuration to handle some exceptions
+# fetch all execution will be terminated if response status code is the same as one of the error_messages array value
+# otherwise, the request will be retried so many times, as indicated at retries_count
+@crowdin.fetch_all(:list_projects, {}, { request_delay: 2, retries_count: 3, error_messages: ['401'] })
 ```
 
 ### Command-Line Client
@@ -143,9 +187,9 @@ $ bundle exec crowdin-console --enable-logger --api-token API_TOKEN --project-id
 Or Crowdin Enterprise
 
 ```console
-$ bundle exec crowdin-console --enable-logger --enterprise --api-token API_TOKEN --organization-domain YOUR_DOMAIN --project-id PROJECT_ID
+$ bundle exec crowdin-console --enable-logger --enterprise --api-token API_TOKEN --organization-domain DOMAIN --project-id PROJECT_ID
 ```
-Note: you can specify full organization domain by adding .com
+Note: you can specify full organization domain by adding '.com'
 
 When execute you'll have IRB console with configured *@crowdin* instance
 

data/bin/crowdin-console

@@ -12,12 +12,12 @@ require 'optparse'
 #
 #  bundle exec crowdin-console --enable-logger --api-token YOUR_API_TOKEN --project-id YOUR_PROJECT_ID
 #
-# or Enterpise API:
+# or Enterprise API:
 #
 #  bundle exec crowdin-console --enterprise --api-token YOUR_ENTERPRISE_API_TOKEN --organization-domain YOUR_DOMAIN
 #
 
-include Crowdin::Errors::ApiErrorsRaiser
+include Crowdin::Errors::ClcErrorsRaiser
 
 options = {}
 
@@ -27,7 +27,7 @@ OptionParser.new do |opts|
   opts.on('--enterprise', 'Enterprise API')                      { |v| options[:enterprise] = v }
   opts.on('--api-token TOKEN', 'API Token')                      { |v| options[:api_token] = v }
   opts.on('--organization-domain DOMAIN', 'Organization Domain') { |v| options[:organization_domain] = v }
-  opts.on('--project-id ID', 'Project ID')                      { |v| options[:project_id] = v }
+  opts.on('--project-id ID', 'Project ID')                       { |v| options[:project_id] = v }
   opts.on('--enable-logger', 'Enable logger')                    { |v| options[:enable_logger] = v }
 end.parse!
 
@@ -39,8 +39,8 @@ if options[:enterprise]
   @crowdin = Crowdin::Client.new do |config|
     config.api_token           = options[:api_token]
     config.organization_domain = options[:organization_domain]
-    config.enable_logger       = options[:enable_logger]       || false
-    config.project_id          = options[:project_id]          || nil
+    config.enable_logger       = options[:enable_logger] || false
+    config.project_id          = options[:project_id]    || nil
   end
 else
   @crowdin = Crowdin::Client.new do |config|

data/crowdin-api.gemspec

@@ -13,7 +13,6 @@ Gem::Specification.new do |gem|
   gem.license     = 'MIT'
 
   gem.files         = `git ls-files`.split("\n")
-  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   gem.require_paths = ['lib']
   gem.bindir        = 'bin'
   gem.executables   << 'crowdin-console'
@@ -25,9 +24,9 @@ Gem::Specification.new do |gem|
 
   gem.add_development_dependency 'bundler', '~> 2.2', '>= 2.2.32'
   gem.add_development_dependency 'codecov', '~> 0.6.0'
+  gem.add_development_dependency 'pry', '~> 0.14.1'
   gem.add_development_dependency 'rake', '~> 13.0', '>= 13.0.6'
   gem.add_development_dependency 'rspec', '~> 3.10'
   gem.add_development_dependency 'rubocop', '~> 1.23'
-  gem.add_development_dependency 'sinatra', '~> 2.1'
   gem.add_development_dependency 'webmock', '~> 3.14'
 end

data/lib/crowdin-api/api_resources/bundles.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+module Crowdin
+  module ApiResources
+    module Bundles
+      # @param query [Hash] Request Body
+      # * {https://developer.crowdin.com/api/v2/#operation/api.projects.bundles.getMany  API Documentation}
+      # * {https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.bundles.getMany  Enterprise API Documentation}
+      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
+
+      # @param query [Hash] Request Body
+      # * {https://developer.crowdin.com/api/v2/#operation/api.projects.bundles.post  API Documentation}
+      # * {https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.bundles.post  Enterprise API Documentation}
+      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
+
+      # @param bundle_id [Integer] Bundle ID
+      # * {https://developer.crowdin.com/api/v2/#operation/api.projects.bundles.get  API Documentation}
+      # * {https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.bundles.get  Enterprise API Documentation}
+      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
+
+      # @param bundle_id [Integer] Bundle ID
+      # * {https://developer.crowdin.com/api/v2/#operation/api.projects.bundles.delete  API Documentation}
+      # * {https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.bundles.delete  Enterprise API Documentation}
+      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
+
+      # @param bundle_id [Integer] Bundle ID
+      # @param query [Hash] Request Body
+      # * {https://developer.crowdin.com/api/v2/#operation/api.projects.bundles.patch  API Documentation}
+      # * {https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.bundles.patch  Enterprise API Documentation}
+      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
+
+      # @param bundle_id [Integer] Bundle ID
+      # @param query [Hash] Request Body
+      # * {https://developer.crowdin.com/api/v2/#operation/api.projects.bundles.files.getMany  API Documentation}
+      # * {https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.bundles.files.getMany  Enterprise API Documentation}
+      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
+    end
+  end
+end