norbelys 0.1.0

data/lib/norbelys/models/update_sender_input.rb

@@ -0,0 +1,481 @@
+=begin
+#Norbelys API
+
+#The **Norbelys API** is a single, predictable REST surface for cold email and outreach — people, senders, programs, and sending all live behind the five patterns below. Developer-first and AI-first: every name is either already invented (Schema.org) or obvious.  ## Authentication  Every request authenticates with an **org-scoped API key**. Create one in **Settings → API keys** and send it as a bearer token:  ```http GET https://api.norbelys.com/v1/people Authorization: Bearer ak_live_… ```  Interactive agents may instead use OAuth 2.1 (see `/auth.md` and the `/.well-known/oauth-protected-resource` metadata).  ## Conventions  - **Base URL** — `https://api.norbelys.com/v1`. - **JSON in, JSON out.** Timestamps are ISO-8601 in UTC. - **Cursor pagination.** List endpoints take `limit` + `cursor` and return   `{ data, hasMore, nextCursor }` (offset-paged tables add `page` + `total`). - **Expansions.** Detail GETs take an `expand[]` query param to inline related   data (e.g. `GET /people/{id}?expand[]=timeline`) instead of extra calls. - **Soft deletes.** Anything that has been used is archived, never hard-deleted —   `DELETE` archives the resource and returns it.  ## Errors  Failures return the same envelope on every 4xx/5xx, with the matching HTTP status:  ```json { \"error\": { \"type\": \"invalid_request\", \"code\": \"invalid_param\",             \"message\": \"…\", \"hint\": \"…\", \"doc_url\": \"…\" } } ```  `type` is a broad, machine-routable category derived from the status; `code` is the stable machine contract you branch on (never the human `message`). See the `ApiError` schema.  ## Idempotency  Every `POST` accepts an optional **`Idempotency-Key`** header. Reuse the same key to replay the original result for 24h instead of re-executing — so a retried create can never double-charge or duplicate a record.  ## Rate limits & versioning  Abuse control is enforced at the edge; responses advertise the policy via the `RateLimit-Policy` header, and a `429` carries `Retry-After`. The API is versioned in the URL path (`/v1`). Breaking changes ship under a new version; a retiring surface is announced with `Deprecation` + `Sunset` response headers at least 90 days ahead.
+
+The version of the OpenAPI document: 0.0.1
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.10.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Norbelys
+  class UpdateSenderInput
+    # BCC every send to this address (CRM capture).
+    attr_accessor :bcc_crm_email
+
+    # Free-text label for this mailbox (e.g. to tag by client).
+    attr_accessor :client_label
+
+    # Maximum sends per day for this mailbox.
+    attr_accessor :daily_limit
+
+    # Minimum gap between sends from this mailbox (floor 3; server default 5).
+    attr_accessor :min_gap_minutes
+
+    # Reply-To override.
+    attr_accessor :reply_to
+
+    # The sending domain id. Omit to get-or-create it from the fromEmail host.
+    attr_accessor :sending_domain_id
+
+    # HTML signature appended to every send.
+    attr_accessor :signature_html
+
+    # Operator-set state to pause or resume the mailbox: `healthy`, `throttled`, or `paused`.
+    attr_accessor :state
+
+    attr_accessor :warmup
+
+    attr_accessor :archived_at
+
+    # The sending address (re-verifies the mailbox when changed).
+    attr_accessor :from_email
+
+    # Display name.
+    attr_accessor :from_name
+
+    attr_accessor :imap
+
+    attr_accessor :smtp
+
+    # How messages are carried: `smtp`, `provider_api`, `self_hosted`, or `voice`.
+    attr_accessor :transport_mode
+
+    # Managed provider; omit for a plain cold/SMTP mailbox.
+    attr_accessor :transport_provider
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'bcc_crm_email' => :'bccCrmEmail',
+        :'client_label' => :'clientLabel',
+        :'daily_limit' => :'dailyLimit',
+        :'min_gap_minutes' => :'minGapMinutes',
+        :'reply_to' => :'replyTo',
+        :'sending_domain_id' => :'sendingDomainId',
+        :'signature_html' => :'signatureHtml',
+        :'state' => :'state',
+        :'warmup' => :'warmup',
+        :'archived_at' => :'archivedAt',
+        :'from_email' => :'fromEmail',
+        :'from_name' => :'fromName',
+        :'imap' => :'imap',
+        :'smtp' => :'smtp',
+        :'transport_mode' => :'transportMode',
+        :'transport_provider' => :'transportProvider'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'bcc_crm_email' => :'String',
+        :'client_label' => :'String',
+        :'daily_limit' => :'Integer',
+        :'min_gap_minutes' => :'Integer',
+        :'reply_to' => :'String',
+        :'sending_domain_id' => :'String',
+        :'signature_html' => :'String',
+        :'state' => :'String',
+        :'warmup' => :'WarmupSettings',
+        :'archived_at' => :'Integer',
+        :'from_email' => :'String',
+        :'from_name' => :'String',
+        :'imap' => :'ImapConnectionUpdate',
+        :'smtp' => :'SmtpConnectionUpdate',
+        :'transport_mode' => :'String',
+        :'transport_provider' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'warmup',
+        :'archived_at',
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Norbelys::UpdateSenderInput` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Norbelys::UpdateSenderInput`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'bcc_crm_email')
+        self.bcc_crm_email = attributes[:'bcc_crm_email']
+      end
+
+      if attributes.key?(:'client_label')
+        self.client_label = attributes[:'client_label']
+      end
+
+      if attributes.key?(:'daily_limit')
+        self.daily_limit = attributes[:'daily_limit']
+      end
+
+      if attributes.key?(:'min_gap_minutes')
+        self.min_gap_minutes = attributes[:'min_gap_minutes']
+      end
+
+      if attributes.key?(:'reply_to')
+        self.reply_to = attributes[:'reply_to']
+      end
+
+      if attributes.key?(:'sending_domain_id')
+        self.sending_domain_id = attributes[:'sending_domain_id']
+      end
+
+      if attributes.key?(:'signature_html')
+        self.signature_html = attributes[:'signature_html']
+      end
+
+      if attributes.key?(:'state')
+        self.state = attributes[:'state']
+      end
+
+      if attributes.key?(:'warmup')
+        self.warmup = attributes[:'warmup']
+      end
+
+      if attributes.key?(:'archived_at')
+        self.archived_at = attributes[:'archived_at']
+      end
+
+      if attributes.key?(:'from_email')
+        self.from_email = attributes[:'from_email']
+      end
+
+      if attributes.key?(:'from_name')
+        self.from_name = attributes[:'from_name']
+      end
+
+      if attributes.key?(:'imap')
+        self.imap = attributes[:'imap']
+      end
+
+      if attributes.key?(:'smtp')
+        self.smtp = attributes[:'smtp']
+      end
+
+      if attributes.key?(:'transport_mode')
+        self.transport_mode = attributes[:'transport_mode']
+      end
+
+      if attributes.key?(:'transport_provider')
+        self.transport_provider = attributes[:'transport_provider']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if !@daily_limit.nil? && @daily_limit < 0
+        invalid_properties.push('invalid value for "daily_limit", must be greater than or equal to 0.')
+      end
+
+      if !@min_gap_minutes.nil? && @min_gap_minutes < 3
+        invalid_properties.push('invalid value for "min_gap_minutes", must be greater than or equal to 3.')
+      end
+
+      if !@archived_at.nil? && @archived_at < 0
+        invalid_properties.push('invalid value for "archived_at", must be greater than or equal to 0.')
+      end
+
+      if !@from_email.nil? && @from_email.to_s.length < 1
+        invalid_properties.push('invalid value for "from_email", the character length must be great than or equal to 1.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if !@daily_limit.nil? && @daily_limit < 0
+      return false if !@min_gap_minutes.nil? && @min_gap_minutes < 3
+      state_validator = EnumAttributeValidator.new('String', ["healthy", "throttled", "paused"])
+      return false unless state_validator.valid?(@state)
+      return false if !@archived_at.nil? && @archived_at < 0
+      return false if !@from_email.nil? && @from_email.to_s.length < 1
+      transport_mode_validator = EnumAttributeValidator.new('String', ["smtp", "provider_api", "self_hosted", "voice"])
+      return false unless transport_mode_validator.valid?(@transport_mode)
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] daily_limit Value to be assigned
+    def daily_limit=(daily_limit)
+      if daily_limit.nil?
+        fail ArgumentError, 'daily_limit cannot be nil'
+      end
+
+      if daily_limit < 0
+        fail ArgumentError, 'invalid value for "daily_limit", must be greater than or equal to 0.'
+      end
+
+      @daily_limit = daily_limit
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] min_gap_minutes Value to be assigned
+    def min_gap_minutes=(min_gap_minutes)
+      if min_gap_minutes.nil?
+        fail ArgumentError, 'min_gap_minutes cannot be nil'
+      end
+
+      if min_gap_minutes < 3
+        fail ArgumentError, 'invalid value for "min_gap_minutes", must be greater than or equal to 3.'
+      end
+
+      @min_gap_minutes = min_gap_minutes
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] state Object to be assigned
+    def state=(state)
+      validator = EnumAttributeValidator.new('String', ["healthy", "throttled", "paused"])
+      unless validator.valid?(state)
+        fail ArgumentError, "invalid value for \"state\", must be one of #{validator.allowable_values}."
+      end
+      @state = state
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] archived_at Value to be assigned
+    def archived_at=(archived_at)
+      if !archived_at.nil? && archived_at < 0
+        fail ArgumentError, 'invalid value for "archived_at", must be greater than or equal to 0.'
+      end
+
+      @archived_at = archived_at
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] from_email Value to be assigned
+    def from_email=(from_email)
+      if from_email.nil?
+        fail ArgumentError, 'from_email cannot be nil'
+      end
+
+      if from_email.to_s.length < 1
+        fail ArgumentError, 'invalid value for "from_email", the character length must be great than or equal to 1.'
+      end
+
+      @from_email = from_email
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] transport_mode Object to be assigned
+    def transport_mode=(transport_mode)
+      validator = EnumAttributeValidator.new('String', ["smtp", "provider_api", "self_hosted", "voice"])
+      unless validator.valid?(transport_mode)
+        fail ArgumentError, "invalid value for \"transport_mode\", must be one of #{validator.allowable_values}."
+      end
+      @transport_mode = transport_mode
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          bcc_crm_email == o.bcc_crm_email &&
+          client_label == o.client_label &&
+          daily_limit == o.daily_limit &&
+          min_gap_minutes == o.min_gap_minutes &&
+          reply_to == o.reply_to &&
+          sending_domain_id == o.sending_domain_id &&
+          signature_html == o.signature_html &&
+          state == o.state &&
+          warmup == o.warmup &&
+          archived_at == o.archived_at &&
+          from_email == o.from_email &&
+          from_name == o.from_name &&
+          imap == o.imap &&
+          smtp == o.smtp &&
+          transport_mode == o.transport_mode &&
+          transport_provider == o.transport_provider
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [bcc_crm_email, client_label, daily_limit, min_gap_minutes, reply_to, sending_domain_id, signature_html, state, warmup, archived_at, from_email, from_name, imap, smtp, transport_mode, transport_provider].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = Norbelys.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end