unisender-ruby 0.1.1 → 0.2.0

data/sig/operations.rbs

@@ -1,78 +1,82 @@
 module Unisender
   type id = String | Integer
   type flag = bool | 0 | 1
-  type list = { "id" => id, "title" => String }
-  type list_created = { "id" => id }
-  type subscription = { "person_id" => id }
-  type message_created = { "message_id" => id }
-  type campaign_created = { "campaign_id" => id, "status" => String }
-  type task_created = { "task_uuid" => String }
-  type task_completed = { "status" => String, "file_to_download" => String }
+  type contact_type = :email | :phone | "email" | "phone"
+  type template_type = :user | :system | "user" | "system"
+  type note_order = :asc | :desc | "ASC" | "DESC" | "asc" | "desc"
+  type note_field = :created_at | :updated_at | :pinned_at | "created_at" | "updated_at" | "pinned_at"
+  type list = List
+  type list_created = IdentifierRecord
+  type subscription = Subscription
+  type message_created = MessageCreated
+  type campaign_created = CampaignCreated
+  type task_created = TaskResult
+  type task_completed = TaskResult
 
-  type object = Hash[String, json]
-  type objects = Array[object]
-  type contact_count = { "count" => String }
-  type total_contacts = { "total" => Integer }
-  type delivery_status = { "status" => String }
-  type message_version = { "message_id" => id, "actual_version_id" => id }
-  type note = { "id" => id, "content" => String }
-  type event_accepted = { "success" => true }
+  type object = Record
+  type objects = Array[Record]
+  type contact_count = ContactCount
+  type total_contacts = TotalContacts
+  type delivery_status = Status
+  type message_version = MessageVersion
+  type note = Note
+  type event_accepted = Record
 
   class Client
-    def create_list: (title: String, ?before_subscribe_url: String | nil, ?after_subscribe_url: String | nil, ?sub_user_rights: params | nil) -> Response[list_created]
-    def delete_list: (list_id: id) -> Response[object | objects]
-    def exclude: (contact_type: String, contact: String, ?list_ids: String | Array[id] | nil) -> Response[object | objects]
-    def export_contacts: (?notify_url: String | nil, ?list_id: id | nil, ?field_names: Array[String] | nil, ?email: String | nil, ?phone: String | nil, ?tag: String | nil, ?email_status: String | nil, ?phone_status: String | nil, ?contact_status: String | nil) -> Response[task_created]
-    def get_contact_count: (list_id: id, params: params) -> Response[contact_count]
-    def get_lists: () -> Response[Array[list]]
-    def get_total_contacts_count: (login: String) -> Response[total_contacts]
-    def import_contacts: (field_names: Array[String], data: Array[Array[parameter]], ?overwrite_tags: flag | nil, ?overwrite_lists: flag | nil, ?telegram_bot_channel_id: String | nil) -> Response[object]
-    def subscribe: (list_ids: String | Array[id], fields: params, ?tags: String | Array[id] | nil, ?double_optin: Integer | nil, ?overwrite: Integer | nil) -> Response[subscription]
-    def update_list: (list_id: id, title: String, ?before_subscribe_url: String | nil, ?after_subscribe_url: String | nil, ?sub_user_rights: params | nil) -> Response[object | objects]
+    def create_list: (title: String, ?before_subscribe_url: String | nil, ?after_subscribe_url: String | nil, ?sub_user_rights: params | nil) -> IdentifierRecordResponse
+    def delete_list: (list_id: id) -> ObjectResponse[Record]
+    def exclude: (?contact_type: contact_type?, ?contact: String?, ?email: String?, ?phone: String?, ?list_ids: String | Array[id] | nil) -> ObjectResponse[Record]
+    def export_contacts: (?notify_url: String | nil, ?list_id: id | nil, ?field_names: Array[String] | nil, ?email: String | nil, ?phone: String | nil, ?tag: String | nil, ?email_status: String | nil, ?phone_status: String | nil, ?contact_status: String | nil) -> TaskResponse
+    def get_contact_count: (list_id: id, ?params: params?, ?tag_id: id?, ?contact_type: contact_type | "address" | nil, ?search: String?) -> ContactCountResponse
+    def get_lists: () -> CollectionResponse[List]
+    def get_total_contacts_count: (login: String) -> TotalContactsResponse
+    def import_contacts: (?field_names: Array[String]?, ?data: Array[Array[parameter]]?, ?records: Enumerable[params]?, ?overwrite_tags: flag | nil, ?overwrite_lists: flag | nil, ?telegram_bot_channel_id: String | nil) -> ImportResponse
+    def subscribe: (list_ids: String | Array[id], ?fields: params?, ?email: String?, ?tags: String | Array[id] | nil, ?double_optin: Integer | :request_confirmation | :already_confirmed | :confirm_if_needed | nil, ?overwrite: Integer | :preserve | :replace | :update | nil) -> SubscriptionResponse
+    def update_list: (list_id: id, title: String, ?before_subscribe_url: String | nil, ?after_subscribe_url: String | nil, ?sub_user_rights: params | nil) -> ObjectResponse[Record]
     def is_contact_in_lists: (email: String, list_ids: String | Array[id], condition: String) -> Response[bool]
-    def get_contact: (email: String, ?include_lists: flag | nil, ?include_fields: flag | nil, ?include_details: flag | nil) -> Response[object]
-    def unsubscribe: (contact_type: String, contact: String, ?list_ids: String | Array[id] | nil) -> Response[object | objects]
-    def cancel_campaign: (campaign_id: id) -> Response[objects]
-    def check_email: (email_id: String | Array[id]) -> Response[objects]
-    def check_sms: (sms_id: id) -> Response[delivery_status]
-    def create_campaign: (message_id: id, ?start_time: String | nil, ?timezone: String | nil, ?track_read: flag | nil, ?track_links: flag | nil, ?contacts: String | Array[id] | nil, ?contacts_url: String | nil, ?track_ga: flag | nil, ?payment_limit: Integer | Float | nil, ?payment_currency: String | nil, ?ga_medium: String | nil, ?ga_source: String | nil, ?ga_campaign: String | nil, ?ga_content: String | nil, ?ga_term: String | nil) -> Response[campaign_created]
-    def create_email_message: (sender_name: String, sender_email: String, list_id: id, ?subject: String | nil, ?body: String | nil, ?text_body: String | nil, ?generate_text: flag | nil, ?tag: String | nil, ?attachments: Hash[String, String] | nil, ?lang: String | nil, ?template_id: id | nil, ?system_template_id: id | nil, ?wrap_type: String | nil, ?categories: String | Array[id] | nil) -> Response[message_created]
-    def create_sms_message: (sender: String, body: String, list_id: id, ?tag: String | nil) -> Response[message_created]
-    def delete_message: (message_id: id) -> Response[object | objects]
-    def get_actual_message_version: (message_id: id) -> Response[message_version]
-    def get_web_version: (campaign_id: id) -> Response[object]
-    def send_email: (email: String, sender_name: String, sender_email: String, subject: String, body: String, list_id: id, ?attachments: Hash[String, String] | nil, ?lang: String | nil, ?track_read: flag | nil, ?track_links: flag | nil, ?cc: String | nil, ?headers: String | params | nil, ?images_as: String | nil, ?ref_key: String | nil, ?error_checking: flag | nil, ?metadata: params | nil) -> Response[object | objects]
-    def send_sms: (phone: String, sender: String, text: String) -> Response[object]
-    def send_test_email: (email: String | Array[id], id: id) -> Response[object | objects]
-    def update_email_message: (id: id, ?sender_name: String | nil, ?sender_email: String | nil, ?subject: String | nil, ?body: String | nil, ?list_id: id | nil, ?text_body: String | nil, ?lang: String | nil, ?categories: String | Array[id] | nil) -> Response[message_created]
-    def update_opt_in_email: (sender_name: String, sender_email: String, subject: String, body: String, list_id: id) -> Response[object | objects]
-    def get_sender_domain_list: (username: String, ?domain: String | nil, ?limit: Integer | nil, ?offset: Integer | nil) -> Response[objects]
-    def get_campaign_common_stats: (campaign_id: id) -> Response[object]
-    def get_campaign_delivery_stats: (campaign_id: id, ?notify_url: String | nil, ?changed_since: String | nil, ?field_ids: Array[id] | nil) -> Response[task_created]
-    def get_campaign_status: (campaign_id: id) -> Response[delivery_status]
-    def get_messages: (date_from: String, date_to: String, ?limit: Integer | nil, ?offset: Integer | nil) -> Response[objects]
-    def get_visited_links: (campaign_id: id, ?group: flag | nil) -> Response[object]
-    def list_messages: (date_from: String, date_to: String, ?limit: Integer | nil, ?offset: Integer | nil) -> Response[objects]
-    def get_campaigns: (from: String, ?to: String | nil, ?limit: Integer | nil, ?offset: Integer | nil) -> Response[objects]
-    def get_message: (id: id) -> Response[objects]
-    def get_task_result: (task_uuid: String) -> Response[object]
-    def create_email_template: (title: String, subject: String, body: String, ?description: String | nil, ?text_body: String | nil, ?lang: String | nil) -> Response[list_created]
-    def delete_template: (template_id: id) -> Response[object | objects]
-    def get_template: (?template_id: id | nil, ?system_template_id: id | nil) -> Response[object]
-    def get_templates: (?type: String | nil, ?date_from: String | nil, ?date_to: String | nil, ?limit: Integer | nil, ?offset: Integer | nil) -> Response[objects]
-    def list_templates: (?type: String | nil, ?date_from: String | nil, ?date_to: String | nil, ?limit: Integer | nil, ?offset: Integer | nil) -> Response[objects]
-    def update_email_template: (template_id: id, ?title: String | nil, ?description: String | nil, ?subject: String | nil, ?body: String | nil, ?text_body: String | nil, ?lang: String | nil) -> Response[list_created]
-    def create_field: (name: String, type: String, ?public_name: String | nil) -> Response[list_created]
-    def delete_field: (id: id) -> Response[object | objects]
-    def delete_tag: (id: id) -> Response[object | objects]
-    def get_fields: () -> Response[objects]
-    def get_tags: () -> Response[objects]
-    def update_field: (id: id, name: String, ?public_name: String | nil) -> Response[object | objects]
-    def get_contact_field_values: (email: String, field_ids: String | Array[id]) -> Response[object]
-    def create_subscriber_note: (subscriber_id: id, content: String) -> Response[list_created]
-    def update_subscriber_note: (id: id, content: String) -> Response[list_created]
-    def delete_subscriber_note: (id: id) -> Response[object | objects]
-    def get_subscriber_note: (id: id) -> Response[note]
-    def get_subscriber_notes: (subscriber_id: id, ?limit: Integer | nil, ?offset: Integer | nil, ?order_type: String | nil, ?order_by: String | nil, ?is_pinned: flag | nil) -> Response[objects]
+    def get_contact: (email: String, ?include_lists: flag | nil, ?include_fields: flag | nil, ?include_details: flag | nil) -> ContactResponse
+    def unsubscribe: (?contact_type: contact_type?, ?contact: String?, ?email: String?, ?phone: String?, ?list_ids: String | Array[id] | nil) -> ObjectResponse[Record]
+    def cancel_campaign: (campaign_id: id) -> ObjectResponse[Record]
+    def check_email: (email_id: String | Array[id]) -> CollectionResponse[EmailDelivery]
+    def check_sms: (sms_id: id) -> StatusResponse
+    def create_campaign: (message_id: id, ?start_time: String | Time | nil, ?timezone: String | nil, ?track_read: flag | nil, ?track_links: flag | nil, ?contacts: String | Array[id] | nil, ?contacts_url: String | nil, ?track_ga: flag | nil, ?payment_limit: Integer | Float | nil, ?payment_currency: String | nil, ?ga_medium: String | nil, ?ga_source: String | nil, ?ga_campaign: String | nil, ?ga_content: String | nil, ?ga_term: String | nil) -> CampaignCreatedResponse
+    def create_email_message: (?sender_name: String?, ?sender_email: String?, list_id: id, ?subject: String | nil, ?body: String | nil, ?text_body: String | nil, ?generate_text: flag | nil, ?tag: String | nil, ?attachments: Hash[String, String] | Attachment | Array[Attachment] | nil, ?lang: String | nil, ?template_id: id | nil, ?system_template_id: id | nil, ?wrap_type: String | nil, ?categories: String | Array[id] | nil) -> MessageCreatedResponse
+    def create_sms_message: (sender: String, body: String, list_id: id, ?tag: String | nil) -> MessageCreatedResponse
+    def delete_message: (message_id: id) -> ObjectResponse[Record]
+    def get_actual_message_version: (message_id: id) -> MessageVersionResponse
+    def get_web_version: (campaign_id: id) -> WebVersionResponse
+    def send_email: (email: String, ?sender_name: String?, ?sender_email: String?, subject: String, body: String, list_id: id, ?attachments: Hash[String, String] | Attachment | Array[Attachment] | nil, ?lang: String | nil, ?track_read: flag | nil, ?track_links: flag | nil, ?cc: String | nil, ?headers: String | params | nil, ?images_as: String | Symbol | nil, ?ref_key: String | nil, ?error_checking: flag | nil, ?metadata: params | nil, ?reply_to: String | nil, ?priority: String | nil) -> SendResponse
+    def send_sms: (phone: String | Array[String], sender: String, text: String) -> CollectionResponse[SmsReceipt]
+    def send_test_email: (email: String | Array[id], id: id) -> MessageNoticeResponse
+    def update_email_message: (id: id, ?sender_name: String | nil, ?sender_email: String | nil, ?subject: String | nil, ?body: String | nil, ?list_id: id | nil, ?text_body: String | nil, ?lang: String | nil, ?categories: String | Array[id] | nil) -> MessageCreatedResponse
+    def update_opt_in_email: (sender_name: String, sender_email: String, subject: String, body: String, list_id: id) -> ObjectResponse[Record]
+    def get_sender_domain_list: (username: String, ?domain: String | nil, ?limit: Integer | nil, ?offset: Integer | nil) -> PageResponse[SenderDomainGroup]
+    def get_campaign_common_stats: (campaign_id: id) -> CampaignStatsResponse
+    def get_campaign_delivery_stats: (campaign_id: id, ?notify_url: String | nil, ?changed_since: String | Time | nil, ?field_ids: Array[id] | nil) -> TaskResponse
+    def get_campaign_status: (campaign_id: id) -> StatusResponse
+    def get_messages: (date_from: String | Time, date_to: String | Time, ?limit: Integer | nil, ?offset: Integer | nil) -> PageResponse[Message]
+    def get_visited_links: (campaign_id: id, ?group: flag | nil) -> CollectionResponse[Record]
+    def list_messages: (date_from: String | Time, date_to: String | Time, ?limit: Integer | nil, ?offset: Integer | nil) -> PageResponse[Message]
+    def get_campaigns: (from: String | Time, ?to: String | Time | nil, ?limit: Integer | nil, ?offset: Integer | nil) -> PageResponse[Campaign]
+    def get_message: (id: id) -> MessageResponse
+    def get_task_result: (task_uuid: String) -> TaskResponse
+    def create_email_template: (title: String, subject: String, body: String, ?description: String | nil, ?text_body: String | nil, ?lang: String | nil) -> IdentifierRecordResponse
+    def delete_template: (template_id: id) -> ObjectResponse[Record]
+    def get_template: (?template_id: id | nil, ?system_template_id: id | nil) -> TemplateResponse
+    def get_templates: (?type: template_type | nil, ?date_from: String | Time | nil, ?date_to: String | Time | nil, ?limit: Integer | nil, ?offset: Integer | nil) -> PageResponse[Template]
+    def list_templates: (?type: template_type | nil, ?date_from: String | Time | nil, ?date_to: String | Time | nil, ?limit: Integer | nil, ?offset: Integer | nil) -> PageResponse[Template]
+    def update_email_template: (template_id: id, ?title: String | nil, ?description: String | nil, ?subject: String | nil, ?body: String | nil, ?text_body: String | nil, ?lang: String | nil) -> IdentifierRecordResponse
+    def create_field: (name: String, type: String, ?public_name: String | nil) -> IdentifierRecordResponse
+    def delete_field: (id: id) -> ObjectResponse[Record]
+    def delete_tag: (id: id) -> ObjectResponse[Record]
+    def get_fields: () -> CollectionResponse[Field]
+    def get_tags: () -> CollectionResponse[Tag]
+    def update_field: (id: id, name: String, ?public_name: String | nil) -> OptionalIdentifierResponse
+    def get_contact_field_values: (email: String, field_ids: String | Array[id]) -> ContactFieldsResponse
+    def create_subscriber_note: (subscriber_id: id, content: String) -> IdentifierRecordResponse
+    def update_subscriber_note: (id: id, content: String) -> IdentifierRecordResponse
+    def delete_subscriber_note: (id: id) -> ObjectResponse[Record]
+    def get_subscriber_note: (id: id) -> NoteResponse
+    def get_subscriber_notes: (subscriber_id: id, ?limit: Integer | nil, ?offset: Integer | nil, ?order_type: note_order | nil, ?order_by: note_field | nil, ?is_pinned: flag | nil) -> PageResponse[Note]
   end
 end

data/sig/outcomes.rbs

@@ -0,0 +1,90 @@
+module Unisender
+  module Outcomes
+    def self.records: (value, String) -> Array[Record]
+    def self.record: (value, String) -> Record
+    def self.failures: (value, String, ?Hash[String, json]) -> Array[Failure]
+    def self.failure: (Record, String, Hash[String, json]) -> Failure
+  end
+  class Failure < Record
+    def index: () -> Integer?
+    def code: () -> String?
+    def message: () -> String?
+    def warning?: () -> bool
+    def with_offset: (Integer) -> Failure
+    def normalize: () -> void
+  end
+  interface _Outcome
+    def complete?: () -> bool
+    def partial?: () -> bool
+    def uncertain?: () -> bool
+    def failures: () -> Array[Failure]
+  end
+  class ImportResult < Record
+    def row_warnings: () -> Array[Failure]
+    OPTIONAL_COUNTERS: Array[String]
+    def inserted: () -> Integer?
+    def updated: () -> Integer?
+    def deleted: () -> Integer?
+    def new_emails: () -> Integer?
+    def total: () -> Integer?
+    def invalid: () -> Integer
+    def complete?: () -> bool
+    def partial?: () -> bool
+    def uncertain?: () -> bool
+    def failures: () -> Array[Failure]
+    def normalize: () -> void
+  end
+  class RecipientResult < Record
+    def id: () -> id?
+    def index: () -> Integer?
+    def email: () -> String?
+    def failures: () -> Array[Failure]
+    def accepted?: () -> bool
+    def normalize: () -> void
+  end
+  class SendResult < Record
+    def accepted_recipients: () -> Array[RecipientResult]
+    def rejected_recipients: () -> Array[RecipientResult]
+    def unknown_recipients: () -> Array[RecipientResult]
+    def accepted_ids: () -> Array[id]
+    def recipients: () -> Array[RecipientResult]
+    def email_id: () -> id?
+    def complete?: () -> bool
+    def partial?: () -> bool
+    def uncertain?: () -> bool
+    def failures: () -> Array[Failure]
+    def normalize: () -> void
+  end
+  class EventResult < Record
+    def complete?: () -> bool
+    def partial?: () -> bool
+    def uncertain?: () -> bool
+    def failures: () -> Array[Failure]
+  end
+  class OutcomeResponse[out Result < (Record & _Outcome) = ImportResult] < ObjectResponse[Result]
+    def complete?: () -> bool
+    def partial?: () -> bool
+    def uncertain?: () -> bool
+    def failures: () -> Array[Failure]
+    def raise_for_partial_failure!: () -> self
+  end
+  class ImportResponse < OutcomeResponse[ImportResult]
+    def row_warnings: () -> Array[Failure]
+    def inserted: () -> Integer?
+    def updated: () -> Integer?
+    def deleted: () -> Integer?
+    def new_emails: () -> Integer?
+    def total: () -> Integer?
+    def invalid: () -> Integer
+  end
+  class SendResponse < OutcomeResponse[SendResult]
+    def accepted_recipients: () -> Array[RecipientResult]
+    def rejected_recipients: () -> Array[RecipientResult]
+    def unknown_recipients: () -> Array[RecipientResult]
+    def accepted_ids: () -> Array[id]
+    def recipients: () -> Array[RecipientResult]
+    def email_id: () -> id?
+  end
+  class EventResponse < OutcomeResponse[EventResult]
+  end
+end

data/sig/record.rbs

@@ -0,0 +1,77 @@
+module Unisender
+  class Record
+    @values: Hash[String, value]
+    def initialize: (Hash[String, json]) -> void
+    def self.decode: (json) -> value
+    def []: (String | Symbol) -> value
+    def fetch: [Fallback] (String | Symbol, *Fallback) ?{ (String | Symbol) -> Fallback } -> (value | Fallback)
+    def key?: (String | Symbol) -> bool
+    def keys: () -> Array[String]
+    def values: () -> Array[value]
+    def dig: (String | Symbol, *(String | Integer)) -> value
+    def to_h: () -> Hash[String, json]
+    alias to_hash to_h
+    def as_json: (?serialization_options?) -> Hash[String, json]
+    def to_json: (?(serialization_options | JSON::State)?) -> String
+    def self.copy: (value) -> json
+    def ==: (BasicObject) -> bool
+    def eql?: (BasicObject) -> bool
+    def hash: () -> Integer
+    def inspect: () -> String
+    def normalize: () -> void
+    def child: (singleton(EmailContact), Hash[String, json], String) -> EmailContact
+             | (singleton(PhoneContact), Hash[String, json], String) -> PhoneContact
+             | (singleton(ContactList), Hash[String, json], String) -> ContactList
+             | (singleton(SenderDomain), Hash[String, json], String) -> SenderDomain
+             | (singleton(RecipientResult), Hash[String, json], String) -> RecipientResult
+    def text: (String) -> String?
+    def text!: (String) -> String
+    def identifier!: (String) -> id
+    def integer!: (String) -> Integer
+    def integer: (String) -> Integer?
+    def number: (String) -> (Integer | Float)?
+    def invalid!: (String, ?expected_type: String) -> bot
+  end
+
+  class CollectionResponse[out Item = Record] < Response[Array[Item]]
+    include Enumerable[Item]
+    def each: () -> Enumerator[Item, Array[Item]]
+            | () { (Item) -> void } -> Array[Item]
+    def []: (Integer) -> Item?
+          | (Range[Integer]) -> Array[Item]?
+          | (Integer, Integer) -> Array[Item]?
+    def at: (Integer) -> Item?
+    def fetch: [Fallback] (Integer, *Fallback) ?{ (Integer) -> Fallback } -> (Item | Fallback)
+    def size: () -> Integer
+    alias length size
+    def empty?: () -> bool
+  end
+
+  class ObjectResponse[out Result < Record = Record] < Response[Result]
+    def key?: (String | Symbol) -> bool
+    def keys: () -> Array[String]
+    def values: () -> Array[value]
+    def []: (String | Symbol) -> value
+    def fetch: [Fallback] (String | Symbol, *Fallback) ?{ (String | Symbol) -> Fallback } -> (value | Fallback)
+    def to_h: () -> Hash[String, json]
+    def dig: (String | Symbol, *(String | Integer)) -> value
+  end
+
+  module Results
+    MODELS: Hash[String, [singleton(Record), singleton(ObjectResponse)]]
+    COLLECTION_OPERATIONS: Array[String]
+    EMPTY_OPERATIONS: Array[String]
+    def self.build: (String, Response[json]) -> Response
+    def self.boolean: (Response[json]) -> Response[json]
+    def self.validate_container: (String, json) -> void
+    def self.object: (singleton(Record), json, ?String) -> Record
+    def self.normalize: (String, json) -> json
+    def self.normalize_send: (String, json) -> json
+    def self.single_message: (json) -> json
+    def self.wrap: (json, singleton(Record), singleton(ObjectResponse), Response[json]) -> Response
+    def self.rows: (json) -> Array[Hash[String, json]]
+    def self.field_names: (Array[json]) -> Array[String]
+    def self.row_object: (Array[String], json, Integer) -> Hash[String, json]
+    def self.shape_error: (String, json, String) -> bot
+  end
+end

data/sig/records.rbs

@@ -0,0 +1,182 @@
+module Unisender
+  class IdentifierRecord < Record
+    def id: () -> id
+    def normalize: () -> void
+  end
+  class IdentifierRecordResponse < ObjectResponse[IdentifierRecord]
+    def id: () -> id
+  end
+  class List < IdentifierRecord
+    def title: () -> String
+    def normalize: () -> void
+  end
+  class ListResponse < ObjectResponse[List]
+    def id: () -> id
+    def title: () -> String
+  end
+  class Message < IdentifierRecord
+    def subject: () -> String?
+    def body: () -> String?
+    def sender_name: () -> String?
+    def sender_email: () -> String?
+    def normalize: () -> void
+  end
+  class MessageResponse < ObjectResponse[Message]
+    def id: () -> id
+    def subject: () -> String?
+    def body: () -> String?
+    def sender_name: () -> String?
+    def sender_email: () -> String?
+  end
+  class Campaign < IdentifierRecord
+    def status: () -> String?
+    def subject: () -> String?
+    def normalize: () -> void
+  end
+  class CampaignResponse < ObjectResponse[Campaign]
+    def id: () -> id
+    def status: () -> String?
+    def subject: () -> String?
+  end
+  class Template < IdentifierRecord
+    def title: () -> String?
+    def subject: () -> String?
+    def body: () -> String?
+    def normalize: () -> void
+  end
+  class TemplateResponse < ObjectResponse[Template]
+    def id: () -> id
+    def title: () -> String?
+    def subject: () -> String?
+    def body: () -> String?
+  end
+  class Field < IdentifierRecord
+    def name: () -> String
+    def type: () -> String
+    def normalize: () -> void
+  end
+  class FieldResponse < ObjectResponse[Field]
+    def id: () -> id
+    def name: () -> String
+    def type: () -> String
+  end
+  class Tag < IdentifierRecord
+    def name: () -> String
+    def normalize: () -> void
+  end
+  class TagResponse < ObjectResponse[Tag]
+    def id: () -> id
+    def name: () -> String
+  end
+  class Note < IdentifierRecord
+    def user_id: () -> id?
+    def subscriber_id: () -> id?
+    def origin: () -> String?
+    def is_pinned: () -> bool?
+    def created_at: () -> String?
+    def updated_at: () -> String?
+    def pinned_at: () -> String?
+    def content: () -> String
+    def normalize: () -> void
+  end
+  class NoteResponse < ObjectResponse[Note]
+    def user_id: () -> id?
+    def subscriber_id: () -> id?
+    def origin: () -> String?
+    def is_pinned: () -> bool?
+    def created_at: () -> String?
+    def updated_at: () -> String?
+    def pinned_at: () -> String?
+    def id: () -> id
+    def content: () -> String
+  end
+  class MessageCreated < Record
+    def message_id: () -> id
+    def normalize: () -> void
+  end
+  class MessageCreatedResponse < ObjectResponse[MessageCreated]
+    def message_id: () -> id
+  end
+  class Subscription < Record
+    def person_id: () -> id
+    def normalize: () -> void
+  end
+  class SubscriptionResponse < ObjectResponse[Subscription]
+    def person_id: () -> id
+  end
+  class CampaignCreated < Record
+    def count: () -> Integer?
+    def campaign_id: () -> id
+    def status: () -> String
+    def normalize: () -> void
+  end
+  class CampaignCreatedResponse < ObjectResponse[CampaignCreated]
+    def count: () -> Integer?
+    def campaign_id: () -> id
+    def status: () -> String
+  end
+  class Status < Record
+    def status: () -> String
+    def normalize: () -> void
+  end
+  class StatusResponse < ObjectResponse[Status]
+    def status: () -> String
+  end
+  class ContactCount < Record
+    def count: () -> Integer
+    def normalize: () -> void
+  end
+  class ContactCountResponse < ObjectResponse[ContactCount]
+    def count: () -> Integer
+  end
+  class TotalContacts < Record
+    def total: () -> Integer
+    def normalize: () -> void
+  end
+  class TotalContactsResponse < ObjectResponse[TotalContacts]
+    def total: () -> Integer
+  end
+  class MessageVersion < Record
+    def message_id: () -> id
+    def actual_version_id: () -> id
+    def normalize: () -> void
+  end
+  class MessageVersionResponse < ObjectResponse[MessageVersion]
+    def message_id: () -> id
+    def actual_version_id: () -> id
+  end
+  class WebVersion < Record
+    def letter_id: () -> id
+    def web_letter_link: () -> String
+    def normalize: () -> void
+  end
+  class WebVersionResponse < ObjectResponse[WebVersion]
+    def letter_id: () -> id
+    def web_letter_link: () -> String
+  end
+  class TaskResult < Record
+    def task_uuid: () -> String?
+    def status: () -> String
+    def file_to_download: () -> String?
+    def normalize: () -> void
+  end
+  class TaskResultResponse < ObjectResponse[TaskResult]
+    def task_uuid: () -> String?
+    def status: () -> String
+    def file_to_download: () -> String?
+  end
+  class OptionalIdentifier < Record
+    def id: () -> id?
+    def normalize: () -> void
+  end
+  class OptionalIdentifierResponse < ObjectResponse[OptionalIdentifier]
+    def id: () -> id?
+  end
+  class MessageNotice < Record
+    def message: () -> String?
+    def normalize: () -> void
+  end
+  class MessageNoticeResponse < ObjectResponse[MessageNotice]
+    def message: () -> String?
+  end
+end

data/sig/serialization.rbs

@@ -0,0 +1,13 @@
+module Unisender
+  type serialization_fields = String | Symbol | Array[String | Symbol]
+  type serialization_options = Hash[String | Symbol, serialization_fields]
+  module Serialization
+    OPTIONS: Array[String]
+    def self.payload: (Record, ?serialization_options?) -> Hash[String, json]
+                    | (value, ?serialization_options?) -> json
+    def self.json: (value, ?(serialization_options | JSON::State)?) -> String
+    def self.options_for: (serialization_options?) -> Hash[Symbol, Array[String]]
+    def self.field_names: (serialization_fields) -> Array[String]
+    def self.filter: (json, Hash[Symbol, Array[String]]) -> json
+  end
+end

data/sig/tasks.rbs

@@ -0,0 +1,26 @@
+module Unisender
+  interface _Downloader
+    def download: (String, _Writable, max_bytes: Integer) -> DownloadReceipt
+  end
+  class TaskResponse < TaskResultResponse
+    def completed?: () -> bool
+    def failed?: () -> bool
+    def pending?: () -> bool
+    @client: Client
+    attr_reader task_uuid: String
+    def initialize: (TaskResultResponse, client: Client, task_uuid: String) -> void
+    def wait: (?interval: duration, ?timeout: duration, ?clock: ( ^() -> Float)?, ?sleeper: ( ^(duration) -> void)?) ?{ (TaskResponse) -> void } -> TaskResponse
+    def download_to: (_Writable, max_bytes: Integer, ?downloader: _Downloader) -> DownloadReceipt
+    private
+    def download_file: (String, _Writable, Integer, _Downloader) -> DownloadReceipt
+  end
+  class TaskFailedError < TaskError
+  end
+  class UnknownTaskStateError < TaskError
+  end
+  class TaskTimeoutError < TimeoutError
+    attr_reader response: TaskResponse
+    attr_reader task_uuid: String
+    def initialize: (TaskResponse) -> void
+  end
+end

data/sig/testing.rbs

@@ -0,0 +1,54 @@
+module Unisender
+  module Testing
+    class Request < Data
+      attr_reader uri: URI::Generic
+      attr_reader headers: Hash[String, String]
+      attr_reader body: String
+      def self.new: (uri: URI::Generic, headers: Hash[String, String], body: String) -> Request
+      alias to_s inspect
+      def operation: () -> String
+      def form: () -> Hash[String, String]
+      def json: () -> json
+      def inspect: () -> String
+    end
+    class Reply < Data
+      attr_reader operation: String?
+      attr_reader response: HTTPResponse | StandardError
+      attr_reader expected_form: Hash[String, String]?
+      attr_reader expected_json: json?
+      def self.new: (operation: String?, response: HTTPResponse | StandardError, expected_form: Hash[String, String]?, expected_json: json?) -> Reply
+    end
+    class Transport
+      @replies: Array[Reply]
+      @requests: Array[Request]
+      def initialize: () -> void
+      def enqueue: (data: Hash[String, json], ?http_status: Integer, ?headers: Hash[String, String], ?operation: String?, ?expected_form: Hash[String, String]?, ?expected_json: json?) -> self
+      def enqueue_response: (HTTPResponse | StandardError, ?operation: String?, ?expected_form: Hash[String, String]?, ?expected_json: json?) -> self
+      def requests: () -> Array[Request]
+      def verify!: () -> self
+      def post: (URI::Generic, headers: Hash[String, String], body: String) -> HTTPResponse
+      def inspect: () -> String
+      private
+      def next_response: (Request) -> (HTTPResponse | StandardError)
+    end
+  end
+end
+
+module Unisender
+  module Testing
+    module Fixtures
+      def self.list: (id: id, title: String) -> Hash[String, json]
+      def self.import_result: (total: Integer, ?invalid: Integer, ?log: Array[Hash[String, json]]) -> Hash[String, json]
+      def self.task: (status: String, task_uuid: String, ?file_to_download: String?) -> Hash[String, json]
+      def self.recipient: (index: Integer, email: String, ?id: id?, ?errors: Array[Hash[String, json]]) -> Hash[String, json]
+    end
+    module Assertions
+      def self.check: (Request, Hash[String, String]?, json?) -> void
+      def self.validate: (Hash[String, String]?, json?) -> void
+      def self.subset!: (json, json, String) -> void
+      def self.hash!: (json, Hash[String, json], String) -> void
+      def self.array!: (json, Array[json], String) -> void
+      def self.mismatch!: (String) -> bot
+    end
+  end
+end