fern_gusto 0.0.6.pre.alpha6

data/lib/fern_gusto/forms/types/form1099.rb

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+require "ostruct"
+require "json"
+
+module Gusto
+  module Forms
+    class Form1099
+    # @return [String] The UUID of the form
+      attr_reader :uuid
+    # @return [String] The type identifier of the form
+      attr_reader :name
+    # @return [String] The title of the form
+      attr_reader :title
+    # @return [String] The description of the form
+      attr_reader :description
+    # @return [Boolean] If the form is in a draft state. E.g. End of year tax forms may be provided in a
+#  draft state prior to being finalized.
+      attr_reader :draft
+    # @return [Integer] The year of this form. For some forms, e.g. tax forms, this is the year which
+#  the form represents. A 1099 for January - December 2022 would be delivered in
+#  January 2023 and have a year value of 2022. This value is nullable and will not
+#  be present on all forms.
+      attr_reader :year
+    # @return [Integer] The quarter of this form. This value is currently always null since it is not
+#  present on any contractor forms.
+      attr_reader :quarter
+    # @return [Boolean] A boolean flag that indicates whether the form needs signing or not. Note that
+#  this value will change after the form is signed.
+      attr_reader :requires_signing
+    # @return [String] The contractor UUID
+      attr_reader :contractor_uuid
+    # @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 UUID of the form
+      # @param name [String] The type identifier of the form
+      # @param title [String] The title of the form
+      # @param description [String] The description of the form
+      # @param draft [Boolean] If the form is in a draft state. E.g. End of year tax forms may be provided in a
+#  draft state prior to being finalized.
+      # @param year [Integer] The year of this form. For some forms, e.g. tax forms, this is the year which
+#  the form represents. A 1099 for January - December 2022 would be delivered in
+#  January 2023 and have a year value of 2022. This value is nullable and will not
+#  be present on all forms.
+      # @param quarter [Integer] The quarter of this form. This value is currently always null since it is not
+#  present on any contractor forms.
+      # @param requires_signing [Boolean] A boolean flag that indicates whether the form needs signing or not. Note that
+#  this value will change after the form is signed.
+      # @param contractor_uuid [String] The contractor UUID
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Gusto::Forms::Form1099]
+      def initialize(uuid:, name: OMIT, title: OMIT, description: OMIT, draft: OMIT, year: OMIT, quarter: OMIT, requires_signing: OMIT, contractor_uuid: OMIT, additional_properties: nil)
+        @uuid = uuid
+        @name = name if name != OMIT
+        @title = title if title != OMIT
+        @description = description if description != OMIT
+        @draft = draft if draft != OMIT
+        @year = year if year != OMIT
+        @quarter = quarter if quarter != OMIT
+        @requires_signing = requires_signing if requires_signing != OMIT
+        @contractor_uuid = contractor_uuid if contractor_uuid != OMIT
+        @additional_properties = additional_properties
+        @_field_set = { "uuid": uuid, "name": name, "title": title, "description": description, "draft": draft, "year": year, "quarter": quarter, "requires_signing": requires_signing, "contractor_uuid": contractor_uuid }.reject do | _k, v |
+  v == OMIT
+end
+      end
+# Deserialize a JSON object to an instance of Form1099
+      #
+      # @param json_object [String] 
+      # @return [Gusto::Forms::Form1099]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        uuid = parsed_json["uuid"]
+        name = parsed_json["name"]
+        title = parsed_json["title"]
+        description = parsed_json["description"]
+        draft = parsed_json["draft"]
+        year = parsed_json["year"]
+        quarter = parsed_json["quarter"]
+        requires_signing = parsed_json["requires_signing"]
+        contractor_uuid = parsed_json["contractor_uuid"]
+        new(
+          uuid: uuid,
+          name: name,
+          title: title,
+          description: description,
+          draft: draft,
+          year: year,
+          quarter: quarter,
+          requires_signing: requires_signing,
+          contractor_uuid: contractor_uuid,
+          additional_properties: struct
+        )
+      end
+# Serialize an instance of Form1099 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.name&.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
+        obj.title&.is_a?(String) != false || raise("Passed value for field obj.title is not the expected type, validation failed.")
+        obj.description&.is_a?(String) != false || raise("Passed value for field obj.description is not the expected type, validation failed.")
+        obj.draft&.is_a?(Boolean) != false || raise("Passed value for field obj.draft is not the expected type, validation failed.")
+        obj.year&.is_a?(Integer) != false || raise("Passed value for field obj.year is not the expected type, validation failed.")
+        obj.quarter&.is_a?(Integer) != false || raise("Passed value for field obj.quarter is not the expected type, validation failed.")
+        obj.requires_signing&.is_a?(Boolean) != false || raise("Passed value for field obj.requires_signing is not the expected type, validation failed.")
+        obj.contractor_uuid&.is_a?(String) != false || raise("Passed value for field obj.contractor_uuid is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/fern_gusto/generated_documents/client.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+require_relative "../../requests"
+require_relative "../types/generated_document"
+require "async"
+require_relative "../../requests"
+
+module Gusto
+  class GeneratedDocumentsClient
+  # @return [Gusto::RequestClient] 
+    attr_reader :request_client
+
+
+    # @param request_client [Gusto::RequestClient] 
+    # @return [Gusto::GeneratedDocumentsClient]
+    def initialize(request_client:)
+      @request_client = request_client
+    end
+# Get a generated document given the request_uuid. The response will include the
+#  generation request's status and, if complete, the relevant document urls.
+#  scope: `generated_documents:read`
+    #
+    # @param document_type [String] the type of document being generated
+    # @param request_uuid [String] The UUID of the Generated Document Request
+    # @param request_options [Gusto::RequestOptions] 
+    # @return [Gusto::GeneratedDocument]
+    # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.generated_documents.get(document_type: "document_type", request_uuid: "request_uuid")
+    def get(document_type:, request_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/generated_documents/#{document_type}/#{request_uuid}"
+end
+      Gusto::GeneratedDocument.from_json(json_object: response.body)
+    end
+  end
+  class AsyncGeneratedDocumentsClient
+  # @return [Gusto::AsyncRequestClient] 
+    attr_reader :request_client
+
+
+    # @param request_client [Gusto::RequestClient] 
+    # @return [Gusto::AsyncGeneratedDocumentsClient]
+    def initialize(request_client:)
+      @request_client = request_client
+    end
+# Get a generated document given the request_uuid. The response will include the
+#  generation request's status and, if complete, the relevant document urls.
+#  scope: `generated_documents:read`
+    #
+    # @param document_type [String] the type of document being generated
+    # @param request_uuid [String] The UUID of the Generated Document Request
+    # @param request_options [Gusto::RequestOptions] 
+    # @return [Gusto::GeneratedDocument]
+    # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.generated_documents.get(document_type: "document_type", request_uuid: "request_uuid")
+    def get(document_type:, request_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/generated_documents/#{document_type}/#{request_uuid}"
+end
+        Gusto::GeneratedDocument.from_json(json_object: response.body)
+      end
+    end
+  end
+end