apimatic-apollo-sdk 0.0.1

data/lib/apollo_rest_api/models/task2.rb

@@ -0,0 +1,536 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApolloRestApi
+  # Task2 Model.
+  class Task2 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Object]
+    attr_accessor :emailer_campaign_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :user_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :created_at
+
+    # TODO: Write general description for this method
+    # @return [Object]
+    attr_accessor :completed_at
+
+    # TODO: Write general description for this method
+    # @return [Object]
+    attr_accessor :note
+
+    # TODO: Write general description for this method
+    # @return [Object]
+    attr_accessor :skipped_at
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :due_at
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :type
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :priority
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :status
+
+    # TODO: Write general description for this method
+    # @return [Object]
+    attr_accessor :answered
+
+    # TODO: Write general description for this method
+    # @return [Object]
+    attr_accessor :contact_id
+
+    # TODO: Write general description for this method
+    # @return [Object]
+    attr_accessor :person_id
+
+    # TODO: Write general description for this method
+    # @return [Object]
+    attr_accessor :account_id
+
+    # TODO: Write general description for this method
+    # @return [Object]
+    attr_accessor :organization_id
+
+    # TODO: Write general description for this method
+    # @return [Array[Object]]
+    attr_accessor :persona_ids
+
+    # TODO: Write general description for this method
+    # @return [Object]
+    attr_accessor :subject
+
+    # TODO: Write general description for this method
+    # @return [Object]
+    attr_accessor :created_from
+
+    # TODO: Write general description for this method
+    # @return [Object]
+    attr_accessor :salesforce_type
+
+    # TODO: Write general description for this method
+    # @return [Array[Object]]
+    attr_accessor :playbook_step_ids
+
+    # TODO: Write general description for this method
+    # @return [Object]
+    attr_accessor :playbook_id
+
+    # TODO: Write general description for this method
+    # @return [Object]
+    attr_accessor :needs_playbook_autoprospecting
+
+    # TODO: Write general description for this method
+    # @return [Array[Object]]
+    attr_accessor :starred_by_user_ids
+
+    # TODO: Write general description for this method
+    # @return [Object]
+    attr_accessor :salesforce_id
+
+    # TODO: Write general description for this method
+    # @return [Object]
+    attr_accessor :hubspot_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :opportunity_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :title
+
+    # TODO: Write general description for this method
+    # @return [Object]
+    attr_accessor :rule_config_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :creator_id
+
+    # TODO: Write general description for this method
+    # @return [Object]
+    attr_accessor :completed_by_user_id
+
+    # TODO: Write general description for this method
+    # @return [Object]
+    attr_accessor :call_script
+
+    # TODO: Write general description for this method
+    # @return [Object]
+    attr_accessor :relevant_fields
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :pending_send
+
+    # TODO: Write general description for this method
+    # @return [Object]
+    attr_accessor :ai_variables_status
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :recommended
+
+    # TODO: Write general description for this method
+    # @return [Array[Object]]
+    attr_accessor :recommendation_reasons
+
+    # Plain-text version of `note`, with HTML tags stripped. Only present for
+    # `call` tasks.
+    # @return [String]
+    attr_accessor :note_text
+
+    # Details about the logged phone call for this task. Only present for `call`
+    # type tasks that have an associated call log.
+    # @return [PhoneCall]
+    attr_accessor :phone_call
+
+    # The account associated with this task, when the task has one. Includes the
+    # same fields as the <a
+    # href="https://docs.apollo.io/reference/view-an-account">View an
+    # Account</a> endpoint's response, plus `linkedin_uid` and `account_queues`.
+    # @return [Account14]
+    attr_accessor :account
+
+    # The contact associated with this task, when the task has one. Includes the
+    # same fields as the <a
+    # href="https://docs.apollo.io/reference/view-a-contact">View a Contact</a>
+    # endpoint's response.
+    # @return [Contact11]
+    attr_accessor :contact
+
+    # The contact associated with this task, when the task has one. Includes the
+    # same fields as the <a
+    # href="https://docs.apollo.io/reference/view-a-contact">View a Contact</a>
+    # endpoint's response.
+    # @return [Opportunity5]
+    attr_accessor :opportunity
+
+    # Values for any team-defined relevant fields configured on this task's
+    # playbook step, keyed by field name.
+    # @return [Object]
+    attr_accessor :relevant_field_values
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['emailer_campaign_id'] = 'emailer_campaign_id'
+      @_hash['id'] = 'id'
+      @_hash['user_id'] = 'user_id'
+      @_hash['created_at'] = 'created_at'
+      @_hash['completed_at'] = 'completed_at'
+      @_hash['note'] = 'note'
+      @_hash['skipped_at'] = 'skipped_at'
+      @_hash['due_at'] = 'due_at'
+      @_hash['type'] = 'type'
+      @_hash['priority'] = 'priority'
+      @_hash['status'] = 'status'
+      @_hash['answered'] = 'answered'
+      @_hash['contact_id'] = 'contact_id'
+      @_hash['person_id'] = 'person_id'
+      @_hash['account_id'] = 'account_id'
+      @_hash['organization_id'] = 'organization_id'
+      @_hash['persona_ids'] = 'persona_ids'
+      @_hash['subject'] = 'subject'
+      @_hash['created_from'] = 'created_from'
+      @_hash['salesforce_type'] = 'salesforce_type'
+      @_hash['playbook_step_ids'] = 'playbook_step_ids'
+      @_hash['playbook_id'] = 'playbook_id'
+      @_hash['needs_playbook_autoprospecting'] =
+        'needs_playbook_autoprospecting'
+      @_hash['starred_by_user_ids'] = 'starred_by_user_ids'
+      @_hash['salesforce_id'] = 'salesforce_id'
+      @_hash['hubspot_id'] = 'hubspot_id'
+      @_hash['opportunity_id'] = 'opportunity_id'
+      @_hash['title'] = 'title'
+      @_hash['rule_config_id'] = 'rule_config_id'
+      @_hash['creator_id'] = 'creator_id'
+      @_hash['completed_by_user_id'] = 'completed_by_user_id'
+      @_hash['call_script'] = 'call_script'
+      @_hash['relevant_fields'] = 'relevant_fields'
+      @_hash['pending_send'] = 'pending_send'
+      @_hash['ai_variables_status'] = 'ai_variables_status'
+      @_hash['recommended'] = 'recommended'
+      @_hash['recommendation_reasons'] = 'recommendation_reasons'
+      @_hash['note_text'] = 'note_text'
+      @_hash['phone_call'] = 'phone_call'
+      @_hash['account'] = 'account'
+      @_hash['contact'] = 'contact'
+      @_hash['opportunity'] = 'opportunity'
+      @_hash['relevant_field_values'] = 'relevant_field_values'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        emailer_campaign_id
+        id
+        user_id
+        created_at
+        completed_at
+        note
+        skipped_at
+        due_at
+        type
+        priority
+        status
+        answered
+        contact_id
+        person_id
+        account_id
+        organization_id
+        persona_ids
+        subject
+        created_from
+        salesforce_type
+        playbook_step_ids
+        playbook_id
+        needs_playbook_autoprospecting
+        starred_by_user_ids
+        salesforce_id
+        hubspot_id
+        opportunity_id
+        title
+        rule_config_id
+        creator_id
+        completed_by_user_id
+        call_script
+        relevant_fields
+        pending_send
+        ai_variables_status
+        recommended
+        recommendation_reasons
+        note_text
+        phone_call
+        account
+        contact
+        opportunity
+        relevant_field_values
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(emailer_campaign_id: SKIP, id: SKIP, user_id: SKIP,
+                   created_at: SKIP, completed_at: SKIP, note: SKIP,
+                   skipped_at: SKIP, due_at: SKIP, type: SKIP, priority: SKIP,
+                   status: SKIP, answered: SKIP, contact_id: SKIP,
+                   person_id: SKIP, account_id: SKIP, organization_id: SKIP,
+                   persona_ids: SKIP, subject: SKIP, created_from: SKIP,
+                   salesforce_type: SKIP, playbook_step_ids: SKIP,
+                   playbook_id: SKIP, needs_playbook_autoprospecting: SKIP,
+                   starred_by_user_ids: SKIP, salesforce_id: SKIP,
+                   hubspot_id: SKIP, opportunity_id: SKIP, title: SKIP,
+                   rule_config_id: SKIP, creator_id: SKIP,
+                   completed_by_user_id: SKIP, call_script: SKIP,
+                   relevant_fields: SKIP, pending_send: SKIP,
+                   ai_variables_status: SKIP, recommended: SKIP,
+                   recommendation_reasons: SKIP, note_text: SKIP,
+                   phone_call: SKIP, account: SKIP, contact: SKIP,
+                   opportunity: SKIP, relevant_field_values: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @emailer_campaign_id = emailer_campaign_id unless emailer_campaign_id == SKIP
+      @id = id unless id == SKIP
+      @user_id = user_id unless user_id == SKIP
+      @created_at = created_at unless created_at == SKIP
+      @completed_at = completed_at unless completed_at == SKIP
+      @note = note unless note == SKIP
+      @skipped_at = skipped_at unless skipped_at == SKIP
+      @due_at = due_at unless due_at == SKIP
+      @type = type unless type == SKIP
+      @priority = priority unless priority == SKIP
+      @status = status unless status == SKIP
+      @answered = answered unless answered == SKIP
+      @contact_id = contact_id unless contact_id == SKIP
+      @person_id = person_id unless person_id == SKIP
+      @account_id = account_id unless account_id == SKIP
+      @organization_id = organization_id unless organization_id == SKIP
+      @persona_ids = persona_ids unless persona_ids == SKIP
+      @subject = subject unless subject == SKIP
+      @created_from = created_from unless created_from == SKIP
+      @salesforce_type = salesforce_type unless salesforce_type == SKIP
+      @playbook_step_ids = playbook_step_ids unless playbook_step_ids == SKIP
+      @playbook_id = playbook_id unless playbook_id == SKIP
+      unless needs_playbook_autoprospecting == SKIP
+        @needs_playbook_autoprospecting =
+          needs_playbook_autoprospecting
+      end
+      @starred_by_user_ids = starred_by_user_ids unless starred_by_user_ids == SKIP
+      @salesforce_id = salesforce_id unless salesforce_id == SKIP
+      @hubspot_id = hubspot_id unless hubspot_id == SKIP
+      @opportunity_id = opportunity_id unless opportunity_id == SKIP
+      @title = title unless title == SKIP
+      @rule_config_id = rule_config_id unless rule_config_id == SKIP
+      @creator_id = creator_id unless creator_id == SKIP
+      @completed_by_user_id = completed_by_user_id unless completed_by_user_id == SKIP
+      @call_script = call_script unless call_script == SKIP
+      @relevant_fields = relevant_fields unless relevant_fields == SKIP
+      @pending_send = pending_send unless pending_send == SKIP
+      @ai_variables_status = ai_variables_status unless ai_variables_status == SKIP
+      @recommended = recommended unless recommended == SKIP
+      @recommendation_reasons = recommendation_reasons unless recommendation_reasons == SKIP
+      @note_text = note_text unless note_text == SKIP
+      @phone_call = phone_call unless phone_call == SKIP
+      @account = account unless account == SKIP
+      @contact = contact unless contact == SKIP
+      @opportunity = opportunity unless opportunity == SKIP
+      @relevant_field_values = relevant_field_values unless relevant_field_values == 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_campaign_id =
+        hash.key?('emailer_campaign_id') ? hash['emailer_campaign_id'] : SKIP
+      id = hash.key?('id') ? hash['id'] : SKIP
+      user_id = hash.key?('user_id') ? hash['user_id'] : SKIP
+      created_at = hash.key?('created_at') ? hash['created_at'] : SKIP
+      completed_at = hash.key?('completed_at') ? hash['completed_at'] : SKIP
+      note = hash.key?('note') ? hash['note'] : SKIP
+      skipped_at = hash.key?('skipped_at') ? hash['skipped_at'] : SKIP
+      due_at = hash.key?('due_at') ? hash['due_at'] : SKIP
+      type = hash.key?('type') ? hash['type'] : SKIP
+      priority = hash.key?('priority') ? hash['priority'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      answered = hash.key?('answered') ? hash['answered'] : SKIP
+      contact_id = hash.key?('contact_id') ? hash['contact_id'] : SKIP
+      person_id = hash.key?('person_id') ? hash['person_id'] : SKIP
+      account_id = hash.key?('account_id') ? hash['account_id'] : SKIP
+      organization_id =
+        hash.key?('organization_id') ? hash['organization_id'] : SKIP
+      persona_ids = hash.key?('persona_ids') ? hash['persona_ids'] : SKIP
+      subject = hash.key?('subject') ? hash['subject'] : SKIP
+      created_from = hash.key?('created_from') ? hash['created_from'] : SKIP
+      salesforce_type =
+        hash.key?('salesforce_type') ? hash['salesforce_type'] : SKIP
+      playbook_step_ids =
+        hash.key?('playbook_step_ids') ? hash['playbook_step_ids'] : SKIP
+      playbook_id = hash.key?('playbook_id') ? hash['playbook_id'] : SKIP
+      needs_playbook_autoprospecting =
+        hash.key?('needs_playbook_autoprospecting') ? hash['needs_playbook_autoprospecting'] : SKIP
+      starred_by_user_ids =
+        hash.key?('starred_by_user_ids') ? hash['starred_by_user_ids'] : SKIP
+      salesforce_id = hash.key?('salesforce_id') ? hash['salesforce_id'] : SKIP
+      hubspot_id = hash.key?('hubspot_id') ? hash['hubspot_id'] : SKIP
+      opportunity_id =
+        hash.key?('opportunity_id') ? hash['opportunity_id'] : SKIP
+      title = hash.key?('title') ? hash['title'] : SKIP
+      rule_config_id =
+        hash.key?('rule_config_id') ? hash['rule_config_id'] : SKIP
+      creator_id = hash.key?('creator_id') ? hash['creator_id'] : SKIP
+      completed_by_user_id =
+        hash.key?('completed_by_user_id') ? hash['completed_by_user_id'] : SKIP
+      call_script = hash.key?('call_script') ? hash['call_script'] : SKIP
+      relevant_fields =
+        hash.key?('relevant_fields') ? hash['relevant_fields'] : SKIP
+      pending_send = hash.key?('pending_send') ? hash['pending_send'] : SKIP
+      ai_variables_status =
+        hash.key?('ai_variables_status') ? hash['ai_variables_status'] : SKIP
+      recommended = hash.key?('recommended') ? hash['recommended'] : SKIP
+      recommendation_reasons =
+        hash.key?('recommendation_reasons') ? hash['recommendation_reasons'] : SKIP
+      note_text = hash.key?('note_text') ? hash['note_text'] : SKIP
+      phone_call = PhoneCall.from_hash(hash['phone_call']) if hash['phone_call']
+      account = Account14.from_hash(hash['account']) if hash['account']
+      contact = Contact11.from_hash(hash['contact']) if hash['contact']
+      opportunity = Opportunity5.from_hash(hash['opportunity']) if hash['opportunity']
+      relevant_field_values =
+        hash.key?('relevant_field_values') ? hash['relevant_field_values'] : 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.
+      Task2.new(emailer_campaign_id: emailer_campaign_id,
+                id: id,
+                user_id: user_id,
+                created_at: created_at,
+                completed_at: completed_at,
+                note: note,
+                skipped_at: skipped_at,
+                due_at: due_at,
+                type: type,
+                priority: priority,
+                status: status,
+                answered: answered,
+                contact_id: contact_id,
+                person_id: person_id,
+                account_id: account_id,
+                organization_id: organization_id,
+                persona_ids: persona_ids,
+                subject: subject,
+                created_from: created_from,
+                salesforce_type: salesforce_type,
+                playbook_step_ids: playbook_step_ids,
+                playbook_id: playbook_id,
+                needs_playbook_autoprospecting: needs_playbook_autoprospecting,
+                starred_by_user_ids: starred_by_user_ids,
+                salesforce_id: salesforce_id,
+                hubspot_id: hubspot_id,
+                opportunity_id: opportunity_id,
+                title: title,
+                rule_config_id: rule_config_id,
+                creator_id: creator_id,
+                completed_by_user_id: completed_by_user_id,
+                call_script: call_script,
+                relevant_fields: relevant_fields,
+                pending_send: pending_send,
+                ai_variables_status: ai_variables_status,
+                recommended: recommended,
+                recommendation_reasons: recommendation_reasons,
+                note_text: note_text,
+                phone_call: phone_call,
+                account: account,
+                contact: contact,
+                opportunity: opportunity,
+                relevant_field_values: relevant_field_values,
+                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_campaign_id: #{@emailer_campaign_id}, id: #{@id}, user_id:"\
+      " #{@user_id}, created_at: #{@created_at}, completed_at: #{@completed_at}, note: #{@note},"\
+      " skipped_at: #{@skipped_at}, due_at: #{@due_at}, type: #{@type}, priority: #{@priority},"\
+      " status: #{@status}, answered: #{@answered}, contact_id: #{@contact_id}, person_id:"\
+      " #{@person_id}, account_id: #{@account_id}, organization_id: #{@organization_id},"\
+      " persona_ids: #{@persona_ids}, subject: #{@subject}, created_from: #{@created_from},"\
+      " salesforce_type: #{@salesforce_type}, playbook_step_ids: #{@playbook_step_ids},"\
+      " playbook_id: #{@playbook_id}, needs_playbook_autoprospecting:"\
+      " #{@needs_playbook_autoprospecting}, starred_by_user_ids: #{@starred_by_user_ids},"\
+      " salesforce_id: #{@salesforce_id}, hubspot_id: #{@hubspot_id}, opportunity_id:"\
+      " #{@opportunity_id}, title: #{@title}, rule_config_id: #{@rule_config_id}, creator_id:"\
+      " #{@creator_id}, completed_by_user_id: #{@completed_by_user_id}, call_script:"\
+      " #{@call_script}, relevant_fields: #{@relevant_fields}, pending_send: #{@pending_send},"\
+      " ai_variables_status: #{@ai_variables_status}, recommended: #{@recommended},"\
+      " recommendation_reasons: #{@recommendation_reasons}, note_text: #{@note_text}, phone_call:"\
+      " #{@phone_call}, account: #{@account}, contact: #{@contact}, opportunity: #{@opportunity},"\
+      " relevant_field_values: #{@relevant_field_values}, 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_campaign_id: #{@emailer_campaign_id.inspect}, id: #{@id.inspect},"\
+      " user_id: #{@user_id.inspect}, created_at: #{@created_at.inspect}, completed_at:"\
+      " #{@completed_at.inspect}, note: #{@note.inspect}, skipped_at: #{@skipped_at.inspect},"\
+      " due_at: #{@due_at.inspect}, type: #{@type.inspect}, priority: #{@priority.inspect},"\
+      " status: #{@status.inspect}, answered: #{@answered.inspect}, contact_id:"\
+      " #{@contact_id.inspect}, person_id: #{@person_id.inspect}, account_id:"\
+      " #{@account_id.inspect}, organization_id: #{@organization_id.inspect}, persona_ids:"\
+      " #{@persona_ids.inspect}, subject: #{@subject.inspect}, created_from:"\
+      " #{@created_from.inspect}, salesforce_type: #{@salesforce_type.inspect}, playbook_step_ids:"\
+      " #{@playbook_step_ids.inspect}, playbook_id: #{@playbook_id.inspect},"\
+      " needs_playbook_autoprospecting: #{@needs_playbook_autoprospecting.inspect},"\
+      " starred_by_user_ids: #{@starred_by_user_ids.inspect}, salesforce_id:"\
+      " #{@salesforce_id.inspect}, hubspot_id: #{@hubspot_id.inspect}, opportunity_id:"\
+      " #{@opportunity_id.inspect}, title: #{@title.inspect}, rule_config_id:"\
+      " #{@rule_config_id.inspect}, creator_id: #{@creator_id.inspect}, completed_by_user_id:"\
+      " #{@completed_by_user_id.inspect}, call_script: #{@call_script.inspect}, relevant_fields:"\
+      " #{@relevant_fields.inspect}, pending_send: #{@pending_send.inspect}, ai_variables_status:"\
+      " #{@ai_variables_status.inspect}, recommended: #{@recommended.inspect},"\
+      " recommendation_reasons: #{@recommendation_reasons.inspect}, note_text:"\
+      " #{@note_text.inspect}, phone_call: #{@phone_call.inspect}, account: #{@account.inspect},"\
+      " contact: #{@contact.inspect}, opportunity: #{@opportunity.inspect}, relevant_field_values:"\
+      " #{@relevant_field_values.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end