files.com 1.1.649 → 1.1.650

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f762883ff6e320131d7226422ae25f1800e1fbe172e47364e4af6551a32545a0
-  data.tar.gz: 2869f62037e0932d98f81023013b9ed08f180cba307a137f5b6fad728dbd2f65
+  metadata.gz: f7dde18d343e9bf8a8538ccfb34491976a3db43de79ce6589d686767c75316bd
+  data.tar.gz: 7d82c5763649255e9817bca9f5c06a6936615ab76e2dd3e160b2d86ece0f61a5
 SHA512:
-  metadata.gz: 826dc59eaa2592234e807c00d047e4323efb3a1dc6c511413b349ebe4a78b385a8dbeb6d4733eb8a9000bbf280a7ac94f5cf764c4a5f72bf399f4a7b1a3530b7
-  data.tar.gz: db29182d2dee5cf4c7896f84521e9a0b79bb2a6ef42bf0ada476d7d2407bd5d36faa3fa0bed0bf4ed7fd2f9322621c4be49c27da103b25540f431641750c7e8d
+  metadata.gz: b83595592c9e9e3ac15367209f141970cd60c28a6c7dd78756a82adb027e70e2b026aadaf0c66398c9a82be5b4ab31c5479447496e129b0eb5ec76449caec23a
+  data.tar.gz: 3350a714101aa458812fd311a8899040484d16b2d4393cfce4cd445230e87866a783e37cc0f945d288e72fcbc37d278d7a879834c2b34e6e47f4ade1f1a3d1f3

data/_VERSION

@@ -1 +1 @@
-1.1.649
+1.1.650

data/docs/custom_domain.md

@@ -0,0 +1,150 @@
+# CustomDomain
+
+## Example CustomDomain Object
+
+```
+{
+  "id": 1,
+  "domain": "files.example.com",
+  "destination": "site_alias",
+  "dns_status": "correct",
+  "ssl_certificate_id": 1,
+  "brick_managed": true,
+  "folder_behavior_id": 1,
+  "created_at": "2000-01-01T01:00:00Z",
+  "updated_at": "2000-01-01T01:00:00Z"
+}
+```
+
+* `id` (int64): Custom Domain ID.
+* `domain` (string): Customer-owned domain name.
+* `destination` (string): Where this custom domain routes. Can be `site_alias`, `public_hosting`, or `s3_endpoint`.
+* `dns_status` (string): Current DNS verification status.
+* `ssl_certificate_id` (int64): Current SSL certificate ID.
+* `brick_managed` (boolean): Is this domain's SSL certificate automatically managed and renewed by Files.com?
+* `folder_behavior_id` (int64): Public Hosting behavior ID when this domain routes to a specific Public Hosting behavior.
+* `created_at` (date-time): When this Custom Domain was created.
+* `updated_at` (date-time): When this Custom Domain was last updated.
+
+
+---
+
+## List Custom Domains
+
+```
+Files::CustomDomain.list
+```
+
+### Parameters
+
+* `cursor` (string): Used for pagination.  When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`.  Send one of those cursor value here to resume an existing list from the next available record.  Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
+* `per_page` (int64): Number of records to show per page.  (Max: 10000, 1,000 or less is recommended).
+* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `id`.
+
+
+---
+
+## Show Custom Domain
+
+```
+Files::CustomDomain.find(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Custom Domain ID.
+
+
+---
+
+## Create Custom Domain
+
+```
+Files::CustomDomain.create(
+  destination: "site_alias", 
+  folder_behavior_id: 1, 
+  ssl_certificate_id: 1, 
+  domain: "files.example.com"
+)
+```
+
+### Parameters
+
+* `destination` (string): Where this custom domain routes. Can be `site_alias`, `public_hosting`, or `s3_endpoint`.
+* `folder_behavior_id` (int64): Public Hosting behavior ID when this domain routes to a specific Public Hosting behavior.
+* `ssl_certificate_id` (int64): Current SSL certificate ID.
+* `domain` (string): Required - Customer-owned domain name.
+
+
+---
+
+## Update Custom Domain
+
+```
+Files::CustomDomain.update(id, 
+  destination: "site_alias", 
+  folder_behavior_id: 1, 
+  ssl_certificate_id: 1, 
+  domain: "files.example.com"
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - Custom Domain ID.
+* `destination` (string): Where this custom domain routes. Can be `site_alias`, `public_hosting`, or `s3_endpoint`.
+* `folder_behavior_id` (int64): Public Hosting behavior ID when this domain routes to a specific Public Hosting behavior.
+* `ssl_certificate_id` (int64): Current SSL certificate ID.
+* `domain` (string): Customer-owned domain name.
+
+
+---
+
+## Delete Custom Domain
+
+```
+Files::CustomDomain.delete(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Custom Domain ID.
+
+
+---
+
+## Update Custom Domain
+
+```
+custom_domain = Files::CustomDomain.find(id)
+
+custom_domain.update(
+  destination: "site_alias",
+  folder_behavior_id: 1,
+  ssl_certificate_id: 1,
+  domain: "files.example.com"
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - Custom Domain ID.
+* `destination` (string): Where this custom domain routes. Can be `site_alias`, `public_hosting`, or `s3_endpoint`.
+* `folder_behavior_id` (int64): Public Hosting behavior ID when this domain routes to a specific Public Hosting behavior.
+* `ssl_certificate_id` (int64): Current SSL certificate ID.
+* `domain` (string): Customer-owned domain name.
+
+
+---
+
+## Delete Custom Domain
+
+```
+custom_domain = Files::CustomDomain.find(id)
+
+custom_domain.delete
+```
+
+### Parameters
+
+* `id` (int64): Required - Custom Domain ID.

data/lib/files.com/models/custom_domain.rb

@@ -0,0 +1,214 @@
+# frozen_string_literal: true
+
+module Files
+  class CustomDomain
+    attr_reader :options, :attributes
+
+    def initialize(attributes = {}, options = {})
+      @attributes = attributes || {}
+      @options = options || {}
+    end
+
+    # int64 - Custom Domain ID.
+    def id
+      @attributes[:id]
+    end
+
+    def id=(value)
+      @attributes[:id] = value
+    end
+
+    # string - Customer-owned domain name.
+    def domain
+      @attributes[:domain]
+    end
+
+    def domain=(value)
+      @attributes[:domain] = value
+    end
+
+    # string - Where this custom domain routes. Can be `site_alias`, `public_hosting`, or `s3_endpoint`.
+    def destination
+      @attributes[:destination]
+    end
+
+    def destination=(value)
+      @attributes[:destination] = value
+    end
+
+    # string - Current DNS verification status.
+    def dns_status
+      @attributes[:dns_status]
+    end
+
+    def dns_status=(value)
+      @attributes[:dns_status] = value
+    end
+
+    # int64 - Current SSL certificate ID.
+    def ssl_certificate_id
+      @attributes[:ssl_certificate_id]
+    end
+
+    def ssl_certificate_id=(value)
+      @attributes[:ssl_certificate_id] = value
+    end
+
+    # boolean - Is this domain's SSL certificate automatically managed and renewed by Files.com?
+    def brick_managed
+      @attributes[:brick_managed]
+    end
+
+    def brick_managed=(value)
+      @attributes[:brick_managed] = value
+    end
+
+    # int64 - Public Hosting behavior ID when this domain routes to a specific Public Hosting behavior.
+    def folder_behavior_id
+      @attributes[:folder_behavior_id]
+    end
+
+    def folder_behavior_id=(value)
+      @attributes[:folder_behavior_id] = value
+    end
+
+    # date-time - When this Custom Domain was created.
+    def created_at
+      @attributes[:created_at]
+    end
+
+    # date-time - When this Custom Domain was last updated.
+    def updated_at
+      @attributes[:updated_at]
+    end
+
+    # Parameters:
+    #   destination - string - Where this custom domain routes. Can be `site_alias`, `public_hosting`, or `s3_endpoint`.
+    #   folder_behavior_id - int64 - Public Hosting behavior ID when this domain routes to a specific Public Hosting behavior.
+    #   ssl_certificate_id - int64 - Current SSL certificate ID.
+    #   domain - string - Customer-owned domain name.
+    def update(params = {})
+      params ||= {}
+      params[:id] = @attributes[:id]
+      raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
+      raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
+      raise InvalidParameterError.new("Bad parameter: destination must be an String") if params[:destination] and !params[:destination].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: folder_behavior_id must be an Integer") if params[:folder_behavior_id] and !params[:folder_behavior_id].is_a?(Integer)
+      raise InvalidParameterError.new("Bad parameter: ssl_certificate_id must be an Integer") if params[:ssl_certificate_id] and !params[:ssl_certificate_id].is_a?(Integer)
+      raise InvalidParameterError.new("Bad parameter: domain must be an String") if params[:domain] and !params[:domain].is_a?(String)
+      raise MissingParameterError.new("Parameter missing: id") unless params[:id]
+
+      Api.send_request("/custom_domains/#{@attributes[:id]}", :patch, params, @options)
+    end
+
+    def delete(params = {})
+      params ||= {}
+      params[:id] = @attributes[:id]
+      raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
+      raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
+      raise MissingParameterError.new("Parameter missing: id") unless params[:id]
+
+      Api.send_request("/custom_domains/#{@attributes[:id]}", :delete, params, @options)
+    end
+
+    def destroy(params = {})
+      delete(params)
+      nil
+    end
+
+    def save
+      if @attributes[:id]
+        new_obj = update(@attributes)
+      else
+        new_obj = CustomDomain.create(@attributes, @options)
+      end
+
+      @attributes = new_obj.attributes
+      true
+    end
+
+    # Parameters:
+    #   cursor - string - Used for pagination.  When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`.  Send one of those cursor value here to resume an existing list from the next available record.  Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
+    #   per_page - int64 - Number of records to show per page.  (Max: 10000, 1,000 or less is recommended).
+    #   sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `id`.
+    def self.list(params = {}, options = {})
+      raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
+      raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)
+
+      List.new(CustomDomain, params) do
+        Api.send_request("/custom_domains", :get, params, options)
+      end
+    end
+
+    def self.all(params = {}, options = {})
+      list(params, options)
+    end
+
+    # Parameters:
+    #   id (required) - int64 - Custom Domain ID.
+    def self.find(id, params = {}, options = {})
+      params ||= {}
+      params[:id] = id
+      raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
+      raise MissingParameterError.new("Parameter missing: id") unless params[:id]
+
+      response, options = Api.send_request("/custom_domains/#{params[:id]}", :get, params, options)
+      CustomDomain.new(response.data, options)
+    end
+
+    def self.get(id, params = {}, options = {})
+      find(id, params, options)
+    end
+
+    # Parameters:
+    #   destination - string - Where this custom domain routes. Can be `site_alias`, `public_hosting`, or `s3_endpoint`.
+    #   folder_behavior_id - int64 - Public Hosting behavior ID when this domain routes to a specific Public Hosting behavior.
+    #   ssl_certificate_id - int64 - Current SSL certificate ID.
+    #   domain (required) - string - Customer-owned domain name.
+    def self.create(params = {}, options = {})
+      raise InvalidParameterError.new("Bad parameter: destination must be an String") if params[:destination] and !params[:destination].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: folder_behavior_id must be an Integer") if params[:folder_behavior_id] and !params[:folder_behavior_id].is_a?(Integer)
+      raise InvalidParameterError.new("Bad parameter: ssl_certificate_id must be an Integer") if params[:ssl_certificate_id] and !params[:ssl_certificate_id].is_a?(Integer)
+      raise InvalidParameterError.new("Bad parameter: domain must be an String") if params[:domain] and !params[:domain].is_a?(String)
+      raise MissingParameterError.new("Parameter missing: domain") unless params[:domain]
+
+      response, options = Api.send_request("/custom_domains", :post, params, options)
+      CustomDomain.new(response.data, options)
+    end
+
+    # Parameters:
+    #   destination - string - Where this custom domain routes. Can be `site_alias`, `public_hosting`, or `s3_endpoint`.
+    #   folder_behavior_id - int64 - Public Hosting behavior ID when this domain routes to a specific Public Hosting behavior.
+    #   ssl_certificate_id - int64 - Current SSL certificate ID.
+    #   domain - string - Customer-owned domain name.
+    def self.update(id, params = {}, options = {})
+      params ||= {}
+      params[:id] = id
+      raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
+      raise InvalidParameterError.new("Bad parameter: destination must be an String") if params[:destination] and !params[:destination].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: folder_behavior_id must be an Integer") if params[:folder_behavior_id] and !params[:folder_behavior_id].is_a?(Integer)
+      raise InvalidParameterError.new("Bad parameter: ssl_certificate_id must be an Integer") if params[:ssl_certificate_id] and !params[:ssl_certificate_id].is_a?(Integer)
+      raise InvalidParameterError.new("Bad parameter: domain must be an String") if params[:domain] and !params[:domain].is_a?(String)
+      raise MissingParameterError.new("Parameter missing: id") unless params[:id]
+
+      response, options = Api.send_request("/custom_domains/#{params[:id]}", :patch, params, options)
+      CustomDomain.new(response.data, options)
+    end
+
+    def self.delete(id, params = {}, options = {})
+      params ||= {}
+      params[:id] = id
+      raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
+      raise MissingParameterError.new("Parameter missing: id") unless params[:id]
+
+      Api.send_request("/custom_domains/#{params[:id]}", :delete, params, options)
+      nil
+    end
+
+    def self.destroy(id, params = {}, options = {})
+      delete(id, params, options)
+      nil
+    end
+  end
+end

data/lib/files.com/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Files
-  VERSION = "1.1.649"
+  VERSION = "1.1.650"
 end

data/lib/files.com.rb

@@ -60,6 +60,7 @@ require "files.com/models/bundle_recipient"
 require "files.com/models/bundle_registration"
 require "files.com/models/child_site_management_policy"
 require "files.com/models/clickwrap"
+require "files.com/models/custom_domain"
 require "files.com/models/desktop_configuration_profile"
 require "files.com/models/dns_record"
 require "files.com/models/email_incoming_message"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: files.com
 version: !ruby/object:Gem::Version
-  version: 1.1.649
+  version: 1.1.650
 platform: ruby
 authors:
 - files.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2026-06-16 00:00:00.000000000 Z
+date: 2026-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -198,6 +198,7 @@ files:
 - docs/bundle_registration.md
 - docs/child_site_management_policy.md
 - docs/clickwrap.md
+- docs/custom_domain.md
 - docs/desktop_configuration_profile.md
 - docs/dns_record.md
 - docs/email_incoming_message.md
@@ -336,6 +337,7 @@ files:
 - lib/files.com/models/bundle_registration.rb
 - lib/files.com/models/child_site_management_policy.rb
 - lib/files.com/models/clickwrap.rb
+- lib/files.com/models/custom_domain.rb
 - lib/files.com/models/desktop_configuration_profile.rb
 - lib/files.com/models/dir.rb
 - lib/files.com/models/dns_record.rb