cloudpdf 3.0.0.alpha.20 → 3.0.0.alpha.21

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: a62e737365a4ab440bf04753fbabbf635d6d7028dc8804c66e5bb98dcc241374
4
- data.tar.gz: b196ceb5e909449fdd6082a2827391dad356b9f611298eb1a7034705798b6000
3
+ metadata.gz: 8a10f23f7c3154efb687a0d6f376bf657f38f01e3146f74a4c1a5b98d49cc27c
4
+ data.tar.gz: 1f73e9c53b2b4d5cb55f7261ef709e70c8518afdf222b27716414f450aa9d281
5
5
  SHA512:
6
- metadata.gz: 70a698ea37dd5fe9f4567c231fc3c4dfd43ee1deea87dff05de0c7c26d0510bfd86c00c9b3240399aac7d2b25d597c740a9f3b20e4b9469d28e60e9fb003c6e6
7
- data.tar.gz: bdf1ff5df5da9758f85310ddf339e50dd8cc71150d830c894e6e8686a8603986fc2084b9c5ce3f1846b8d8f47d059edc2fd85cf01d2ebeba449c6648de9b245f
6
+ metadata.gz: 240f3cc0cfa8c158af44834c25eb764900bffda9e434b8effe5593ae16127e30ca5f2f6ee98c0dde84108dee4b58eb8725c15e1dcbd1af8772fa99932592d6e1
7
+ data.tar.gz: ce8d16d5415a3c2805e9d15e7ce2b69dc2ade183efd408a590c346f1728e2e615d60f81db284e52fd5be532418b623860eeb5d4b188390a7fa321d7af95566ee
data/.fern/metadata.json CHANGED
@@ -5,9 +5,9 @@
5
5
  "generatorConfig": {
6
6
  "moduleName": "CloudPDF"
7
7
  },
8
- "originGitCommit": "622018abaf6e4578d1f4d8377982c48b92c9ced3",
8
+ "originGitCommit": "3283147ded32fc15c426768f75557a4d95943d84",
9
9
  "originGitCommitIsDirty": false,
10
10
  "invokedBy": "ci",
11
- "requestedVersion": "3.0.0.alpha.20",
11
+ "requestedVersion": "3.0.0.alpha.21",
12
12
  "ciProvider": "github"
13
13
  }
@@ -157,6 +157,55 @@ module CloudPDF
157
157
  raise error_class.new(response.body, code: code)
158
158
  end
159
159
 
160
+ # A feature names an installed module; any other id is a 400. A module route answers a tenant without its feature
161
+ # 403 FeatureNotEnabled, and one whose feature is stopped 402 FeatureStopped (details.feature, details.stopped).
162
+ # Other replicas apply a change within 30 seconds.
163
+ #
164
+ # @param request_options [Hash]
165
+ # @param params [CloudPDF::Tenants::Types::TenantsUpdateRequest]
166
+ # @option request_options [String] :base_url
167
+ # @option request_options [Hash{String => Object}] :additional_headers
168
+ # @option request_options [Hash{String => Object}] :additional_query_parameters
169
+ # @option request_options [Hash{String => Object}] :additional_body_parameters
170
+ # @option request_options [Integer] :timeout_in_seconds
171
+ # @option params [String] :tenant_id
172
+ #
173
+ # @example
174
+ # client.tenants.update(
175
+ # tenant_id: "tenantId",
176
+ # features: [{
177
+ # id: "id"
178
+ # }]
179
+ # )
180
+ #
181
+ # @return [CloudPDF::Types::TenantsUpdate200Response]
182
+ def update(request_options: {}, **params)
183
+ params = CloudPDF::Internal::Types::Utils.normalize_keys(params)
184
+ request_data = CloudPDF::Tenants::Types::TenantsUpdateRequest.new(params).to_h
185
+ non_body_param_names = %w[tenantId]
186
+ body = request_data.except(*non_body_param_names)
187
+
188
+ request = CloudPDF::Internal::JSON::Request.new(
189
+ base_url: request_options[:base_url],
190
+ method: "PATCH",
191
+ path: "v1/tenants/#{URI.encode_uri_component(params[:tenant_id].to_s)}",
192
+ body: body,
193
+ request_options: request_options
194
+ )
195
+ begin
196
+ response = @client.send(request)
197
+ rescue Net::HTTPRequestTimeout
198
+ raise CloudPDF::Errors::TimeoutError
199
+ end
200
+ code = response.code.to_i
201
+ if code.between?(200, 299)
202
+ (response.body.to_s.empty? ? nil : CloudPDF::Types::TenantsUpdate200Response.load(response.body))
203
+ else
204
+ error_class = CloudPDF::Errors::ResponseError.subclass_for_code(code)
205
+ raise error_class.new(response.body, code: code)
206
+ end
207
+ end
208
+
160
209
  # @param request_options [Hash]
161
210
  # @param params [Hash]
162
211
  # @option request_options [String] :base_url
@@ -0,0 +1,13 @@
1
+ # frozen_string_literal: true
2
+
3
+ module CloudPDF
4
+ module Tenants
5
+ module Types
6
+ class TenantsUpdateRequest < Internal::Types::Model
7
+ field :tenant_id, -> { String }, optional: false, nullable: false, api_name: "tenantId"
8
+
9
+ field :features, -> { Internal::Types::Array[CloudPDF::Types::TenantFeature] }, optional: false, nullable: false
10
+ end
11
+ end
12
+ end
13
+ end
@@ -0,0 +1,11 @@
1
+ # frozen_string_literal: true
2
+
3
+ module CloudPDF
4
+ module Types
5
+ class TenantFeature < Internal::Types::Model
6
+ field :id, -> { String }, optional: false, nullable: false
7
+
8
+ field :stopped, -> { CloudPDF::Types::TenantFeatureStopped }, optional: true, nullable: false
9
+ end
10
+ end
11
+ end
@@ -0,0 +1,11 @@
1
+ # frozen_string_literal: true
2
+
3
+ module CloudPDF
4
+ module Types
5
+ module TenantFeatureStopped
6
+ extend CloudPDF::Internal::Types::Enum
7
+
8
+ CAP = "cap"
9
+ end
10
+ end
11
+ end
@@ -11,6 +11,8 @@ module CloudPDF
11
11
 
12
12
  field :status, -> { CloudPDF::Types::TenantsCreate200ResponseTenantStatus }, optional: true, nullable: false
13
13
 
14
+ field :features, -> { Internal::Types::Array[CloudPDF::Types::TenantFeature] }, optional: true, nullable: false
15
+
14
16
  field :created_at, -> { Integer }, optional: false, nullable: false, api_name: "createdAt"
15
17
  end
16
18
  end
@@ -11,6 +11,8 @@ module CloudPDF
11
11
 
12
12
  field :status, -> { CloudPDF::Types::TenantsGet200ResponseTenantStatus }, optional: true, nullable: false
13
13
 
14
+ field :features, -> { Internal::Types::Array[CloudPDF::Types::TenantFeature] }, optional: true, nullable: false
15
+
14
16
  field :created_at, -> { Integer }, optional: false, nullable: false, api_name: "createdAt"
15
17
  end
16
18
  end
@@ -11,6 +11,8 @@ module CloudPDF
11
11
 
12
12
  field :status, -> { CloudPDF::Types::TenantsList200ResponseTenantsItemStatus }, optional: true, nullable: false
13
13
 
14
+ field :features, -> { Internal::Types::Array[CloudPDF::Types::TenantFeature] }, optional: true, nullable: false
15
+
14
16
  field :created_at, -> { Integer }, optional: false, nullable: false, api_name: "createdAt"
15
17
  end
16
18
  end
@@ -0,0 +1,9 @@
1
+ # frozen_string_literal: true
2
+
3
+ module CloudPDF
4
+ module Types
5
+ class TenantsUpdate200Response < Internal::Types::Model
6
+ field :tenant, -> { CloudPDF::Types::TenantsUpdate200ResponseTenant }, optional: false, nullable: false
7
+ end
8
+ end
9
+ end
@@ -0,0 +1,19 @@
1
+ # frozen_string_literal: true
2
+
3
+ module CloudPDF
4
+ module Types
5
+ class TenantsUpdate200ResponseTenant < Internal::Types::Model
6
+ field :id, -> { String }, optional: false, nullable: false
7
+
8
+ field :name, -> { String }, optional: false, nullable: false
9
+
10
+ field :auto_provisioned, -> { Internal::Types::Boolean }, optional: false, nullable: false, api_name: "autoProvisioned"
11
+
12
+ field :status, -> { CloudPDF::Types::TenantsUpdate200ResponseTenantStatus }, optional: true, nullable: false
13
+
14
+ field :features, -> { Internal::Types::Array[CloudPDF::Types::TenantFeature] }, optional: true, nullable: false
15
+
16
+ field :created_at, -> { Integer }, optional: false, nullable: false, api_name: "createdAt"
17
+ end
18
+ end
19
+ end
@@ -0,0 +1,12 @@
1
+ # frozen_string_literal: true
2
+
3
+ module CloudPDF
4
+ module Types
5
+ module TenantsUpdate200ResponseTenantStatus
6
+ extend CloudPDF::Internal::Types::Enum
7
+
8
+ ACTIVE = "active"
9
+ SUSPENDED = "suspended"
10
+ end
11
+ end
12
+ end
@@ -0,0 +1,23 @@
1
+ # frozen_string_literal: true
2
+
3
+ module CloudPDF
4
+ module Types
5
+ module TenantsUpdate400Response
6
+ # TenantsUpdate400Response is an alias for AdminErrorPayload
7
+
8
+ # @option str [String]
9
+ #
10
+ # @return [untyped]
11
+ def self.load(str)
12
+ ::JSON.parse(str)
13
+ end
14
+
15
+ # @option value [untyped]
16
+ #
17
+ # @return [String]
18
+ def self.dump(value)
19
+ ::JSON.generate(value)
20
+ end
21
+ end
22
+ end
23
+ end
@@ -0,0 +1,23 @@
1
+ # frozen_string_literal: true
2
+
3
+ module CloudPDF
4
+ module Types
5
+ module TenantsUpdate404Response
6
+ # TenantsUpdate404Response is an alias for AdminErrorPayload
7
+
8
+ # @option str [String]
9
+ #
10
+ # @return [untyped]
11
+ def self.load(str)
12
+ ::JSON.parse(str)
13
+ end
14
+
15
+ # @option value [untyped]
16
+ #
17
+ # @return [String]
18
+ def self.dump(value)
19
+ ::JSON.generate(value)
20
+ end
21
+ end
22
+ end
23
+ end
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module CloudPDF
4
- VERSION = "3.0.0.alpha.20"
4
+ VERSION = "3.0.0.alpha.21"
5
5
  end
data/lib/cloudpdf.rb CHANGED
@@ -788,6 +788,8 @@ require_relative "CloudPDF/types/admin_error_payload"
788
788
  require_relative "CloudPDF/types/engine_error_payload_name"
789
789
  require_relative "CloudPDF/types/engine_error_payload_code"
790
790
  require_relative "CloudPDF/types/engine_error_payload"
791
+ require_relative "CloudPDF/types/tenant_feature_stopped"
792
+ require_relative "CloudPDF/types/tenant_feature"
791
793
  require_relative "CloudPDF/types/cache_delta_pages_item_cache"
792
794
  require_relative "CloudPDF/types/cache_delta_pages_item"
793
795
  require_relative "CloudPDF/types/cache_delta"
@@ -1372,6 +1374,11 @@ require_relative "CloudPDF/types/tenants_get200response_tenant_status"
1372
1374
  require_relative "CloudPDF/types/tenants_get200response_tenant"
1373
1375
  require_relative "CloudPDF/types/tenants_get200response"
1374
1376
  require_relative "CloudPDF/types/tenants_get404response"
1377
+ require_relative "CloudPDF/types/tenants_update200response_tenant_status"
1378
+ require_relative "CloudPDF/types/tenants_update200response_tenant"
1379
+ require_relative "CloudPDF/types/tenants_update200response"
1380
+ require_relative "CloudPDF/types/tenants_update400response"
1381
+ require_relative "CloudPDF/types/tenants_update404response"
1375
1382
  require_relative "CloudPDF/types/tenants_delete_response"
1376
1383
  require_relative "CloudPDF/types/documents_init200response_created_document_state"
1377
1384
  require_relative "CloudPDF/types/documents_init200response_created_document_thumbnail_state"
@@ -1948,6 +1955,7 @@ require_relative "CloudPDF/tenants/types/list_tenants_request"
1948
1955
  require_relative "CloudPDF/tenants/types/tenants_create_request"
1949
1956
  require_relative "CloudPDF/tenants/types/get_tenants_request"
1950
1957
  require_relative "CloudPDF/tenants/types/delete_tenants_request"
1958
+ require_relative "CloudPDF/tenants/types/tenants_update_request"
1951
1959
  require_relative "CloudPDF/tenants/types/resume_tenants_request"
1952
1960
  require_relative "CloudPDF/tenants/types/tenants_suspend_request"
1953
1961
  require_relative "CloudPDF/tenants/types/usage_tenants_request"
data/reference.md CHANGED
@@ -1496,6 +1496,81 @@ client.tenants.delete(tenant_id: "tenantId")
1496
1496
  </dl>
1497
1497
 
1498
1498
 
1499
+ </dd>
1500
+ </dl>
1501
+ </details>
1502
+
1503
+ <details><summary><code>client.tenants.<a href="/lib/CloudPDF/tenants/client.rb">update</a>(tenant_id:, request) -> CloudPDF::Types::TenantsUpdate200Response</code></summary>
1504
+ <dl>
1505
+ <dd>
1506
+
1507
+ #### 📝 Description
1508
+
1509
+ <dl>
1510
+ <dd>
1511
+
1512
+ <dl>
1513
+ <dd>
1514
+
1515
+ A feature names an installed module; any other id is a 400. A module route answers a tenant without its feature 403 FeatureNotEnabled, and one whose feature is stopped 402 FeatureStopped (details.feature, details.stopped). Other replicas apply a change within 30 seconds.
1516
+ </dd>
1517
+ </dl>
1518
+ </dd>
1519
+ </dl>
1520
+
1521
+ #### 🔌 Usage
1522
+
1523
+ <dl>
1524
+ <dd>
1525
+
1526
+ <dl>
1527
+ <dd>
1528
+
1529
+ ```ruby
1530
+ client.tenants.update(
1531
+ tenant_id: "tenantId",
1532
+ features: [{
1533
+ id: "id"
1534
+ }]
1535
+ )
1536
+ ```
1537
+ </dd>
1538
+ </dl>
1539
+ </dd>
1540
+ </dl>
1541
+
1542
+ #### ⚙️ Parameters
1543
+
1544
+ <dl>
1545
+ <dd>
1546
+
1547
+ <dl>
1548
+ <dd>
1549
+
1550
+ **tenant_id:** `String`
1551
+
1552
+ </dd>
1553
+ </dl>
1554
+
1555
+ <dl>
1556
+ <dd>
1557
+
1558
+ **features:** `Internal::Types::Array[CloudPDF::Types::TenantFeature]`
1559
+
1560
+ </dd>
1561
+ </dl>
1562
+
1563
+ <dl>
1564
+ <dd>
1565
+
1566
+ **request_options:** `CloudPDF::Tenants::RequestOptions`
1567
+
1568
+ </dd>
1569
+ </dl>
1570
+ </dd>
1571
+ </dl>
1572
+
1573
+
1499
1574
  </dd>
1500
1575
  </dl>
1501
1576
  </details>
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: cloudpdf
3
3
  version: !ruby/object:Gem::Version
4
- version: 3.0.0.alpha.20
4
+ version: 3.0.0.alpha.21
5
5
  platform: ruby
6
6
  authors:
7
7
  - CloudPDF
8
8
  autorequire:
9
9
  bindir: exe
10
10
  cert_chain: []
11
- date: 2026-11-02 00:00:00.000000000 Z
11
+ date: 2026-11-03 00:00:00.000000000 Z
12
12
  dependencies: []
13
13
  description: A typed Ruby client for deployment, tenant, and document operations in
14
14
  the CloudPDF API.
@@ -219,6 +219,7 @@ files:
219
219
  - lib/CloudPDF/tenants/types/resume_tenants_request.rb
220
220
  - lib/CloudPDF/tenants/types/tenants_create_request.rb
221
221
  - lib/CloudPDF/tenants/types/tenants_suspend_request.rb
222
+ - lib/CloudPDF/tenants/types/tenants_update_request.rb
222
223
  - lib/CloudPDF/tenants/types/usage_tenants_request.rb
223
224
  - lib/CloudPDF/tokens/client.rb
224
225
  - lib/CloudPDF/tokens/types/issue_tokens_request.rb
@@ -2000,6 +2001,8 @@ files:
2000
2001
  - lib/CloudPDF/types/pdf_link_target_writable_uri.rb
2001
2002
  - lib/CloudPDF/types/pdf_page_actions.rb
2002
2003
  - lib/CloudPDF/types/resolved_font_run.rb
2004
+ - lib/CloudPDF/types/tenant_feature.rb
2005
+ - lib/CloudPDF/types/tenant_feature_stopped.rb
2003
2006
  - lib/CloudPDF/types/tenants_create200response.rb
2004
2007
  - lib/CloudPDF/types/tenants_create200response_tenant.rb
2005
2008
  - lib/CloudPDF/types/tenants_create200response_tenant_status.rb
@@ -2015,6 +2018,11 @@ files:
2015
2018
  - lib/CloudPDF/types/tenants_list400response.rb
2016
2019
  - lib/CloudPDF/types/tenants_resume_response.rb
2017
2020
  - lib/CloudPDF/types/tenants_suspend_response.rb
2021
+ - lib/CloudPDF/types/tenants_update200response.rb
2022
+ - lib/CloudPDF/types/tenants_update200response_tenant.rb
2023
+ - lib/CloudPDF/types/tenants_update200response_tenant_status.rb
2024
+ - lib/CloudPDF/types/tenants_update400response.rb
2025
+ - lib/CloudPDF/types/tenants_update404response.rb
2018
2026
  - lib/CloudPDF/types/tenants_usage200response.rb
2019
2027
  - lib/CloudPDF/types/tenants_usage200response_metrics.rb
2020
2028
  - lib/CloudPDF/types/tenants_usage400response.rb