apimatic-apollo-sdk 0.0.1

data/lib/apollo_rest_api/models/emailer_messages_request.rb

@@ -0,0 +1,197 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApolloRestApi
+  # EmailerMessagesRequest Model.
+  class EmailerMessagesRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The Apollo ID for the contact that will receive the email. <br><br>This is
+    # required unless you provide `in_response_to_emailer_message_id`, in which
+    # case the contact is inferred from the parent message. <br><br>To find
+    # contact IDs, call the <a
+    # href="https://docs.apollo.io/reference/search-for-contacts"
+    # target="_blank">Search for Contacts endpoint</a> and identify the `id`
+    # value for the contact. <br><br>Example: `66e34b81740c50074e3d1bd4`
+    # @return [String]
+    attr_accessor :contact_id
+
+    # The subject line of the email. <br><br>Example: `Quick question about your
+    # team's workflow`
+    # @return [String]
+    attr_accessor :subject
+
+    # The body of the email as HTML. The content is sanitized by Apollo before
+    # it is saved. <br><br>Example: `<p>Hi there, I wanted to reach out
+    # about...</p>`
+    # @return [String]
+    attr_accessor :body_html
+
+    # The list of recipients for the email. Use this to set the `to`, `cc`, and
+    # `bcc` recipients. If you do not provide a `to` recipient, Apollo keeps the
+    # existing `to` recipients (if any). <br><br>All recipient emails must be
+    # valid, otherwise the request fails and the email is not saved.
+    # @return [Array[Recipient]]
+    attr_accessor :recipients
+
+    # The Apollo ID of an existing email message that this draft is replying to.
+    # When provided, Apollo infers the contact and builds the recipients from
+    # the parent message, so you do not need to provide `contact_id`.
+    # <br><br>Example: `66e8cc45028aed019c25d724`
+    # @return [String]
+    attr_accessor :in_response_to_emailer_message_id
+
+    # The Apollo ID of an email template to associate with the draft.
+    # <br><br>Example: `66e8cc45028aed019c25d725`
+    # @return [String]
+    attr_accessor :emailer_template_id
+
+    # The Apollo IDs of the attachments to include with the email.
+    # @return [Array[String]]
+    attr_accessor :attachment_ids
+
+    # Set to `true` to enable open and click tracking for the email. This is
+    # only applied if your team is permitted to track emails. <br><br>Example:
+    # `true`
+    # @return [TrueClass | FalseClass]
+    attr_accessor :enable_tracking
+
+    # The Apollo ID of an outreach task to associate with the draft. If a
+    # drafted email already exists for this task, Apollo links to that draft
+    # instead of creating a new one. <br><br>Example: `66e8cc45028aed019c25d726`
+    # @return [String]
+    attr_accessor :outreach_task_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['contact_id'] = 'contact_id'
+      @_hash['subject'] = 'subject'
+      @_hash['body_html'] = 'body_html'
+      @_hash['recipients'] = 'recipients'
+      @_hash['in_response_to_emailer_message_id'] =
+        'in_response_to_emailer_message_id'
+      @_hash['emailer_template_id'] = 'emailer_template_id'
+      @_hash['attachment_ids'] = 'attachment_ids'
+      @_hash['enable_tracking'] = 'enable_tracking'
+      @_hash['outreach_task_id'] = 'outreach_task_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        subject
+        body_html
+        recipients
+        in_response_to_emailer_message_id
+        emailer_template_id
+        attachment_ids
+        enable_tracking
+        outreach_task_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(contact_id:, subject: SKIP, body_html: SKIP,
+                   recipients: SKIP, in_response_to_emailer_message_id: SKIP,
+                   emailer_template_id: SKIP, attachment_ids: SKIP,
+                   enable_tracking: SKIP, outreach_task_id: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @contact_id = contact_id
+      @subject = subject unless subject == SKIP
+      @body_html = body_html unless body_html == SKIP
+      @recipients = recipients unless recipients == SKIP
+      unless in_response_to_emailer_message_id == SKIP
+        @in_response_to_emailer_message_id =
+          in_response_to_emailer_message_id
+      end
+      @emailer_template_id = emailer_template_id unless emailer_template_id == SKIP
+      @attachment_ids = attachment_ids unless attachment_ids == SKIP
+      @enable_tracking = enable_tracking unless enable_tracking == SKIP
+      @outreach_task_id = outreach_task_id unless outreach_task_id == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      contact_id = hash.key?('contact_id') ? hash['contact_id'] : nil
+      subject = hash.key?('subject') ? hash['subject'] : SKIP
+      body_html = hash.key?('body_html') ? hash['body_html'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      recipients = nil
+      unless hash['recipients'].nil?
+        recipients = []
+        hash['recipients'].each do |structure|
+          recipients << (Recipient.from_hash(structure) if structure)
+        end
+      end
+
+      recipients = SKIP unless hash.key?('recipients')
+      in_response_to_emailer_message_id =
+        hash.key?('in_response_to_emailer_message_id') ? hash['in_response_to_emailer_message_id'] : SKIP
+      emailer_template_id =
+        hash.key?('emailer_template_id') ? hash['emailer_template_id'] : SKIP
+      attachment_ids =
+        hash.key?('attachment_ids') ? hash['attachment_ids'] : SKIP
+      enable_tracking =
+        hash.key?('enable_tracking') ? hash['enable_tracking'] : SKIP
+      outreach_task_id =
+        hash.key?('outreach_task_id') ? hash['outreach_task_id'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      EmailerMessagesRequest.new(contact_id: contact_id,
+                                 subject: subject,
+                                 body_html: body_html,
+                                 recipients: recipients,
+                                 in_response_to_emailer_message_id: in_response_to_emailer_message_id,
+                                 emailer_template_id: emailer_template_id,
+                                 attachment_ids: attachment_ids,
+                                 enable_tracking: enable_tracking,
+                                 outreach_task_id: outreach_task_id,
+                                 additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} contact_id: #{@contact_id}, subject: #{@subject}, body_html: #{@body_html},"\
+      " recipients: #{@recipients}, in_response_to_emailer_message_id:"\
+      " #{@in_response_to_emailer_message_id}, emailer_template_id: #{@emailer_template_id},"\
+      " attachment_ids: #{@attachment_ids}, enable_tracking: #{@enable_tracking},"\
+      " outreach_task_id: #{@outreach_task_id}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} contact_id: #{@contact_id.inspect}, subject: #{@subject.inspect},"\
+      " body_html: #{@body_html.inspect}, recipients: #{@recipients.inspect},"\
+      " in_response_to_emailer_message_id: #{@in_response_to_emailer_message_id.inspect},"\
+      " emailer_template_id: #{@emailer_template_id.inspect}, attachment_ids:"\
+      " #{@attachment_ids.inspect}, enable_tracking: #{@enable_tracking.inspect},"\
+      " outreach_task_id: #{@outreach_task_id.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/apollo_rest_api/models/emailer_messages_response.rb

@@ -0,0 +1,77 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApolloRestApi
+  # EmailerMessagesResponse Model.
+  class EmailerMessagesResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [EmailerMessage]
+    attr_accessor :emailer_message
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['emailer_message'] = 'emailer_message'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        emailer_message
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(emailer_message: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @emailer_message = emailer_message unless emailer_message == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      emailer_message = EmailerMessage.from_hash(hash['emailer_message']) if
+        hash['emailer_message']
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      EmailerMessagesResponse.new(emailer_message: emailer_message,
+                                  additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} emailer_message: #{@emailer_message}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} emailer_message: #{@emailer_message.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/apollo_rest_api/models/emailer_messages_send_now_request.rb

@@ -0,0 +1,76 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApolloRestApi
+  # EmailerMessagesSendNowRequest Model.
+  class EmailerMessagesSendNowRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Optional. The surface within Apollo that the send is initiated from. Used
+    # for internal attribution and analytics. <br><br>Example: `emails`
+    # @return [String]
+    attr_accessor :surface
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['surface'] = 'surface'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        surface
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(surface: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @surface = surface unless surface == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      surface = hash.key?('surface') ? hash['surface'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      EmailerMessagesSendNowRequest.new(surface: surface,
+                                        additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} surface: #{@surface}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} surface: #{@surface.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/apollo_rest_api/models/emailer_messages_send_now_response.rb

@@ -0,0 +1,77 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApolloRestApi
+  # EmailerMessagesSendNowResponse Model.
+  class EmailerMessagesSendNowResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [EmailerMessage1]
+    attr_accessor :emailer_message
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['emailer_message'] = 'emailer_message'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        emailer_message
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(emailer_message: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @emailer_message = emailer_message unless emailer_message == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      emailer_message = EmailerMessage1.from_hash(hash['emailer_message']) if
+        hash['emailer_message']
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      EmailerMessagesSendNowResponse.new(emailer_message: emailer_message,
+                                         additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} emailer_message: #{@emailer_message}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} emailer_message: #{@emailer_message.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/apollo_rest_api/models/emailer_schedule.rb

@@ -0,0 +1,154 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApolloRestApi
+  # EmailerSchedule Model.
+  class EmailerSchedule < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The unique Apollo ID for the sending schedule. Use this value as the
+    # `emailer_schedule_id` when you create or update a sequence.
+    # @return [String]
+    attr_accessor :id
+
+    # The name of the sending schedule.
+    # @return [String]
+    attr_accessor :name
+
+    # Whether this is the default sending schedule for your team. Only one
+    # schedule can be the default at a time.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :default
+
+    # The IANA time zone that the schedule's sending windows are defined in, for
+    # example `America/Los_Angeles`.
+    # @return [String]
+    attr_accessor :time_zone
+
+    # The weekly sending windows, keyed by day of the week. Each day maps to an
+    # array of `[start_hour, end_hour]` pairs using 24-hour times, so `[[8,
+    # 17]]` means 8:00 AM to 5:00 PM. Days with no sending windows are omitted.
+    # @return [Object]
+    attr_accessor :schedule_hash
+
+    # The timestamp for when the schedule was created, in ISO 8601 format.
+    # @return [String]
+    attr_accessor :created_at
+
+    # Whether Apollo sends emails according to each contact's own time zone
+    # instead of the schedule's `time_zone`.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :use_contacts_time_zone
+
+    # Whether Apollo skips sending emails on holidays.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :skip_holidays
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['name'] = 'name'
+      @_hash['default'] = 'default'
+      @_hash['time_zone'] = 'time_zone'
+      @_hash['schedule_hash'] = 'schedule_hash'
+      @_hash['created_at'] = 'created_at'
+      @_hash['use_contacts_time_zone'] = 'use_contacts_time_zone'
+      @_hash['skip_holidays'] = 'skip_holidays'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        name
+        default
+        time_zone
+        schedule_hash
+        created_at
+        use_contacts_time_zone
+        skip_holidays
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id: SKIP, name: SKIP, default: SKIP, time_zone: SKIP,
+                   schedule_hash: SKIP, created_at: SKIP,
+                   use_contacts_time_zone: SKIP, skip_holidays: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id unless id == SKIP
+      @name = name unless name == SKIP
+      @default = default unless default == SKIP
+      @time_zone = time_zone unless time_zone == SKIP
+      @schedule_hash = schedule_hash unless schedule_hash == SKIP
+      @created_at = created_at unless created_at == SKIP
+      @use_contacts_time_zone = use_contacts_time_zone unless use_contacts_time_zone == SKIP
+      @skip_holidays = skip_holidays unless skip_holidays == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      id = hash.key?('id') ? hash['id'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+      default = hash.key?('default') ? hash['default'] : SKIP
+      time_zone = hash.key?('time_zone') ? hash['time_zone'] : SKIP
+      schedule_hash = hash.key?('schedule_hash') ? hash['schedule_hash'] : SKIP
+      created_at = hash.key?('created_at') ? hash['created_at'] : SKIP
+      use_contacts_time_zone =
+        hash.key?('use_contacts_time_zone') ? hash['use_contacts_time_zone'] : SKIP
+      skip_holidays = hash.key?('skip_holidays') ? hash['skip_holidays'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      EmailerSchedule.new(id: id,
+                          name: name,
+                          default: default,
+                          time_zone: time_zone,
+                          schedule_hash: schedule_hash,
+                          created_at: created_at,
+                          use_contacts_time_zone: use_contacts_time_zone,
+                          skip_holidays: skip_holidays,
+                          additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, name: #{@name}, default: #{@default}, time_zone: #{@time_zone},"\
+      " schedule_hash: #{@schedule_hash}, created_at: #{@created_at}, use_contacts_time_zone:"\
+      " #{@use_contacts_time_zone}, skip_holidays: #{@skip_holidays}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, name: #{@name.inspect}, default: #{@default.inspect},"\
+      " time_zone: #{@time_zone.inspect}, schedule_hash: #{@schedule_hash.inspect}, created_at:"\
+      " #{@created_at.inspect}, use_contacts_time_zone: #{@use_contacts_time_zone.inspect},"\
+      " skip_holidays: #{@skip_holidays.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/apollo_rest_api/models/emailer_schedules_response.rb

@@ -0,0 +1,85 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApolloRestApi
+  # EmailerSchedulesResponse Model.
+  class EmailerSchedulesResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The list of sending schedules that belong to your team.
+    # @return [Array[EmailerSchedule]]
+    attr_accessor :emailer_schedules
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['emailer_schedules'] = 'emailer_schedules'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        emailer_schedules
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(emailer_schedules: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @emailer_schedules = emailer_schedules unless emailer_schedules == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      # Parameter is an array, so we need to iterate through it
+      emailer_schedules = nil
+      unless hash['emailer_schedules'].nil?
+        emailer_schedules = []
+        hash['emailer_schedules'].each do |structure|
+          emailer_schedules << (EmailerSchedule.from_hash(structure) if structure)
+        end
+      end
+
+      emailer_schedules = SKIP unless hash.key?('emailer_schedules')
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      EmailerSchedulesResponse.new(emailer_schedules: emailer_schedules,
+                                   additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} emailer_schedules: #{@emailer_schedules}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} emailer_schedules: #{@emailer_schedules.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end