norbelys 0.1.0

data/lib/norbelys/models/people_bulk_create_params.rb

@@ -0,0 +1,401 @@
+=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 PeopleBulkCreateParams
+    # Optional campaigns to enroll every imported person into — both newly created people and already-existing matches. Several allowed; a draft campaign holds them until launch.
+    attr_accessor :campaign_ids
+
+    # ISO 3166-1 alpha-2 country used to normalize NATIONAL phone numbers to E.164 — e.g. `CO` turns `3163586947` into `+573163586947`. A number that already carries its country code (`+57…`) ignores this.
+    attr_accessor :default_country
+
+    # Optional static groups (lists) to add every imported person to — new AND already-existing matches. Several allowed.
+    attr_accessor :group_ids
+
+    # Optional import id you supply to GROUP several chunked calls into ONE import (so the stats at `GET /v1/people/bulk/{importId}` cover the whole upload). Generated automatically when omitted.
+    attr_accessor :import_id
+
+    # What to do when a person with this email already exists. `fill` (default): update the existing person, only filling fields that are currently empty — never overwrites existing values. `overwrite`: the uploaded values win for every field they provide. `skip`: leave the existing person untouched.
+    attr_accessor :on_conflict
+
+    # Up to 10,000 people to insert (data + custom fields); duplicate emails are skipped and malformed emails are rejected (both non-fatal — see `skipped` / `rejected`).
+    attr_accessor :people
+
+    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
+      {
+        :'campaign_ids' => :'campaignIds',
+        :'default_country' => :'defaultCountry',
+        :'group_ids' => :'groupIds',
+        :'import_id' => :'importId',
+        :'on_conflict' => :'onConflict',
+        :'people' => :'people'
+      }
+    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
+      {
+        :'campaign_ids' => :'Array<String>',
+        :'default_country' => :'String',
+        :'group_ids' => :'Array<String>',
+        :'import_id' => :'String',
+        :'on_conflict' => :'String',
+        :'people' => :'Array<PersonImportItem>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    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::PeopleBulkCreateParams` 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::PeopleBulkCreateParams`. 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?(:'campaign_ids')
+        if (value = attributes[:'campaign_ids']).is_a?(Array)
+          self.campaign_ids = value
+        end
+      end
+
+      if attributes.key?(:'default_country')
+        self.default_country = attributes[:'default_country']
+      end
+
+      if attributes.key?(:'group_ids')
+        if (value = attributes[:'group_ids']).is_a?(Array)
+          self.group_ids = value
+        end
+      end
+
+      if attributes.key?(:'import_id')
+        self.import_id = attributes[:'import_id']
+      end
+
+      if attributes.key?(:'on_conflict')
+        self.on_conflict = attributes[:'on_conflict']
+      else
+        self.on_conflict = 'fill'
+      end
+
+      if attributes.key?(:'people')
+        if (value = attributes[:'people']).is_a?(Array)
+          self.people = value
+        end
+      else
+        self.people = nil
+      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 !@campaign_ids.nil? && @campaign_ids.length > 50
+        invalid_properties.push('invalid value for "campaign_ids", number of items must be less than or equal to 50.')
+      end
+
+      pattern = Regexp.new(/^[A-Z]{2}$/)
+      if !@default_country.nil? && @default_country !~ pattern
+        invalid_properties.push("invalid value for \"default_country\", must conform to the pattern #{pattern}.")
+      end
+
+      if !@group_ids.nil? && @group_ids.length > 50
+        invalid_properties.push('invalid value for "group_ids", number of items must be less than or equal to 50.')
+      end
+
+      if @people.nil?
+        invalid_properties.push('invalid value for "people", people cannot be nil.')
+      end
+
+      if @people.length > 10000
+        invalid_properties.push('invalid value for "people", number of items must be less than or equal to 10000.')
+      end
+
+      if @people.length < 1
+        invalid_properties.push('invalid value for "people", number of items must be greater 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 !@campaign_ids.nil? && @campaign_ids.length > 50
+      return false if !@default_country.nil? && @default_country !~ Regexp.new(/^[A-Z]{2}$/)
+      return false if !@group_ids.nil? && @group_ids.length > 50
+      on_conflict_validator = EnumAttributeValidator.new('String', ["skip", "fill", "overwrite"])
+      return false unless on_conflict_validator.valid?(@on_conflict)
+      return false if @people.nil?
+      return false if @people.length > 10000
+      return false if @people.length < 1
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] campaign_ids Value to be assigned
+    def campaign_ids=(campaign_ids)
+      if campaign_ids.nil?
+        fail ArgumentError, 'campaign_ids cannot be nil'
+      end
+
+      if campaign_ids.length > 50
+        fail ArgumentError, 'invalid value for "campaign_ids", number of items must be less than or equal to 50.'
+      end
+
+      @campaign_ids = campaign_ids
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] default_country Value to be assigned
+    def default_country=(default_country)
+      if default_country.nil?
+        fail ArgumentError, 'default_country cannot be nil'
+      end
+
+      pattern = Regexp.new(/^[A-Z]{2}$/)
+      if default_country !~ pattern
+        fail ArgumentError, "invalid value for \"default_country\", must conform to the pattern #{pattern}."
+      end
+
+      @default_country = default_country
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] group_ids Value to be assigned
+    def group_ids=(group_ids)
+      if group_ids.nil?
+        fail ArgumentError, 'group_ids cannot be nil'
+      end
+
+      if group_ids.length > 50
+        fail ArgumentError, 'invalid value for "group_ids", number of items must be less than or equal to 50.'
+      end
+
+      @group_ids = group_ids
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] on_conflict Object to be assigned
+    def on_conflict=(on_conflict)
+      validator = EnumAttributeValidator.new('String', ["skip", "fill", "overwrite"])
+      unless validator.valid?(on_conflict)
+        fail ArgumentError, "invalid value for \"on_conflict\", must be one of #{validator.allowable_values}."
+      end
+      @on_conflict = on_conflict
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] people Value to be assigned
+    def people=(people)
+      if people.nil?
+        fail ArgumentError, 'people cannot be nil'
+      end
+
+      if people.length > 10000
+        fail ArgumentError, 'invalid value for "people", number of items must be less than or equal to 10000.'
+      end
+
+      if people.length < 1
+        fail ArgumentError, 'invalid value for "people", number of items must be greater than or equal to 1.'
+      end
+
+      @people = people
+    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 &&
+          campaign_ids == o.campaign_ids &&
+          default_country == o.default_country &&
+          group_ids == o.group_ids &&
+          import_id == o.import_id &&
+          on_conflict == o.on_conflict &&
+          people == o.people
+    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
+      [campaign_ids, default_country, group_ids, import_id, on_conflict, people].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