signwell_sdk 0.0.1.pre.alpha.1

data/lib/signwell_sdk/models/v1/document_template_list_response.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module SignwellSDK
+  module Models
+    module V1
+      # @see SignwellSDK::Resources::V1::DocumentTemplates#list
+      class DocumentTemplateListResponse < SignwellSDK::Internal::Type::BaseModel
+        # @!attribute current_page
+        #
+        #   @return [Integer]
+        required :current_page, Integer
+
+        # @!attribute templates
+        #
+        #   @return [Array<SignwellSDK::Models::V1::DocumentTemplate>]
+        required :templates, -> { SignwellSDK::Internal::Type::ArrayOf[SignwellSDK::V1::DocumentTemplate] }
+
+        # @!attribute total_count
+        #
+        #   @return [Integer]
+        required :total_count, Integer
+
+        # @!attribute total_pages
+        #
+        #   @return [Integer]
+        required :total_pages, Integer
+
+        # @!attribute next_page
+        #
+        #   @return [Integer, nil]
+        optional :next_page, Integer, nil?: true
+
+        # @!attribute previous_page
+        #
+        #   @return [Integer, nil]
+        optional :previous_page, Integer, nil?: true
+
+        # @!method initialize(current_page:, templates:, total_count:, total_pages:, next_page: nil, previous_page: nil)
+        #   List of templates with pagination
+        #
+        #   @param current_page [Integer]
+        #   @param templates [Array<SignwellSDK::Models::V1::DocumentTemplate>]
+        #   @param total_count [Integer]
+        #   @param total_pages [Integer]
+        #   @param next_page [Integer, nil]
+        #   @param previous_page [Integer, nil]
+      end
+    end
+  end
+end

data/lib/signwell_sdk/models/v1/document_template_retrieve_params.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module SignwellSDK
+  module Models
+    module V1
+      # @see SignwellSDK::Resources::V1::DocumentTemplates#retrieve
+      class DocumentTemplateRetrieveParams < SignwellSDK::Internal::Type::BaseModel
+        extend SignwellSDK::Internal::Type::RequestParameters::Converter
+        include SignwellSDK::Internal::Type::RequestParameters
+
+        # @!method initialize(request_options: {})
+        #   @param request_options [SignwellSDK::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/signwell_sdk/models/v1/document_template_update_params.rb

@@ -0,0 +1,162 @@
+# frozen_string_literal: true
+
+module SignwellSDK
+  module Models
+    module V1
+      # @see SignwellSDK::Resources::V1::DocumentTemplates#update
+      class DocumentTemplateUpdateParams < SignwellSDK::Internal::Type::BaseModel
+        extend SignwellSDK::Internal::Type::RequestParameters::Converter
+        include SignwellSDK::Internal::Type::RequestParameters
+
+        # @!attribute allow_decline
+        #   Whether to allow recipients the option to decline signing a document. If
+        #   multiple signers are involved in a document, any single recipient can cancel the
+        #   entire document signing process by declining to sign.
+        #
+        #   @return [Boolean, nil]
+        optional :allow_decline, SignwellSDK::Internal::Type::Boolean
+
+        # @!attribute allow_reassign
+        #   In some cases a signer is not the right person to sign and may need to reassign
+        #   their signing responsibilities to another person. This feature allows them to
+        #   reassign the document to someone else.
+        #
+        #   @return [Boolean, nil]
+        optional :allow_reassign, SignwellSDK::Internal::Type::Boolean
+
+        # @!attribute api_application_id
+        #   Unique identifier for API Application settings to use. API Applications are
+        #   optional and mainly used when isolating OAuth apps or for more control over
+        #   embedded API settings
+        #
+        #   @return [String, nil]
+        optional :api_application_id, String
+
+        # @!attribute apply_signing_order
+        #   When set to `true` recipients will sign one at a time in the order of the
+        #   `recipients` collection of this request.
+        #
+        #   @return [Boolean, nil]
+        optional :apply_signing_order, SignwellSDK::Internal::Type::Boolean
+
+        # @!attribute checkbox_groups
+        #   Checkbox fields that are placed on a document can be grouped with selection
+        #   requirements. At least 2 checkbox fields in an array of fields must be assigned
+        #   to the same recipient.
+        #
+        #   @return [Array<SignwellSDK::Models::V1::TemplateCheckboxGroup>, nil]
+        optional :checkbox_groups,
+                 -> { SignwellSDK::Internal::Type::ArrayOf[SignwellSDK::V1::TemplateCheckboxGroup] }
+
+        # @!attribute decline_redirect_url
+        #   A URL that recipients are redirected to if the document is declined.
+        #
+        #   @return [String, nil]
+        optional :decline_redirect_url, String
+
+        # @!attribute draft
+        #   Whether the template can still be updated before it is ready for usage. If set
+        #   to `false` the template is marked as `Available` and it will be ready for use.
+        #   Defaults to `false`.
+        #
+        #   @return [Boolean, nil]
+        optional :draft, SignwellSDK::Internal::Type::Boolean
+
+        # @!attribute expires_in
+        #   Number of days before the signature request expires. Defaults to the account
+        #   expiration setting or template expiration (if the document is created from a
+        #   template).
+        #
+        #   @return [Integer, nil]
+        optional :expires_in, Integer
+
+        # @!attribute labels
+        #   Labels can be used to organize documents in a way that can make it easy to find
+        #   using the document search in SignWell. A document can have multiple labels.
+        #   Updating labels on a document will replace any existing labels for that
+        #   document.
+        #
+        #   @return [Array<SignwellSDK::Models::V1::Label>, nil]
+        optional :labels, -> { SignwellSDK::Internal::Type::ArrayOf[SignwellSDK::V1::Label] }
+
+        # @!attribute message
+        #   Email message for the signature request that recipients will see. Defaults to
+        #   the default system message or a template message (if the document is created
+        #   from a template).
+        #
+        #   @return [String, nil]
+        optional :message, String
+
+        # @!attribute metadata
+        #   Optional key-value data that can be associated with the document. If set, will
+        #   be available every time the document data is returned.
+        #
+        #   @return [Hash{Symbol=>String}, nil]
+        optional :metadata, SignwellSDK::Internal::Type::HashOf[String]
+
+        # @!attribute name
+        #   The name of the template.
+        #
+        #   @return [String, nil]
+        optional :name, String
+
+        # @!attribute redirect_url
+        #   A URL that recipients are redirected to after successfully signing a document.
+        #
+        #   @return [String, nil]
+        optional :redirect_url, String
+
+        # @!attribute reminders
+        #   Whether to send signing reminders to recipients. Reminders are sent on day 3,
+        #   day 6, and day 10 if set to `true`. Defaults to `true`.
+        #
+        #   @return [Boolean, nil]
+        optional :reminders, SignwellSDK::Internal::Type::Boolean
+
+        # @!attribute subject
+        #   Email subject for the signature request that recipients will see. Defaults to
+        #   the default system subject or a template subject (if the document is created
+        #   from a template).
+        #
+        #   @return [String, nil]
+        optional :subject, String
+
+        # @!method initialize(allow_decline: nil, allow_reassign: nil, api_application_id: nil, apply_signing_order: nil, checkbox_groups: nil, decline_redirect_url: nil, draft: nil, expires_in: nil, labels: nil, message: nil, metadata: nil, name: nil, redirect_url: nil, reminders: nil, subject: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {SignwellSDK::Models::V1::DocumentTemplateUpdateParams} for more details.
+        #
+        #   @param allow_decline [Boolean] Whether to allow recipients the option to decline signing a document. If multipl
+        #
+        #   @param allow_reassign [Boolean] In some cases a signer is not the right person to sign and may need to reassign
+        #
+        #   @param api_application_id [String] Unique identifier for API Application settings to use. API Applications are opti
+        #
+        #   @param apply_signing_order [Boolean] When set to `true` recipients will sign one at a time in the order of the `recip
+        #
+        #   @param checkbox_groups [Array<SignwellSDK::Models::V1::TemplateCheckboxGroup>] Checkbox fields that are placed on a document can be grouped with selection requ
+        #
+        #   @param decline_redirect_url [String] A URL that recipients are redirected to if the document is declined.
+        #
+        #   @param draft [Boolean] Whether the template can still be updated before it is ready for usage. If set t
+        #
+        #   @param expires_in [Integer] Number of days before the signature request expires. Defaults to the account exp
+        #
+        #   @param labels [Array<SignwellSDK::Models::V1::Label>] Labels can be used to organize documents in a way that can make it easy to find
+        #
+        #   @param message [String] Email message for the signature request that recipients will see. Defaults to th
+        #
+        #   @param metadata [Hash{Symbol=>String}] Optional key-value data that can be associated with the document. If set, will b
+        #
+        #   @param name [String] The name of the template.
+        #
+        #   @param redirect_url [String] A URL that recipients are redirected to after successfully signing a document.
+        #
+        #   @param reminders [Boolean] Whether to send signing reminders to recipients. Reminders are sent on day 3, da
+        #
+        #   @param subject [String] Email subject for the signature request that recipients will see. Defaults to th
+        #
+        #   @param request_options [SignwellSDK::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/signwell_sdk/models/v1/hook_create_params.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module SignwellSDK
+  module Models
+    module V1
+      # @see SignwellSDK::Resources::V1::Hooks#create
+      class HookCreateParams < SignwellSDK::Internal::Type::BaseModel
+        extend SignwellSDK::Internal::Type::RequestParameters::Converter
+        include SignwellSDK::Internal::Type::RequestParameters
+
+        # @!attribute callback_url
+        #   URL that we will post document events to.
+        #
+        #   @return [String]
+        required :callback_url, String
+
+        # @!attribute api_application_id
+        #   Unique identifier for the API Application.
+        #
+        #   @return [String, nil]
+        optional :api_application_id, String
+
+        # @!method initialize(callback_url:, api_application_id: nil, request_options: {})
+        #   @param callback_url [String] URL that we will post document events to.
+        #
+        #   @param api_application_id [String] Unique identifier for the API Application.
+        #
+        #   @param request_options [SignwellSDK::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/signwell_sdk/models/v1/hook_delete_params.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module SignwellSDK
+  module Models
+    module V1
+      # @see SignwellSDK::Resources::V1::Hooks#delete
+      class HookDeleteParams < SignwellSDK::Internal::Type::BaseModel
+        extend SignwellSDK::Internal::Type::RequestParameters::Converter
+        include SignwellSDK::Internal::Type::RequestParameters
+
+        # @!method initialize(request_options: {})
+        #   @param request_options [SignwellSDK::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/signwell_sdk/models/v1/hook_list_params.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module SignwellSDK
+  module Models
+    module V1
+      # @see SignwellSDK::Resources::V1::Hooks#list
+      class HookListParams < SignwellSDK::Internal::Type::BaseModel
+        extend SignwellSDK::Internal::Type::RequestParameters::Converter
+        include SignwellSDK::Internal::Type::RequestParameters
+
+        # @!method initialize(request_options: {})
+        #   @param request_options [SignwellSDK::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/signwell_sdk/models/v1/label.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module SignwellSDK
+  module Models
+    module V1
+      class Label < SignwellSDK::Internal::Type::BaseModel
+        # @!attribute name
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!method initialize(name:)
+        #   Labels can be used to organize documents and templates in a way that can make it
+        #   easy to find using the document search/template search in SignWell. Labels can
+        #   be used to organize documents in a way that can make it easy to find using the
+        #   document search in SignWell.
+        #
+        #   @param name [String]
+      end
+    end
+  end
+end

data/lib/signwell_sdk/models/v1/template_checkbox_group.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module SignwellSDK
+  module Models
+    module V1
+      class TemplateCheckboxGroup < SignwellSDK::Internal::Type::BaseModel
+        # @!attribute checkbox_ids
+        #
+        #   @return [Array<String>]
+        required :checkbox_ids, SignwellSDK::Internal::Type::ArrayOf[String]
+
+        # @!attribute group_name
+        #   A unique identifier for the checkbox group.
+        #
+        #   @return [String]
+        required :group_name, String
+
+        # @!attribute placeholder_id
+        #   The recipient ID associated with the checkbox group.
+        #
+        #   @return [String]
+        required :placeholder_id, String
+
+        # @!attribute exact_value
+        #   The exact number of checkboxes that must be checked in the group. (Only for
+        #   validation: exact)
+        #
+        #   @return [Integer, nil]
+        optional :exact_value, Integer
+
+        # @!attribute max_value
+        #   The maximum number of checkboxes that can be checked in the group. (Only for
+        #   validation: maximum and range)
+        #
+        #   @return [Integer, nil]
+        optional :max_value, Integer
+
+        # @!attribute min_value
+        #   The minimum number of checkboxes that must be checked in the group. (Only for
+        #   validation: minimum and range)
+        #
+        #   @return [Integer, nil]
+        optional :min_value, Integer
+
+        # @!attribute required
+        #   Whether the group must be completed by the recipient. Defaults to false.
+        #
+        #   @return [Boolean, nil]
+        optional :required, SignwellSDK::Internal::Type::Boolean
+
+        # @!attribute validation
+        #   Set requirements for the group of one or multiple selections by the recipient.
+        #   Defaults to minimum. Validation values: minimum, maximum, exact, range.
+        #
+        #   @return [Symbol, SignwellSDK::Models::CheckboxValidation, nil]
+        optional :validation, enum: -> { SignwellSDK::CheckboxValidation }
+
+        # @!method initialize(checkbox_ids:, group_name:, placeholder_id:, exact_value: nil, max_value: nil, min_value: nil, required: nil, validation: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {SignwellSDK::Models::V1::TemplateCheckboxGroup} for more details.
+        #
+        #   @param checkbox_ids [Array<String>]
+        #
+        #   @param group_name [String] A unique identifier for the checkbox group.
+        #
+        #   @param placeholder_id [String] The recipient ID associated with the checkbox group.
+        #
+        #   @param exact_value [Integer] The exact number of checkboxes that must be checked in the group. (Only for vali
+        #
+        #   @param max_value [Integer] The maximum number of checkboxes that can be checked in the group. (Only for val
+        #
+        #   @param min_value [Integer] The minimum number of checkboxes that must be checked in the group. (Only for va
+        #
+        #   @param required [Boolean] Whether the group must be completed by the recipient. Defaults to false.
+        #
+        #   @param validation [Symbol, SignwellSDK::Models::CheckboxValidation] Set requirements for the group of one or multiple selections by the recipient. D
+      end
+    end
+  end
+end

data/lib/signwell_sdk/models/v1_me_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module SignwellSDK
+  module Models
+    # @see SignwellSDK::Resources::V1#me
+    class V1MeParams < SignwellSDK::Internal::Type::BaseModel
+      extend SignwellSDK::Internal::Type::RequestParameters::Converter
+      include SignwellSDK::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [SignwellSDK::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/signwell_sdk/models.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module SignwellSDK
+  [SignwellSDK::Internal::Type::BaseModel, *SignwellSDK::Internal::Type::BaseModel.subclasses].each do |cls|
+    cls.define_sorbet_constant!(:OrHash) { T.type_alias { T.any(cls, SignwellSDK::Internal::AnyHash) } }
+  end
+
+  SignwellSDK::Internal::Util.walk_namespaces(SignwellSDK::Models).each do |mod|
+    case mod
+    in SignwellSDK::Internal::Type::Enum | SignwellSDK::Internal::Type::Union
+      mod.constants.each do |name|
+        case mod.const_get(name)
+        in true | false
+          mod.define_sorbet_constant!(:TaggedBoolean) { T.type_alias { T::Boolean } }
+          mod.define_sorbet_constant!(:OrBoolean) { T.type_alias { T::Boolean } }
+        in Integer
+          mod.define_sorbet_constant!(:TaggedInteger) { T.type_alias { Integer } }
+          mod.define_sorbet_constant!(:OrInteger) { T.type_alias { Integer } }
+        in Float
+          mod.define_sorbet_constant!(:TaggedFloat) { T.type_alias { Float } }
+          mod.define_sorbet_constant!(:OrFloat) { T.type_alias { Float } }
+        in Symbol
+          mod.define_sorbet_constant!(:TaggedSymbol) { T.type_alias { Symbol } }
+          mod.define_sorbet_constant!(:OrSymbol) { T.type_alias { T.any(Symbol, String) } }
+        else
+        end
+      end
+    else
+    end
+  end
+
+  SignwellSDK::Internal::Util.walk_namespaces(SignwellSDK::Models)
+                             .lazy
+                             .grep(SignwellSDK::Internal::Type::Union)
+                             .each do |mod|
+    const = :Variants
+    next if mod.sorbet_constant_defined?(const)
+
+    mod.define_sorbet_constant!(const) { T.type_alias { mod.to_sorbet_type } }
+  end
+
+  AttachmentRequestInfo = SignwellSDK::Models::AttachmentRequestInfo
+
+  CheckboxGroupInfo = SignwellSDK::Models::CheckboxGroupInfo
+
+  CheckboxValidation = SignwellSDK::Models::CheckboxValidation
+
+  CopiedContactInfo = SignwellSDK::Models::CopiedContactInfo
+
+  DateFormat = SignwellSDK::Models::DateFormat
+
+  FieldType = SignwellSDK::Models::FieldType
+
+  FileInfo = SignwellSDK::Models::FileInfo
+
+  LabelInfo = SignwellSDK::Models::LabelInfo
+
+  TextValidation = SignwellSDK::Models::TextValidation
+
+  V1 = SignwellSDK::Models::V1
+
+  V1MeParams = SignwellSDK::Models::V1MeParams
+end

data/lib/signwell_sdk/request_options.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module SignwellSDK
+  # Specify HTTP behaviour to use for a specific request. These options supplement
+  # or override those provided at the client level.
+  #
+  # When making a request, you can pass an actual {RequestOptions} instance, or
+  # simply pass a Hash with symbol keys matching the attributes on this class.
+  class RequestOptions < SignwellSDK::Internal::Type::BaseModel
+    # @api private
+    #
+    # @param opts [SignwellSDK::RequestOptions, Hash{Symbol=>Object}]
+    #
+    # @raise [ArgumentError]
+    def self.validate!(opts)
+      case opts
+      in SignwellSDK::RequestOptions | Hash
+        opts.to_h.each_key do |k|
+          unless fields.include?(k)
+            raise ArgumentError.new("Request `opts` keys must be one of #{fields.keys}, got #{k.inspect}")
+          end
+        end
+      else
+        raise ArgumentError.new("Request `opts` must be a Hash or RequestOptions, got #{opts.inspect}")
+      end
+    end
+
+    # @!attribute idempotency_key
+    #   Idempotency key to send with request and all associated retries. Will only be
+    #   sent for write requests.
+    #
+    #   @return [String, nil]
+    optional :idempotency_key, String
+
+    # @!attribute extra_query
+    #   Extra query params to send with the request. These are `.merge`’d into any
+    #   `query` given at the client level.
+    #
+    #   @return [Hash{String=>Array<String>, String, nil}, nil]
+    optional :extra_query, SignwellSDK::Internal::Type::HashOf[SignwellSDK::Internal::Type::ArrayOf[String]]
+
+    # @!attribute extra_headers
+    #   Extra headers to send with the request. These are `.merged`’d into any
+    #   `extra_headers` given at the client level.
+    #
+    #   @return [Hash{String=>String, nil}, nil]
+    optional :extra_headers, SignwellSDK::Internal::Type::HashOf[String, nil?: true]
+
+    # @!attribute extra_body
+    #   Extra data to send with the request. These are deep merged into any data
+    #   generated as part of the normal request.
+    #
+    #   @return [Object, nil]
+    optional :extra_body, SignwellSDK::Internal::Type::HashOf[SignwellSDK::Internal::Type::Unknown]
+
+    # @!attribute max_retries
+    #   Maximum number of retries to attempt after a failed initial request.
+    #
+    #   @return [Integer, nil]
+    optional :max_retries, Integer
+
+    # @!attribute timeout
+    #   Request timeout in seconds.
+    #
+    #   @return [Float, nil]
+    optional :timeout, Float
+
+    # @!method initialize(values = {})
+    #   Returns a new instance of RequestOptions.
+    #
+    #   @param values [Hash{Symbol=>Object}]
+
+    define_sorbet_constant!(:OrHash) do
+      T.type_alias { T.any(SignwellSDK::RequestOptions, SignwellSDK::Internal::AnyHash) }
+    end
+  end
+end

data/lib/signwell_sdk/resources/v1/api_applications.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module SignwellSDK
+  module Resources
+    class V1
+      class APIApplications
+        # Gets the details of a specific API Application within an account. Supply the
+        # unique Application ID from either the Create API Application response or the API
+        # Application edit page.
+        #
+        # @overload retrieve(id, request_options: {})
+        #
+        # @param id [String] Unique identifier for the API Application.
+        #
+        # @param request_options [SignwellSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [nil]
+        #
+        # @see SignwellSDK::Models::V1::APIApplicationRetrieveParams
+        def retrieve(id, params = {})
+          @client.request(
+            method: :get,
+            path: ["api/v1/api_applications/%1$s", id],
+            model: NilClass,
+            options: params[:request_options]
+          )
+        end
+
+        # Deletes an API Application from an account. Supply the unique Application ID
+        # from either the Create API Application response or the API Application edit page
+        #
+        # @overload delete(id, request_options: {})
+        #
+        # @param id [String] Unique identifier for the API Application.
+        #
+        # @param request_options [SignwellSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [nil]
+        #
+        # @see SignwellSDK::Models::V1::APIApplicationDeleteParams
+        def delete(id, params = {})
+          @client.request(
+            method: :delete,
+            path: ["api/v1/api_applications/%1$s", id],
+            model: NilClass,
+            options: params[:request_options]
+          )
+        end
+
+        # @api private
+        #
+        # @param client [SignwellSDK::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end