fern_gusto 0.0.6.pre.alpha6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dab720016dabf77dfe8f7dec5b7152909337fe194b08af7aad90094ababe2833
+  data.tar.gz: 8254f93f64a63578f05e4102644cf66b5917eac544cf0efb2d935a998fefe418
+SHA512:
+  metadata.gz: 05bdd59abb1a5593bd9884bb9aecaf460595bfe4448a3ae29ccf793313385ad503df2228b50277dd0b4c3581be3c91dfa8207d3e8e10746bdcf62eed0dfc2057
+  data.tar.gz: e9c04ec247f2c1c67f0b87b0b76f7165604a4065605fec21d558c509d0e71c47b3faac2f65c06257f42bed9a865eaa1397ca352dc5240b4bda2b04f196013765

data/lib/base_gusto.rb

@@ -0,0 +1,175 @@
+# frozen_string_literal: true
+require_relative "environment"
+require_relative "types_export"
+require_relative "requests"
+require_relative "fern_gusto/token/client"
+require_relative "fern_gusto/companies/client"
+require_relative "fern_gusto/invoices/client"
+require_relative "fern_gusto/flows/client"
+require_relative "fern_gusto/employees/client"
+require_relative "fern_gusto/contractors/client"
+require_relative "fern_gusto/webhooks/client"
+require_relative "fern_gusto/payroll/client"
+require_relative "fern_gusto/time_off_policies/client"
+require_relative "fern_gusto/generated_documents/client"
+require_relative "fern_gusto/reports/client"
+require_relative "fern_gusto/holiday_pay_policies/client"
+require_relative "fern_gusto/notifications/client"
+require_relative "fern_gusto/events/client"
+require_relative "fern_gusto/recovery_cases/client"
+require_relative "fern_gusto/ach_transactions/client"
+require_relative "fern_gusto/wire_in_requests/client"
+require_relative "requests"
+
+module Gusto
+  class BaseClient
+  # @return [Gusto::TokenClient] 
+    attr_reader :token
+  # @return [Gusto::CompaniesClient] 
+    attr_reader :companies
+  # @return [Gusto::InvoicesClient] 
+    attr_reader :invoices
+  # @return [Gusto::FlowsClient] 
+    attr_reader :flows
+  # @return [Gusto::EmployeesClient] 
+    attr_reader :employees
+  # @return [Gusto::ContractorsClient] 
+    attr_reader :contractors
+  # @return [Gusto::WebhooksClient] 
+    attr_reader :webhooks
+  # @return [Gusto::PayrollClient] 
+    attr_reader :payroll
+  # @return [Gusto::TimeOffPoliciesClient] 
+    attr_reader :time_off_policies
+  # @return [Gusto::GeneratedDocumentsClient] 
+    attr_reader :generated_documents
+  # @return [Gusto::ReportsClient] 
+    attr_reader :reports
+  # @return [Gusto::HolidayPayPoliciesClient] 
+    attr_reader :holiday_pay_policies
+  # @return [Gusto::NotificationsClient] 
+    attr_reader :notifications
+  # @return [Gusto::EventsClient] 
+    attr_reader :events
+  # @return [Gusto::RecoveryCasesClient] 
+    attr_reader :recovery_cases
+  # @return [Gusto::AchTransactionsClient] 
+    attr_reader :ach_transactions
+  # @return [Gusto::WireInRequestsClient] 
+    attr_reader :wire_in_requests
+
+
+    # @param base_url [String] 
+    # @param environment [Gusto::Environment] 
+    # @param max_retries [Long] The number of times to retry a failed request, defaults to 2.
+    # @param timeout_in_seconds [Long] 
+    # @param token [String] 
+    # @param gusto_api_version [String] Determines the date-based API version associated with your API call. If none is
+#  provided, your application's [minimum API
+#  https://docs.gusto.com/embedded-payroll/docs/api-versioning#minimum-api-version)
+#  is used.
+    # @return [Gusto::Client]
+    def initialize(base_url: nil, environment: Gusto::Environment::DEMO, max_retries: nil, timeout_in_seconds: nil, token:, gusto_api_version: nil)
+      @request_client = Gusto::RequestClient.new(
+  base_url: base_url,
+  environment: environment,
+  max_retries: max_retries,
+  timeout_in_seconds: timeout_in_seconds,
+  token: token,
+  gusto_api_version: gusto_api_version
+)
+      @token = Gusto::TokenClient.new(request_client: @request_client)
+      @companies = Gusto::CompaniesClient.new(request_client: @request_client)
+      @invoices = Gusto::InvoicesClient.new(request_client: @request_client)
+      @flows = Gusto::FlowsClient.new(request_client: @request_client)
+      @employees = Gusto::EmployeesClient.new(request_client: @request_client)
+      @contractors = Gusto::ContractorsClient.new(request_client: @request_client)
+      @webhooks = Gusto::WebhooksClient.new(request_client: @request_client)
+      @payroll = Gusto::PayrollClient.new(request_client: @request_client)
+      @time_off_policies = Gusto::TimeOffPoliciesClient.new(request_client: @request_client)
+      @generated_documents = Gusto::GeneratedDocumentsClient.new(request_client: @request_client)
+      @reports = Gusto::ReportsClient.new(request_client: @request_client)
+      @holiday_pay_policies = Gusto::HolidayPayPoliciesClient.new(request_client: @request_client)
+      @notifications = Gusto::NotificationsClient.new(request_client: @request_client)
+      @events = Gusto::EventsClient.new(request_client: @request_client)
+      @recovery_cases = Gusto::RecoveryCasesClient.new(request_client: @request_client)
+      @ach_transactions = Gusto::AchTransactionsClient.new(request_client: @request_client)
+      @wire_in_requests = Gusto::WireInRequestsClient.new(request_client: @request_client)
+    end
+  end
+  class BaseAsyncClient
+  # @return [Gusto::AsyncTokenClient] 
+    attr_reader :token
+  # @return [Gusto::AsyncCompaniesClient] 
+    attr_reader :companies
+  # @return [Gusto::AsyncInvoicesClient] 
+    attr_reader :invoices
+  # @return [Gusto::AsyncFlowsClient] 
+    attr_reader :flows
+  # @return [Gusto::AsyncEmployeesClient] 
+    attr_reader :employees
+  # @return [Gusto::AsyncContractorsClient] 
+    attr_reader :contractors
+  # @return [Gusto::AsyncWebhooksClient] 
+    attr_reader :webhooks
+  # @return [Gusto::AsyncPayrollClient] 
+    attr_reader :payroll
+  # @return [Gusto::AsyncTimeOffPoliciesClient] 
+    attr_reader :time_off_policies
+  # @return [Gusto::AsyncGeneratedDocumentsClient] 
+    attr_reader :generated_documents
+  # @return [Gusto::AsyncReportsClient] 
+    attr_reader :reports
+  # @return [Gusto::AsyncHolidayPayPoliciesClient] 
+    attr_reader :holiday_pay_policies
+  # @return [Gusto::AsyncNotificationsClient] 
+    attr_reader :notifications
+  # @return [Gusto::AsyncEventsClient] 
+    attr_reader :events
+  # @return [Gusto::AsyncRecoveryCasesClient] 
+    attr_reader :recovery_cases
+  # @return [Gusto::AsyncAchTransactionsClient] 
+    attr_reader :ach_transactions
+  # @return [Gusto::AsyncWireInRequestsClient] 
+    attr_reader :wire_in_requests
+
+
+    # @param base_url [String] 
+    # @param environment [Gusto::Environment] 
+    # @param max_retries [Long] The number of times to retry a failed request, defaults to 2.
+    # @param timeout_in_seconds [Long] 
+    # @param token [String] 
+    # @param gusto_api_version [String] Determines the date-based API version associated with your API call. If none is
+#  provided, your application's [minimum API
+#  https://docs.gusto.com/embedded-payroll/docs/api-versioning#minimum-api-version)
+#  is used.
+    # @return [Gusto::AsyncClient]
+    def initialize(base_url: nil, environment: Gusto::Environment::DEMO, max_retries: nil, timeout_in_seconds: nil, token:, gusto_api_version: nil)
+      @async_request_client = Gusto::AsyncRequestClient.new(
+  base_url: base_url,
+  environment: environment,
+  max_retries: max_retries,
+  timeout_in_seconds: timeout_in_seconds,
+  token: token,
+  gusto_api_version: gusto_api_version
+)
+      @token = Gusto::AsyncTokenClient.new(request_client: @async_request_client)
+      @companies = Gusto::AsyncCompaniesClient.new(request_client: @async_request_client)
+      @invoices = Gusto::AsyncInvoicesClient.new(request_client: @async_request_client)
+      @flows = Gusto::AsyncFlowsClient.new(request_client: @async_request_client)
+      @employees = Gusto::AsyncEmployeesClient.new(request_client: @async_request_client)
+      @contractors = Gusto::AsyncContractorsClient.new(request_client: @async_request_client)
+      @webhooks = Gusto::AsyncWebhooksClient.new(request_client: @async_request_client)
+      @payroll = Gusto::AsyncPayrollClient.new(request_client: @async_request_client)
+      @time_off_policies = Gusto::AsyncTimeOffPoliciesClient.new(request_client: @async_request_client)
+      @generated_documents = Gusto::AsyncGeneratedDocumentsClient.new(request_client: @async_request_client)
+      @reports = Gusto::AsyncReportsClient.new(request_client: @async_request_client)
+      @holiday_pay_policies = Gusto::AsyncHolidayPayPoliciesClient.new(request_client: @async_request_client)
+      @notifications = Gusto::AsyncNotificationsClient.new(request_client: @async_request_client)
+      @events = Gusto::AsyncEventsClient.new(request_client: @async_request_client)
+      @recovery_cases = Gusto::AsyncRecoveryCasesClient.new(request_client: @async_request_client)
+      @ach_transactions = Gusto::AsyncAchTransactionsClient.new(request_client: @async_request_client)
+      @wire_in_requests = Gusto::AsyncWireInRequestsClient.new(request_client: @async_request_client)
+    end
+  end
+end

data/lib/core/file_utilities.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+require "faraday/multipart"
+require "mini_mime"
+
+module Gusto
+# Utility class for managing files.
+  class FileUtilities
+
+
+    # @param file_like [String, IO] The file to be uploaded, or a string path to the file.
+    # @return [Faraday::Multipart::FilePart]
+    def self.as_faraday_multipart(file_like:)
+      unless file_like.is_a?(String)
+        path = file_like.path
+      else
+        path = file_like
+      end
+      mime_type = MiniMime.lookup_by_filename(path)
+      unless mime_type.nil?
+        mime_type = mime_type.content_type
+      else
+        mime_type = "application/octet-stream"
+      end
+      Faraday::Multipart::FilePart.new(file_like, mime_type)
+    end
+  end
+end

data/lib/environment.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Gusto
+  class Environment
+
+    DEMO = "https://api.gusto-demo.com"
+
+  end
+end

data/lib/fern_gusto/ach_transactions/client.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+require_relative "../../requests"
+require_relative "../types/ach_transaction"
+require "json"
+require "async"
+require_relative "../../requests"
+
+module Gusto
+  class AchTransactionsClient
+  # @return [Gusto::RequestClient] 
+    attr_reader :request_client
+
+
+    # @param request_client [Gusto::RequestClient] 
+    # @return [Gusto::AchTransactionsClient]
+    def initialize(request_client:)
+      @request_client = request_client
+    end
+# Fetches all ACH transactions for a company.
+#  scope: `ach_transactions:read`
+    #
+    # @param company_uuid [String] The UUID of the company
+    # @param contractor_payment_uuid [String] The UUID of the contractor payment
+    # @param payroll_uuid [String] The UUID of the payroll
+    # @param transaction_type [String] Used to filter the ACH transactions to only include those with a specific
+#  transaction type, such as "Credit employee pay".
+    # @param payment_direction [String] Used to filter the ACH transactions to only include those with a specific
+#  payment direction, either "credit" or "debit".
+    # @param request_options [Gusto::RequestOptions] 
+    # @return [Array<Gusto::AchTransaction>]
+    # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.ach_transactions.list(company_uuid: "company_uuid")
+    def list(company_uuid:, contractor_payment_uuid: nil, payroll_uuid: nil, transaction_type: nil, payment_direction: nil, 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
+  req.params = { **(request_options&.additional_query_parameters || {}), "contractor_payment_uuid": contractor_payment_uuid, "payroll_uuid": payroll_uuid, "transaction_type": transaction_type, "payment_direction": payment_direction }.compact
+  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_uuid}/ach_transactions"
+end
+      parsed_json = JSON.parse(response.body)
+      parsed_json&.map do | item |
+        item = item.to_json
+        Gusto::AchTransaction.from_json(json_object: item)
+      end
+    end
+  end
+  class AsyncAchTransactionsClient
+  # @return [Gusto::AsyncRequestClient] 
+    attr_reader :request_client
+
+
+    # @param request_client [Gusto::RequestClient] 
+    # @return [Gusto::AsyncAchTransactionsClient]
+    def initialize(request_client:)
+      @request_client = request_client
+    end
+# Fetches all ACH transactions for a company.
+#  scope: `ach_transactions:read`
+    #
+    # @param company_uuid [String] The UUID of the company
+    # @param contractor_payment_uuid [String] The UUID of the contractor payment
+    # @param payroll_uuid [String] The UUID of the payroll
+    # @param transaction_type [String] Used to filter the ACH transactions to only include those with a specific
+#  transaction type, such as "Credit employee pay".
+    # @param payment_direction [String] Used to filter the ACH transactions to only include those with a specific
+#  payment direction, either "credit" or "debit".
+    # @param request_options [Gusto::RequestOptions] 
+    # @return [Array<Gusto::AchTransaction>]
+    # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.ach_transactions.list(company_uuid: "company_uuid")
+    def list(company_uuid:, contractor_payment_uuid: nil, payroll_uuid: nil, transaction_type: nil, payment_direction: nil, 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
+  req.params = { **(request_options&.additional_query_parameters || {}), "contractor_payment_uuid": contractor_payment_uuid, "payroll_uuid": payroll_uuid, "transaction_type": transaction_type, "payment_direction": payment_direction }.compact
+  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_uuid}/ach_transactions"
+end
+        parsed_json = JSON.parse(response.body)
+        parsed_json&.map do | item |
+          item = item.to_json
+          Gusto::AchTransaction.from_json(json_object: item)
+        end
+      end
+    end
+  end
+end

data/lib/fern_gusto/admins/types/admin.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+require "ostruct"
+require "json"
+
+module Gusto
+  module Admins
+# The representation of an admin user in Gusto.
+    class Admin
+    # @return [String] The unique id of the admin.
+      attr_reader :uuid
+    # @return [String] The email of the admin for Gusto's system. If the email matches an existing
+#  user, this will create an admin account for them.
+      attr_reader :email
+    # @return [String] The first name of the admin.
+      attr_reader :first_name
+    # @return [String] The last name of the admin.
+      attr_reader :last_name
+    # @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 uuid [String] The unique id of the admin.
+      # @param email [String] The email of the admin for Gusto's system. If the email matches an existing
+#  user, this will create an admin account for them.
+      # @param first_name [String] The first name of the admin.
+      # @param last_name [String] The last name of the admin.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Gusto::Admins::Admin]
+      def initialize(uuid:, email: OMIT, first_name: OMIT, last_name: OMIT, additional_properties: nil)
+        @uuid = uuid
+        @email = email if email != OMIT
+        @first_name = first_name if first_name != OMIT
+        @last_name = last_name if last_name != OMIT
+        @additional_properties = additional_properties
+        @_field_set = { "uuid": uuid, "email": email, "first_name": first_name, "last_name": last_name }.reject do | _k, v |
+  v == OMIT
+end
+      end
+# Deserialize a JSON object to an instance of Admin
+      #
+      # @param json_object [String] 
+      # @return [Gusto::Admins::Admin]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        uuid = parsed_json["uuid"]
+        email = parsed_json["email"]
+        first_name = parsed_json["first_name"]
+        last_name = parsed_json["last_name"]
+        new(
+          uuid: uuid,
+          email: email,
+          first_name: first_name,
+          last_name: last_name,
+          additional_properties: struct
+        )
+      end
+# Serialize an instance of Admin 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.uuid.is_a?(String) != false || raise("Passed value for field obj.uuid is not the expected type, validation failed.")
+        obj.email&.is_a?(String) != false || raise("Passed value for field obj.email is not the expected type, validation failed.")
+        obj.first_name&.is_a?(String) != false || raise("Passed value for field obj.first_name is not the expected type, validation failed.")
+        obj.last_name&.is_a?(String) != false || raise("Passed value for field obj.last_name is not the expected type, validation failed.")
+      end
+    end
+  end
+end