fern_gusto 0.0.6.pre.alpha6

data/lib/fern_gusto/companies/attachments/client.rb

@@ -0,0 +1,335 @@
+# frozen_string_literal: true
+require_relative "../../../requests"
+require_relative "../../company_attachment/types/company_attachment"
+require_relative "types/attachments_get_download_url_response"
+require "json"
+require_relative "types/attachments_create_request_category"
+require_relative "../../../core/file_utilities"
+require "async"
+require "async"
+require "async"
+require "async"
+require_relative "../../../requests"
+
+module Gusto
+  module Companies
+    class AttachmentsClient
+    # @return [Gusto::RequestClient] 
+      attr_reader :request_client
+
+
+      # @param request_client [Gusto::RequestClient] 
+      # @return [Gusto::Companies::AttachmentsClient]
+      def initialize(request_client:)
+        @request_client = request_client
+      end
+# Retrieve the detail of an attachment uploaded by the company.
+      #
+      # @param company_id [String] The UUID of the company
+      # @param company_attachment_uuid [String] The UUID of the company attachment
+      # @param request_options [Gusto::RequestOptions] 
+      # @return [Gusto::CompanyAttachment::CompanyAttachment]
+      # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.companies.attachments.get(company_id: "company_id", company_attachment_uuid: "company_attachment_uuid")
+      def get(company_id:, company_attachment_uuid:, request_options: nil)
+        response = @request_client.conn.get do | req |
+  unless request_options&.timeout_in_seconds.nil?
+    req.options.timeout = request_options.timeout_in_seconds
+  end
+  unless request_options&.token.nil?
+    req.headers["Authorization"] = request_options.token
+  end
+  unless request_options&.gusto_api_version.nil?
+    req.headers["X-Gusto-API-Version"] = request_options.gusto_api_version
+  end
+  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
+  unless request_options.nil? || request_options&.additional_query_parameters.nil?
+    req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+  end
+  unless request_options.nil? || request_options&.additional_body_parameters.nil?
+    req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+  end
+  req.url "#{@request_client.get_url(request_options: request_options)}/v1/companies/#{company_id}/attachments/#{company_attachment_uuid}"
+end
+        Gusto::CompanyAttachment::CompanyAttachment.from_json(json_object: response.body)
+      end
+# Retrieve a temporary url to download a attachment file uploaded by the company.
+      #
+      # @param company_id [String] The UUID of the company
+      # @param company_attachment_uuid [String] The UUID of the company attachment
+      # @param request_options [Gusto::RequestOptions] 
+      # @return [Gusto::Companies::Attachments::AttachmentsGetDownloadURLResponse]
+      # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.companies.attachments.get_download_url(company_id: "company_id", company_attachment_uuid: "company_attachment_uuid")
+      def get_download_url(company_id:, company_attachment_uuid:, request_options: nil)
+        response = @request_client.conn.get do | req |
+  unless request_options&.timeout_in_seconds.nil?
+    req.options.timeout = request_options.timeout_in_seconds
+  end
+  unless request_options&.token.nil?
+    req.headers["Authorization"] = request_options.token
+  end
+  unless request_options&.gusto_api_version.nil?
+    req.headers["X-Gusto-API-Version"] = request_options.gusto_api_version
+  end
+  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
+  unless request_options.nil? || request_options&.additional_query_parameters.nil?
+    req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+  end
+  unless request_options.nil? || request_options&.additional_body_parameters.nil?
+    req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+  end
+  req.url "#{@request_client.get_url(request_options: request_options)}/v1/companies/#{company_id}/attachments/#{company_attachment_uuid}/download_url"
+end
+        Gusto::Companies::Attachments::AttachmentsGetDownloadURLResponse.from_json(json_object: response.body)
+      end
+# Retrieve a list of all the attachments uploaded by the company.
+      #
+      # @param company_id [String] The UUID of the company
+      # @param request_options [Gusto::RequestOptions] 
+      # @return [Array<Gusto::CompanyAttachment::CompanyAttachment>]
+      # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.companies.attachments.list(company_id: "company_id")
+      def list(company_id:, request_options: nil)
+        response = @request_client.conn.get do | req |
+  unless request_options&.timeout_in_seconds.nil?
+    req.options.timeout = request_options.timeout_in_seconds
+  end
+  unless request_options&.token.nil?
+    req.headers["Authorization"] = request_options.token
+  end
+  unless request_options&.gusto_api_version.nil?
+    req.headers["X-Gusto-API-Version"] = request_options.gusto_api_version
+  end
+  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
+  unless request_options.nil? || request_options&.additional_query_parameters.nil?
+    req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+  end
+  unless request_options.nil? || request_options&.additional_body_parameters.nil?
+    req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+  end
+  req.url "#{@request_client.get_url(request_options: request_options)}/v1/companies/#{company_id}/attachments"
+end
+        parsed_json = JSON.parse(response.body)
+        parsed_json&.map do | item |
+          item = item.to_json
+          Gusto::CompanyAttachment::CompanyAttachment.from_json(json_object: item)
+        end
+      end
+# Upload a file and create a company attachment. We recommend uploading PDF files
+#  for optimal compatibility. However, the following file types are allowed: .qbb,
+#  .qbm, .gif, .jpg, .png, .pdf, .xls, .xlsx, .doc and .docx
+      #
+      # @param company_id [String] The UUID of the company
+      # @param document [String, IO] 
+      # @param category [Gusto::Companies::Attachments::AttachmentsCreateRequestCategory] The category of a company attachment.
+      # @param request_options [Gusto::RequestOptions] 
+      # @return [Gusto::CompanyAttachment::CompanyAttachment]
+      # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.companies.attachments.create(company_id: "company_id", document: my_file.txt)
+      def create(company_id:, document:, category:, request_options: nil)
+        response = @request_client.conn.post do | req |
+  unless request_options&.timeout_in_seconds.nil?
+    req.options.timeout = request_options.timeout_in_seconds
+  end
+  unless request_options&.token.nil?
+    req.headers["Authorization"] = request_options.token
+  end
+  unless request_options&.gusto_api_version.nil?
+    req.headers["X-Gusto-API-Version"] = request_options.gusto_api_version
+  end
+  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
+  unless request_options.nil? || request_options&.additional_query_parameters.nil?
+    req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+  end
+  req.body = { **(request_options&.additional_body_parameters || {}), document: Gusto::FileUtilities.as_faraday_multipart(file_like: document), category: category }.compact
+  req.url "#{@request_client.get_url(request_options: request_options)}/v1/companies/#{company_id}/attachments"
+end
+        Gusto::CompanyAttachment::CompanyAttachment.from_json(json_object: response.body)
+      end
+    end
+    class AsyncAttachmentsClient
+    # @return [Gusto::AsyncRequestClient] 
+      attr_reader :request_client
+
+
+      # @param request_client [Gusto::RequestClient] 
+      # @return [Gusto::Companies::AsyncAttachmentsClient]
+      def initialize(request_client:)
+        @request_client = request_client
+      end
+# Retrieve the detail of an attachment uploaded by the company.
+      #
+      # @param company_id [String] The UUID of the company
+      # @param company_attachment_uuid [String] The UUID of the company attachment
+      # @param request_options [Gusto::RequestOptions] 
+      # @return [Gusto::CompanyAttachment::CompanyAttachment]
+      # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.companies.attachments.get(company_id: "company_id", company_attachment_uuid: "company_attachment_uuid")
+      def get(company_id:, company_attachment_uuid:, request_options: nil)
+        Async do
+          response = @request_client.conn.get do | req |
+  unless request_options&.timeout_in_seconds.nil?
+    req.options.timeout = request_options.timeout_in_seconds
+  end
+  unless request_options&.token.nil?
+    req.headers["Authorization"] = request_options.token
+  end
+  unless request_options&.gusto_api_version.nil?
+    req.headers["X-Gusto-API-Version"] = request_options.gusto_api_version
+  end
+  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
+  unless request_options.nil? || request_options&.additional_query_parameters.nil?
+    req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+  end
+  unless request_options.nil? || request_options&.additional_body_parameters.nil?
+    req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+  end
+  req.url "#{@request_client.get_url(request_options: request_options)}/v1/companies/#{company_id}/attachments/#{company_attachment_uuid}"
+end
+          Gusto::CompanyAttachment::CompanyAttachment.from_json(json_object: response.body)
+        end
+      end
+# Retrieve a temporary url to download a attachment file uploaded by the company.
+      #
+      # @param company_id [String] The UUID of the company
+      # @param company_attachment_uuid [String] The UUID of the company attachment
+      # @param request_options [Gusto::RequestOptions] 
+      # @return [Gusto::Companies::Attachments::AttachmentsGetDownloadURLResponse]
+      # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.companies.attachments.get_download_url(company_id: "company_id", company_attachment_uuid: "company_attachment_uuid")
+      def get_download_url(company_id:, company_attachment_uuid:, request_options: nil)
+        Async do
+          response = @request_client.conn.get do | req |
+  unless request_options&.timeout_in_seconds.nil?
+    req.options.timeout = request_options.timeout_in_seconds
+  end
+  unless request_options&.token.nil?
+    req.headers["Authorization"] = request_options.token
+  end
+  unless request_options&.gusto_api_version.nil?
+    req.headers["X-Gusto-API-Version"] = request_options.gusto_api_version
+  end
+  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
+  unless request_options.nil? || request_options&.additional_query_parameters.nil?
+    req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+  end
+  unless request_options.nil? || request_options&.additional_body_parameters.nil?
+    req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+  end
+  req.url "#{@request_client.get_url(request_options: request_options)}/v1/companies/#{company_id}/attachments/#{company_attachment_uuid}/download_url"
+end
+          Gusto::Companies::Attachments::AttachmentsGetDownloadURLResponse.from_json(json_object: response.body)
+        end
+      end
+# Retrieve a list of all the attachments uploaded by the company.
+      #
+      # @param company_id [String] The UUID of the company
+      # @param request_options [Gusto::RequestOptions] 
+      # @return [Array<Gusto::CompanyAttachment::CompanyAttachment>]
+      # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.companies.attachments.list(company_id: "company_id")
+      def list(company_id:, request_options: nil)
+        Async do
+          response = @request_client.conn.get do | req |
+  unless request_options&.timeout_in_seconds.nil?
+    req.options.timeout = request_options.timeout_in_seconds
+  end
+  unless request_options&.token.nil?
+    req.headers["Authorization"] = request_options.token
+  end
+  unless request_options&.gusto_api_version.nil?
+    req.headers["X-Gusto-API-Version"] = request_options.gusto_api_version
+  end
+  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
+  unless request_options.nil? || request_options&.additional_query_parameters.nil?
+    req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+  end
+  unless request_options.nil? || request_options&.additional_body_parameters.nil?
+    req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+  end
+  req.url "#{@request_client.get_url(request_options: request_options)}/v1/companies/#{company_id}/attachments"
+end
+          parsed_json = JSON.parse(response.body)
+          parsed_json&.map do | item |
+            item = item.to_json
+            Gusto::CompanyAttachment::CompanyAttachment.from_json(json_object: item)
+          end
+        end
+      end
+# Upload a file and create a company attachment. We recommend uploading PDF files
+#  for optimal compatibility. However, the following file types are allowed: .qbb,
+#  .qbm, .gif, .jpg, .png, .pdf, .xls, .xlsx, .doc and .docx
+      #
+      # @param company_id [String] The UUID of the company
+      # @param document [String, IO] 
+      # @param category [Gusto::Companies::Attachments::AttachmentsCreateRequestCategory] The category of a company attachment.
+      # @param request_options [Gusto::RequestOptions] 
+      # @return [Gusto::CompanyAttachment::CompanyAttachment]
+      # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.companies.attachments.create(company_id: "company_id", document: my_file.txt)
+      def create(company_id:, document:, category:, request_options: nil)
+        Async do
+          response = @request_client.conn.post do | req |
+  unless request_options&.timeout_in_seconds.nil?
+    req.options.timeout = request_options.timeout_in_seconds
+  end
+  unless request_options&.token.nil?
+    req.headers["Authorization"] = request_options.token
+  end
+  unless request_options&.gusto_api_version.nil?
+    req.headers["X-Gusto-API-Version"] = request_options.gusto_api_version
+  end
+  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
+  unless request_options.nil? || request_options&.additional_query_parameters.nil?
+    req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+  end
+  req.body = { **(request_options&.additional_body_parameters || {}), document: Gusto::FileUtilities.as_faraday_multipart(file_like: document), category: category }.compact
+  req.url "#{@request_client.get_url(request_options: request_options)}/v1/companies/#{company_id}/attachments"
+end
+          Gusto::CompanyAttachment::CompanyAttachment.from_json(json_object: response.body)
+        end
+      end
+    end
+  end
+end

data/lib/fern_gusto/companies/attachments/types/attachments_create_request_category.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Gusto
+  module Companies
+    module Attachments
+# The category of a company attachment.
+      class AttachmentsCreateRequestCategory
+
+        GEP_NOTICE = "gep_notice"
+        COMPLIANCE = "compliance"
+
+      end
+    end
+  end
+end

data/lib/fern_gusto/companies/attachments/types/attachments_get_download_url_response.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+require "ostruct"
+require "json"
+
+module Gusto
+  module Companies
+    module Attachments
+# The temporary url to download a Company Attachment File
+      class AttachmentsGetDownloadURLResponse
+      # @return [String] A full Url to download a Company Attachment File
+        attr_reader :url
+      # @return [OpenStruct] Additional properties unmapped to the current class definition
+        attr_reader :additional_properties
+      # @return [Object] 
+        attr_reader :_field_set
+        protected :_field_set
+
+        OMIT = Object.new
+
+        # @param url [String] A full Url to download a Company Attachment File
+        # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+        # @return [Gusto::Companies::Attachments::AttachmentsGetDownloadURLResponse]
+        def initialize(url:, additional_properties: nil)
+          @url = url
+          @additional_properties = additional_properties
+          @_field_set = { "url": url }
+        end
+# Deserialize a JSON object to an instance of AttachmentsGetDownloadURLResponse
+        #
+        # @param json_object [String] 
+        # @return [Gusto::Companies::Attachments::AttachmentsGetDownloadURLResponse]
+        def self.from_json(json_object:)
+          struct = JSON.parse(json_object, object_class: OpenStruct)
+          parsed_json = JSON.parse(json_object)
+          url = parsed_json["url"]
+          new(url: url, additional_properties: struct)
+        end
+# Serialize an instance of AttachmentsGetDownloadURLResponse to a JSON object
+        #
+        # @return [String]
+        def to_json
+          @_field_set&.to_json
+        end
+# Leveraged for Union-type generation, validate_raw attempts to parse the given
+#  hash and check each fields type against the current object's property
+#  definitions.
+        #
+        # @param obj [Object] 
+        # @return [Void]
+        def self.validate_raw(obj:)
+          obj.url.is_a?(String) != false || raise("Passed value for field obj.url is not the expected type, validation failed.")
+        end
+      end
+    end
+  end
+end