fern_gusto 0.0.6.pre.alpha6

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

@@ -0,0 +1,345 @@
+# frozen_string_literal: true
+require_relative "../../../requests"
+require_relative "../../forms/types/form"
+require "json"
+require_relative "../../types/form_pdf"
+require "async"
+require "async"
+require "async"
+require "async"
+require_relative "../../../requests"
+
+module Gusto
+  module Companies
+    class FormsClient
+    # @return [Gusto::RequestClient] 
+      attr_reader :request_client
+
+
+      # @param request_client [Gusto::RequestClient] 
+      # @return [Gusto::Companies::FormsClient]
+      def initialize(request_client:)
+        @request_client = request_client
+      end
+# Get a list of all company's forms
+#  scope: `company_forms:read`
+      #
+      # @param company_id [String] The UUID of the company
+      # @param request_options [Gusto::RequestOptions] 
+      # @return [Array<Gusto::Forms::Form>]
+      # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.companies.forms.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}/forms"
+end
+        parsed_json = JSON.parse(response.body)
+        parsed_json&.map do | item |
+          item = item.to_json
+          Gusto::Forms::Form.from_json(json_object: item)
+        end
+      end
+# Get a company form
+#  scope: `company_forms:read`
+      #
+      # @param form_id [String] The UUID of the form
+      # @param request_options [Gusto::RequestOptions] 
+      # @return [Gusto::Forms::Form]
+      # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.companies.forms.get(form_id: "form_id")
+      def get(form_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/forms/#{form_id}"
+end
+        Gusto::Forms::Form.from_json(json_object: response.body)
+      end
+# Get the link to the form PDF
+#  scope: `company_forms:read`
+      #
+      # @param form_id [String] The UUID of the form
+      # @param request_options [Gusto::RequestOptions] 
+      # @return [Gusto::FormPdf]
+      # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.companies.forms.get_pdf(form_id: "form_id")
+      def get_pdf(form_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/forms/#{form_id}/pdf"
+end
+        Gusto::FormPdf.from_json(json_object: response.body)
+      end
+# Sign a company form. Company forms must be signed by the company signatory.
+#  scope: `company_forms:sign`
+      #
+      # @param form_id [String] The UUID of the form
+      # @param signature_text [String] The signature
+      # @param agree [Boolean] whether you agree to sign electronically
+      # @param signed_by_ip_address [String] The IP address of the signatory who signed the form.
+      # @param request_options [Gusto::RequestOptions] 
+      # @return [Gusto::Forms::Form]
+      # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.companies.forms.sign(
+#    form_id: "form_id",
+#    signature_text: "Jane Smith",
+#    agree: true,
+#    signed_by_ip_address: "192.168.0.1"
+#  )
+      def sign(form_id:, signature_text:, agree:, signed_by_ip_address:, request_options: nil)
+        response = @request_client.conn.put 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 || {}), signature_text: signature_text, agree: agree, signed_by_ip_address: signed_by_ip_address }.compact
+  req.url "#{@request_client.get_url(request_options: request_options)}/v1/forms/#{form_id}/sign"
+end
+        Gusto::Forms::Form.from_json(json_object: response.body)
+      end
+    end
+    class AsyncFormsClient
+    # @return [Gusto::AsyncRequestClient] 
+      attr_reader :request_client
+
+
+      # @param request_client [Gusto::RequestClient] 
+      # @return [Gusto::Companies::AsyncFormsClient]
+      def initialize(request_client:)
+        @request_client = request_client
+      end
+# Get a list of all company's forms
+#  scope: `company_forms:read`
+      #
+      # @param company_id [String] The UUID of the company
+      # @param request_options [Gusto::RequestOptions] 
+      # @return [Array<Gusto::Forms::Form>]
+      # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.companies.forms.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}/forms"
+end
+          parsed_json = JSON.parse(response.body)
+          parsed_json&.map do | item |
+            item = item.to_json
+            Gusto::Forms::Form.from_json(json_object: item)
+          end
+        end
+      end
+# Get a company form
+#  scope: `company_forms:read`
+      #
+      # @param form_id [String] The UUID of the form
+      # @param request_options [Gusto::RequestOptions] 
+      # @return [Gusto::Forms::Form]
+      # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.companies.forms.get(form_id: "form_id")
+      def get(form_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/forms/#{form_id}"
+end
+          Gusto::Forms::Form.from_json(json_object: response.body)
+        end
+      end
+# Get the link to the form PDF
+#  scope: `company_forms:read`
+      #
+      # @param form_id [String] The UUID of the form
+      # @param request_options [Gusto::RequestOptions] 
+      # @return [Gusto::FormPdf]
+      # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.companies.forms.get_pdf(form_id: "form_id")
+      def get_pdf(form_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/forms/#{form_id}/pdf"
+end
+          Gusto::FormPdf.from_json(json_object: response.body)
+        end
+      end
+# Sign a company form. Company forms must be signed by the company signatory.
+#  scope: `company_forms:sign`
+      #
+      # @param form_id [String] The UUID of the form
+      # @param signature_text [String] The signature
+      # @param agree [Boolean] whether you agree to sign electronically
+      # @param signed_by_ip_address [String] The IP address of the signatory who signed the form.
+      # @param request_options [Gusto::RequestOptions] 
+      # @return [Gusto::Forms::Form]
+      # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.companies.forms.sign(
+#    form_id: "form_id",
+#    signature_text: "Jane Smith",
+#    agree: true,
+#    signed_by_ip_address: "192.168.0.1"
+#  )
+      def sign(form_id:, signature_text:, agree:, signed_by_ip_address:, request_options: nil)
+        Async do
+          response = @request_client.conn.put 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 || {}), signature_text: signature_text, agree: agree, signed_by_ip_address: signed_by_ip_address }.compact
+  req.url "#{@request_client.get_url(request_options: request_options)}/v1/forms/#{form_id}/sign"
+end
+          Gusto::Forms::Form.from_json(json_object: response.body)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,207 @@
+# frozen_string_literal: true
+require_relative "../../../requests"
+require_relative "../../industry/types/industry"
+require "async"
+require "async"
+require_relative "../../../requests"
+
+module Gusto
+  module Companies
+    class IndustrySelectionClient
+    # @return [Gusto::RequestClient] 
+      attr_reader :request_client
+
+
+      # @param request_client [Gusto::RequestClient] 
+      # @return [Gusto::Companies::IndustrySelectionClient]
+      def initialize(request_client:)
+        @request_client = request_client
+      end
+# Get industry selection for the company.
+#  scope: `companies:read`
+      #
+      # @param company_id [String] The UUID of the company
+      # @param request_options [Gusto::RequestOptions] 
+      # @return [Gusto::Industry::Industry]
+      # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.companies.industry_selection.get(company_id: "company_id")
+      def get(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}/industry_selection"
+end
+        Gusto::Industry::Industry.from_json(json_object: response.body)
+      end
+# Update the company industry selection by passing in industry classification
+#  codes: [NAICS code](https://www.naics.com), [SICS code](https://siccode.com/)
+#  and industry title. Our UI is leveraging [Middesk
+#  API](https://docs.middesk.com/reference/introduction) to determine industry
+#  classification codes.
+#  scope: `companies:write`
+      #
+      # @param company_id [String] The UUID of the company
+      # @param title [String] Industry title
+      # @param naics_code [String] North American Industry Classification System (NAICS) is used to classify
+#  businesses with a six digit number based on the primary type of work the
+#  business performs
+      # @param sic_codes [Array<String>] A list of Standard Industrial Classification (SIC) codes, which are four digit
+#  number that categorize the industries that companies belong to based on their
+#  business activities. If sic_codes is not passed in, we will perform an internal
+#  lookup with naics_code.
+      # @param request_options [Gusto::RequestOptions] 
+      # @return [Gusto::Industry::Industry]
+      # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.companies.industry_selection.update(
+#    company_id: "company_id",
+#    title: "Computer Training",
+#    naics_code: "611420",
+#    sic_codes: ["8243"]
+#  )
+      def update(company_id:, title: nil, naics_code:, sic_codes: nil, request_options: nil)
+        response = @request_client.conn.put 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 || {}), title: title, naics_code: naics_code, sic_codes: sic_codes }.compact
+  req.url "#{@request_client.get_url(request_options: request_options)}/v1/companies/#{company_id}/industry_selection"
+end
+        Gusto::Industry::Industry.from_json(json_object: response.body)
+      end
+    end
+    class AsyncIndustrySelectionClient
+    # @return [Gusto::AsyncRequestClient] 
+      attr_reader :request_client
+
+
+      # @param request_client [Gusto::RequestClient] 
+      # @return [Gusto::Companies::AsyncIndustrySelectionClient]
+      def initialize(request_client:)
+        @request_client = request_client
+      end
+# Get industry selection for the company.
+#  scope: `companies:read`
+      #
+      # @param company_id [String] The UUID of the company
+      # @param request_options [Gusto::RequestOptions] 
+      # @return [Gusto::Industry::Industry]
+      # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.companies.industry_selection.get(company_id: "company_id")
+      def get(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}/industry_selection"
+end
+          Gusto::Industry::Industry.from_json(json_object: response.body)
+        end
+      end
+# Update the company industry selection by passing in industry classification
+#  codes: [NAICS code](https://www.naics.com), [SICS code](https://siccode.com/)
+#  and industry title. Our UI is leveraging [Middesk
+#  API](https://docs.middesk.com/reference/introduction) to determine industry
+#  classification codes.
+#  scope: `companies:write`
+      #
+      # @param company_id [String] The UUID of the company
+      # @param title [String] Industry title
+      # @param naics_code [String] North American Industry Classification System (NAICS) is used to classify
+#  businesses with a six digit number based on the primary type of work the
+#  business performs
+      # @param sic_codes [Array<String>] A list of Standard Industrial Classification (SIC) codes, which are four digit
+#  number that categorize the industries that companies belong to based on their
+#  business activities. If sic_codes is not passed in, we will perform an internal
+#  lookup with naics_code.
+      # @param request_options [Gusto::RequestOptions] 
+      # @return [Gusto::Industry::Industry]
+      # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.companies.industry_selection.update(
+#    company_id: "company_id",
+#    title: "Computer Training",
+#    naics_code: "611420",
+#    sic_codes: ["8243"]
+#  )
+      def update(company_id:, title: nil, naics_code:, sic_codes: nil, request_options: nil)
+        Async do
+          response = @request_client.conn.put 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 || {}), title: title, naics_code: naics_code, sic_codes: sic_codes }.compact
+  req.url "#{@request_client.get_url(request_options: request_options)}/v1/companies/#{company_id}/industry_selection"
+end
+          Gusto::Industry::Industry.from_json(json_object: response.body)
+        end
+      end
+    end
+  end
+end