signwell_sdk 0.0.1.pre.alpha.1

data/sig/signwell_sdk/models/v1/hook_create_params.rbs

@@ -0,0 +1,32 @@
+module SignwellSDK
+  module Models
+    module V1
+      type hook_create_params =
+        { callback_url: String, api_application_id: String }
+        & SignwellSDK::Internal::Type::request_parameters
+
+      class HookCreateParams < SignwellSDK::Internal::Type::BaseModel
+        extend SignwellSDK::Internal::Type::RequestParameters::Converter
+        include SignwellSDK::Internal::Type::RequestParameters
+
+        attr_accessor callback_url: String
+
+        attr_reader api_application_id: String?
+
+        def api_application_id=: (String) -> String
+
+        def initialize: (
+          callback_url: String,
+          ?api_application_id: String,
+          ?request_options: SignwellSDK::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          callback_url: String,
+          api_application_id: String,
+          request_options: SignwellSDK::RequestOptions
+        }
+      end
+    end
+  end
+end

data/sig/signwell_sdk/models/v1/hook_delete_params.rbs

@@ -0,0 +1,17 @@
+module SignwellSDK
+  module Models
+    module V1
+      type hook_delete_params =
+        {  } & SignwellSDK::Internal::Type::request_parameters
+
+      class HookDeleteParams < SignwellSDK::Internal::Type::BaseModel
+        extend SignwellSDK::Internal::Type::RequestParameters::Converter
+        include SignwellSDK::Internal::Type::RequestParameters
+
+        def initialize: (?request_options: SignwellSDK::request_opts) -> void
+
+        def to_hash: -> { request_options: SignwellSDK::RequestOptions }
+      end
+    end
+  end
+end

data/sig/signwell_sdk/models/v1/hook_list_params.rbs

@@ -0,0 +1,17 @@
+module SignwellSDK
+  module Models
+    module V1
+      type hook_list_params =
+        {  } & SignwellSDK::Internal::Type::request_parameters
+
+      class HookListParams < SignwellSDK::Internal::Type::BaseModel
+        extend SignwellSDK::Internal::Type::RequestParameters::Converter
+        include SignwellSDK::Internal::Type::RequestParameters
+
+        def initialize: (?request_options: SignwellSDK::request_opts) -> void
+
+        def to_hash: -> { request_options: SignwellSDK::RequestOptions }
+      end
+    end
+  end
+end

data/sig/signwell_sdk/models/v1/label.rbs

@@ -0,0 +1,15 @@
+module SignwellSDK
+  module Models
+    module V1
+      type label = { name: String }
+
+      class Label < SignwellSDK::Internal::Type::BaseModel
+        attr_accessor name: String
+
+        def initialize: (name: String) -> void
+
+        def to_hash: -> { name: String }
+      end
+    end
+  end
+end

data/sig/signwell_sdk/models/v1/template_checkbox_group.rbs

@@ -0,0 +1,69 @@
+module SignwellSDK
+  module Models
+    module V1
+      type template_checkbox_group =
+        {
+          checkbox_ids: ::Array[String],
+          group_name: String,
+          placeholder_id: String,
+          exact_value: Integer,
+          max_value: Integer,
+          min_value: Integer,
+          required: bool,
+          validation: SignwellSDK::Models::checkbox_validation
+        }
+
+      class TemplateCheckboxGroup < SignwellSDK::Internal::Type::BaseModel
+        attr_accessor checkbox_ids: ::Array[String]
+
+        attr_accessor group_name: String
+
+        attr_accessor placeholder_id: String
+
+        attr_reader exact_value: Integer?
+
+        def exact_value=: (Integer) -> Integer
+
+        attr_reader max_value: Integer?
+
+        def max_value=: (Integer) -> Integer
+
+        attr_reader min_value: Integer?
+
+        def min_value=: (Integer) -> Integer
+
+        attr_reader required: bool?
+
+        def required=: (bool) -> bool
+
+        attr_reader validation: SignwellSDK::Models::checkbox_validation?
+
+        def validation=: (
+          SignwellSDK::Models::checkbox_validation
+        ) -> SignwellSDK::Models::checkbox_validation
+
+        def initialize: (
+          checkbox_ids: ::Array[String],
+          group_name: String,
+          placeholder_id: String,
+          ?exact_value: Integer,
+          ?max_value: Integer,
+          ?min_value: Integer,
+          ?required: bool,
+          ?validation: SignwellSDK::Models::checkbox_validation
+        ) -> void
+
+        def to_hash: -> {
+          checkbox_ids: ::Array[String],
+          group_name: String,
+          placeholder_id: String,
+          exact_value: Integer,
+          max_value: Integer,
+          min_value: Integer,
+          required: bool,
+          validation: SignwellSDK::Models::checkbox_validation
+        }
+      end
+    end
+  end
+end

data/sig/signwell_sdk/models/v1_me_params.rbs

@@ -0,0 +1,14 @@
+module SignwellSDK
+  module Models
+    type v1_me_params = {  } & SignwellSDK::Internal::Type::request_parameters
+
+    class V1MeParams < SignwellSDK::Internal::Type::BaseModel
+      extend SignwellSDK::Internal::Type::RequestParameters::Converter
+      include SignwellSDK::Internal::Type::RequestParameters
+
+      def initialize: (?request_options: SignwellSDK::request_opts) -> void
+
+      def to_hash: -> { request_options: SignwellSDK::RequestOptions }
+    end
+  end
+end

data/sig/signwell_sdk/models.rbs

@@ -0,0 +1,23 @@
+module SignwellSDK
+  class AttachmentRequestInfo = SignwellSDK::Models::AttachmentRequestInfo
+
+  class CheckboxGroupInfo = SignwellSDK::Models::CheckboxGroupInfo
+
+  module CheckboxValidation = SignwellSDK::Models::CheckboxValidation
+
+  class CopiedContactInfo = SignwellSDK::Models::CopiedContactInfo
+
+  module DateFormat = SignwellSDK::Models::DateFormat
+
+  module FieldType = SignwellSDK::Models::FieldType
+
+  class FileInfo = SignwellSDK::Models::FileInfo
+
+  class LabelInfo = SignwellSDK::Models::LabelInfo
+
+  module TextValidation = SignwellSDK::Models::TextValidation
+
+  module V1 = SignwellSDK::Models::V1
+
+  class V1MeParams = SignwellSDK::Models::V1MeParams
+end

data/sig/signwell_sdk/request_options.rbs

@@ -0,0 +1,36 @@
+module SignwellSDK
+  type request_opts =
+    SignwellSDK::RequestOptions
+    | SignwellSDK::request_options
+    | ::Hash[Symbol, top]
+
+  type request_options =
+    {
+      idempotency_key: String?,
+      extra_query: ::Hash[String, (::Array[String] | String)?]?,
+      extra_headers: ::Hash[String, String?]?,
+      extra_body: top?,
+      max_retries: Integer?,
+      timeout: Float?
+    }
+
+  class RequestOptions < SignwellSDK::Internal::Type::BaseModel
+    def self.validate!: (SignwellSDK::request_opts opts) -> void
+
+    attr_accessor idempotency_key: String?
+
+    attr_accessor extra_query: ::Hash[String, (::Array[String] | String)?]?
+
+    attr_accessor extra_headers: ::Hash[String, String?]?
+
+    attr_accessor extra_body: top?
+
+    attr_accessor max_retries: Integer?
+
+    attr_accessor timeout: Float?
+
+    def initialize: (
+      ?SignwellSDK::request_options | ::Hash[Symbol, top] values
+    ) -> void
+  end
+end

data/sig/signwell_sdk/resources/v1/api_applications.rbs

@@ -0,0 +1,19 @@
+module SignwellSDK
+  module Resources
+    class V1
+      class APIApplications
+        def retrieve: (
+          String id,
+          ?request_options: SignwellSDK::request_opts
+        ) -> nil
+
+        def delete: (
+          String id,
+          ?request_options: SignwellSDK::request_opts
+        ) -> nil
+
+        def initialize: (client: SignwellSDK::Client) -> void
+      end
+    end
+  end
+end

data/sig/signwell_sdk/resources/v1/bulk_sends.rbs

@@ -0,0 +1,55 @@
+module SignwellSDK
+  module Resources
+    class V1
+      class BulkSends
+        def create: (
+          bulk_send_csv: String,
+          template_ids: ::Array[String],
+          ?api_application_id: String,
+          ?apply_signing_order: bool,
+          ?custom_requester_email: String,
+          ?custom_requester_name: String,
+          ?message: String,
+          ?name: String,
+          ?skip_row_errors: bool,
+          ?subject: String,
+          ?request_options: SignwellSDK::request_opts
+        ) -> nil
+
+        def retrieve: (
+          String id,
+          ?request_options: SignwellSDK::request_opts
+        ) -> nil
+
+        def list: (
+          ?api_application_id: String,
+          ?limit: Integer,
+          ?page: Integer,
+          ?user_email: String,
+          ?request_options: SignwellSDK::request_opts
+        ) -> nil
+
+        def retrieve_csv_template: (
+          template_ids: ::Array[String],
+          ?base64: String,
+          ?request_options: SignwellSDK::request_opts
+        ) -> StringIO
+
+        def retrieve_documents: (
+          String id,
+          ?limit: Integer,
+          ?page: Integer,
+          ?request_options: SignwellSDK::request_opts
+        ) -> nil
+
+        def validate_csv: (
+          bulk_send_csv: String,
+          template_ids: ::Array[String],
+          ?request_options: SignwellSDK::request_opts
+        ) -> nil
+
+        def initialize: (client: SignwellSDK::Client) -> void
+      end
+    end
+  end
+end

data/sig/signwell_sdk/resources/v1/document_templates.rbs

@@ -0,0 +1,71 @@
+module SignwellSDK
+  module Resources
+    class V1
+      class DocumentTemplates
+        def create: (
+          files: ::Array[SignwellSDK::V1::DocumentFile],
+          placeholders: ::Array[SignwellSDK::V1::DocumentTemplateCreateParams::Placeholder],
+          ?allow_decline: bool,
+          ?allow_reassign: bool,
+          ?api_application_id: String,
+          ?apply_signing_order: bool,
+          ?attachment_requests: ::Array[SignwellSDK::V1::DocumentTemplateCreateParams::AttachmentRequest],
+          ?checkbox_groups: ::Array[SignwellSDK::V1::TemplateCheckboxGroup],
+          ?copied_placeholders: ::Array[SignwellSDK::V1::DocumentTemplateCreateParams::CopiedPlaceholder],
+          ?decline_redirect_url: String,
+          ?draft: bool,
+          ?expires_in: Integer,
+          ?fields: ::Array[::Array[SignwellSDK::V1::DocumentTemplateCreateParams::Field]],
+          ?labels: ::Array[SignwellSDK::V1::Label],
+          ?language: String,
+          ?message: String,
+          ?metadata: ::Hash[Symbol, String],
+          ?name: String,
+          ?redirect_url: String,
+          ?reminders: bool,
+          ?subject: String,
+          ?text_tags: bool,
+          ?request_options: SignwellSDK::request_opts
+        ) -> SignwellSDK::V1::DocumentTemplate
+
+        def retrieve: (
+          String id,
+          ?request_options: SignwellSDK::request_opts
+        ) -> SignwellSDK::V1::DocumentTemplate
+
+        def update: (
+          String id,
+          ?allow_decline: bool,
+          ?allow_reassign: bool,
+          ?api_application_id: String,
+          ?apply_signing_order: bool,
+          ?checkbox_groups: ::Array[SignwellSDK::V1::TemplateCheckboxGroup],
+          ?decline_redirect_url: String,
+          ?draft: bool,
+          ?expires_in: Integer,
+          ?labels: ::Array[SignwellSDK::V1::Label],
+          ?message: String,
+          ?metadata: ::Hash[Symbol, String],
+          ?name: String,
+          ?redirect_url: String,
+          ?reminders: bool,
+          ?subject: String,
+          ?request_options: SignwellSDK::request_opts
+        ) -> SignwellSDK::V1::DocumentTemplate
+
+        def list: (
+          ?limit: Integer,
+          ?page: Integer,
+          ?request_options: SignwellSDK::request_opts
+        ) -> SignwellSDK::Models::V1::DocumentTemplateListResponse
+
+        def delete: (
+          String id,
+          ?request_options: SignwellSDK::request_opts
+        ) -> nil
+
+        def initialize: (client: SignwellSDK::Client) -> void
+      end
+    end
+  end
+end

data/sig/signwell_sdk/resources/v1/documents.rbs

@@ -0,0 +1,130 @@
+module SignwellSDK
+  module Resources
+    class V1
+      class Documents
+        def create: (
+          files: ::Array[SignwellSDK::V1::DocumentFile],
+          recipients: ::Array[SignwellSDK::V1::DocumentCreateParams::Recipient],
+          ?allow_decline: bool,
+          ?allow_reassign: bool,
+          ?api_application_id: String,
+          ?apply_signing_order: bool,
+          ?attachment_requests: ::Array[SignwellSDK::V1::AttachmentRequest],
+          ?checkbox_groups: ::Array[SignwellSDK::V1::CheckboxGroup],
+          ?copied_contacts: ::Array[SignwellSDK::V1::CopiedContact],
+          ?custom_requester_email: String,
+          ?custom_requester_name: String,
+          ?decline_redirect_url: String,
+          ?draft: bool,
+          ?embedded_signing: bool,
+          ?embedded_signing_notifications: bool,
+          ?expires_in: Integer,
+          ?fields: ::Array[::Array[SignwellSDK::V1::DocumentCreateParams::Field]],
+          ?labels: ::Array[SignwellSDK::V1::Label],
+          ?language: String,
+          ?message: String,
+          ?metadata: ::Hash[Symbol, String],
+          ?name: String,
+          ?redirect_url: String,
+          ?reminders: bool,
+          ?subject: String,
+          ?test_mode: bool,
+          ?text_tags: bool,
+          ?with_signature_page: bool,
+          ?request_options: SignwellSDK::request_opts
+        ) -> SignwellSDK::V1::Document
+
+        def retrieve: (
+          String id,
+          ?request_options: SignwellSDK::request_opts
+        ) -> SignwellSDK::V1::Document
+
+        def list: (
+          ?limit: Integer,
+          ?page: Integer,
+          ?request_options: SignwellSDK::request_opts
+        ) -> SignwellSDK::Models::V1::DocumentListResponse
+
+        def delete: (
+          String id,
+          ?request_options: SignwellSDK::request_opts
+        ) -> nil
+
+        def create_from_template: (
+          recipients: ::Array[SignwellSDK::V1::DocumentCreateFromTemplateParams::Recipient],
+          ?allow_decline: bool,
+          ?allow_reassign: bool,
+          ?api_application_id: String,
+          ?apply_signing_order: bool,
+          ?attachment_requests: ::Array[SignwellSDK::V1::AttachmentRequest],
+          ?checkbox_groups: ::Array[SignwellSDK::V1::CheckboxGroup],
+          ?copied_contacts: ::Array[SignwellSDK::V1::CopiedContact],
+          ?custom_requester_email: String,
+          ?custom_requester_name: String,
+          ?decline_redirect_url: String,
+          ?draft: bool,
+          ?embedded_signing: bool,
+          ?embedded_signing_notifications: bool,
+          ?expires_in: Integer,
+          ?fields: ::Array[::Array[SignwellSDK::V1::DocumentCreateFromTemplateParams::Field]],
+          ?files: ::Array[SignwellSDK::V1::DocumentCreateFromTemplateParams::File],
+          ?labels: ::Array[SignwellSDK::V1::Label],
+          ?language: String,
+          ?message: String,
+          ?metadata: ::Hash[Symbol, String],
+          ?name: String,
+          ?redirect_url: String,
+          ?reminders: bool,
+          ?subject: String,
+          ?template_fields: ::Array[SignwellSDK::V1::DocumentCreateFromTemplateParams::TemplateField],
+          ?template_id: String,
+          ?template_ids: ::Array[String],
+          ?test_mode: bool,
+          ?text_tags: bool,
+          ?with_signature_page: bool,
+          ?request_options: SignwellSDK::request_opts
+        ) -> SignwellSDK::Models::V1::DocumentCreateFromTemplateResponse
+
+        def remind: (
+          String id,
+          ?recipients: ::Array[SignwellSDK::V1::DocumentRemindParams::Recipient],
+          ?request_options: SignwellSDK::request_opts
+        ) -> nil
+
+        def retrieve_completed_pdf: (
+          String id,
+          ?audit_page: bool,
+          ?file_format: SignwellSDK::Models::V1::DocumentRetrieveCompletedPdfParams::file_format,
+          ?url_only: bool,
+          ?request_options: SignwellSDK::request_opts
+        ) -> SignwellSDK::Models::V1::DocumentRetrieveCompletedPdfResponse
+
+        def send_: (
+          String id,
+          ?allow_decline: bool,
+          ?allow_reassign: bool,
+          ?api_application_id: String,
+          ?apply_signing_order: bool,
+          ?checkbox_groups: ::Array[SignwellSDK::V1::CheckboxGroup],
+          ?custom_requester_email: String,
+          ?custom_requester_name: String,
+          ?decline_redirect_url: String,
+          ?embedded_signing: bool,
+          ?embedded_signing_notifications: bool,
+          ?expires_in: Integer,
+          ?labels: ::Array[SignwellSDK::V1::Label],
+          ?message: String,
+          ?metadata: ::Hash[Symbol, String],
+          ?name: String,
+          ?redirect_url: String,
+          ?reminders: bool,
+          ?subject: String,
+          ?test_mode: bool,
+          ?request_options: SignwellSDK::request_opts
+        ) -> SignwellSDK::V1::Document
+
+        def initialize: (client: SignwellSDK::Client) -> void
+      end
+    end
+  end
+end

data/sig/signwell_sdk/resources/v1/hooks.rbs

@@ -0,0 +1,22 @@
+module SignwellSDK
+  module Resources
+    class V1
+      class Hooks
+        def create: (
+          callback_url: String,
+          ?api_application_id: String,
+          ?request_options: SignwellSDK::request_opts
+        ) -> nil
+
+        def list: (?request_options: SignwellSDK::request_opts) -> nil
+
+        def delete: (
+          String id,
+          ?request_options: SignwellSDK::request_opts
+        ) -> nil
+
+        def initialize: (client: SignwellSDK::Client) -> void
+      end
+    end
+  end
+end

data/sig/signwell_sdk/resources/v1.rbs

@@ -0,0 +1,19 @@
+module SignwellSDK
+  module Resources
+    class V1
+      attr_reader documents: SignwellSDK::Resources::V1::Documents
+
+      attr_reader document_templates: SignwellSDK::Resources::V1::DocumentTemplates
+
+      attr_reader api_applications: SignwellSDK::Resources::V1::APIApplications
+
+      attr_reader hooks: SignwellSDK::Resources::V1::Hooks
+
+      attr_reader bulk_sends: SignwellSDK::Resources::V1::BulkSends
+
+      def me: (?request_options: SignwellSDK::request_opts) -> nil
+
+      def initialize: (client: SignwellSDK::Client) -> void
+    end
+  end
+end

data/sig/signwell_sdk/version.rbs

@@ -0,0 +1,3 @@
+module SignwellSDK
+  VERSION: String
+end