norbelys 0.1.0

data/lib/norbelys/models/domain_tracking.rb

@@ -0,0 +1,570 @@
+=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
+  # Custom tracking hostname state for a tracking domain.
+  class DomainTracking
+    # Sending domains whose links route through this tracking hostname.
+    attr_accessor :assigned_sending_domain_ids
+
+    attr_accessor :cloudflare_hostname_id
+
+    # Operator target state: `active` or `disabled`.
+    attr_accessor :desired_state
+
+    # Whether the CNAME resolves correctly: `pending`, `valid`, or `invalid`.
+    attr_accessor :dns_status
+
+    # Whether the DNS provider supports one-click Domain Connect setup.
+    attr_accessor :domain_connect_supported
+
+    attr_accessor :domain_connect_url
+
+    # Whether the tracking host serves over HTTP correctly: `pending`, `valid`, or `invalid`.
+    attr_accessor :http_status
+
+    # Whether this is the organization's default tracking domain.
+    attr_accessor :is_organization_default
+
+    attr_accessor :label
+
+    attr_accessor :last_checked_at
+
+    # Detected DNS provider: `cloudflare`, `vercel`, `other`, or `unknown`.
+    attr_accessor :provider
+
+    attr_accessor :provider_display_name
+
+    attr_accessor :provider_url
+
+    attr_accessor :record
+
+    # How the record is being set up: `domain_connect` or `manual`.
+    attr_accessor :setup_mode
+
+    # Lifecycle status: `pending_dns`, `pending_tls`, `checking`, `active`, `degraded`, or `archived`.
+    attr_accessor :status
+
+    # Whether the edge TLS certificate is issued: `pending`, `valid`, or `invalid`.
+    attr_accessor :tls_status
+
+    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
+      {
+        :'assigned_sending_domain_ids' => :'assignedSendingDomainIds',
+        :'cloudflare_hostname_id' => :'cloudflareHostnameId',
+        :'desired_state' => :'desiredState',
+        :'dns_status' => :'dnsStatus',
+        :'domain_connect_supported' => :'domainConnectSupported',
+        :'domain_connect_url' => :'domainConnectUrl',
+        :'http_status' => :'httpStatus',
+        :'is_organization_default' => :'isOrganizationDefault',
+        :'label' => :'label',
+        :'last_checked_at' => :'lastCheckedAt',
+        :'provider' => :'provider',
+        :'provider_display_name' => :'providerDisplayName',
+        :'provider_url' => :'providerUrl',
+        :'record' => :'record',
+        :'setup_mode' => :'setupMode',
+        :'status' => :'status',
+        :'tls_status' => :'tlsStatus'
+      }
+    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
+      {
+        :'assigned_sending_domain_ids' => :'Array<String>',
+        :'cloudflare_hostname_id' => :'String',
+        :'desired_state' => :'String',
+        :'dns_status' => :'String',
+        :'domain_connect_supported' => :'Boolean',
+        :'domain_connect_url' => :'String',
+        :'http_status' => :'String',
+        :'is_organization_default' => :'Boolean',
+        :'label' => :'String',
+        :'last_checked_at' => :'Object',
+        :'provider' => :'String',
+        :'provider_display_name' => :'String',
+        :'provider_url' => :'String',
+        :'record' => :'TrackingDnsRecord',
+        :'setup_mode' => :'String',
+        :'status' => :'String',
+        :'tls_status' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'cloudflare_hostname_id',
+        :'domain_connect_url',
+        :'label',
+        :'last_checked_at',
+        :'provider_display_name',
+        :'provider_url',
+      ])
+    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::DomainTracking` 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::DomainTracking`. 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?(:'assigned_sending_domain_ids')
+        if (value = attributes[:'assigned_sending_domain_ids']).is_a?(Array)
+          self.assigned_sending_domain_ids = value
+        end
+      else
+        self.assigned_sending_domain_ids = nil
+      end
+
+      if attributes.key?(:'cloudflare_hostname_id')
+        self.cloudflare_hostname_id = attributes[:'cloudflare_hostname_id']
+      else
+        self.cloudflare_hostname_id = nil
+      end
+
+      if attributes.key?(:'desired_state')
+        self.desired_state = attributes[:'desired_state']
+      else
+        self.desired_state = nil
+      end
+
+      if attributes.key?(:'dns_status')
+        self.dns_status = attributes[:'dns_status']
+      else
+        self.dns_status = nil
+      end
+
+      if attributes.key?(:'domain_connect_supported')
+        self.domain_connect_supported = attributes[:'domain_connect_supported']
+      else
+        self.domain_connect_supported = nil
+      end
+
+      if attributes.key?(:'domain_connect_url')
+        self.domain_connect_url = attributes[:'domain_connect_url']
+      else
+        self.domain_connect_url = nil
+      end
+
+      if attributes.key?(:'http_status')
+        self.http_status = attributes[:'http_status']
+      else
+        self.http_status = nil
+      end
+
+      if attributes.key?(:'is_organization_default')
+        self.is_organization_default = attributes[:'is_organization_default']
+      else
+        self.is_organization_default = nil
+      end
+
+      if attributes.key?(:'label')
+        self.label = attributes[:'label']
+      else
+        self.label = nil
+      end
+
+      if attributes.key?(:'last_checked_at')
+        self.last_checked_at = attributes[:'last_checked_at']
+      end
+
+      if attributes.key?(:'provider')
+        self.provider = attributes[:'provider']
+      else
+        self.provider = nil
+      end
+
+      if attributes.key?(:'provider_display_name')
+        self.provider_display_name = attributes[:'provider_display_name']
+      else
+        self.provider_display_name = nil
+      end
+
+      if attributes.key?(:'provider_url')
+        self.provider_url = attributes[:'provider_url']
+      else
+        self.provider_url = nil
+      end
+
+      if attributes.key?(:'record')
+        self.record = attributes[:'record']
+      else
+        self.record = nil
+      end
+
+      if attributes.key?(:'setup_mode')
+        self.setup_mode = attributes[:'setup_mode']
+      else
+        self.setup_mode = nil
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      else
+        self.status = nil
+      end
+
+      if attributes.key?(:'tls_status')
+        self.tls_status = attributes[:'tls_status']
+      else
+        self.tls_status = 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 @assigned_sending_domain_ids.nil?
+        invalid_properties.push('invalid value for "assigned_sending_domain_ids", assigned_sending_domain_ids cannot be nil.')
+      end
+
+      if @desired_state.nil?
+        invalid_properties.push('invalid value for "desired_state", desired_state cannot be nil.')
+      end
+
+      if @dns_status.nil?
+        invalid_properties.push('invalid value for "dns_status", dns_status cannot be nil.')
+      end
+
+      if @domain_connect_supported.nil?
+        invalid_properties.push('invalid value for "domain_connect_supported", domain_connect_supported cannot be nil.')
+      end
+
+      if @http_status.nil?
+        invalid_properties.push('invalid value for "http_status", http_status cannot be nil.')
+      end
+
+      if @is_organization_default.nil?
+        invalid_properties.push('invalid value for "is_organization_default", is_organization_default cannot be nil.')
+      end
+
+      if @provider.nil?
+        invalid_properties.push('invalid value for "provider", provider cannot be nil.')
+      end
+
+      if @record.nil?
+        invalid_properties.push('invalid value for "record", record cannot be nil.')
+      end
+
+      if @setup_mode.nil?
+        invalid_properties.push('invalid value for "setup_mode", setup_mode cannot be nil.')
+      end
+
+      if @status.nil?
+        invalid_properties.push('invalid value for "status", status cannot be nil.')
+      end
+
+      if @tls_status.nil?
+        invalid_properties.push('invalid value for "tls_status", tls_status cannot be nil.')
+      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 @assigned_sending_domain_ids.nil?
+      return false if @desired_state.nil?
+      desired_state_validator = EnumAttributeValidator.new('String', ["active", "disabled"])
+      return false unless desired_state_validator.valid?(@desired_state)
+      return false if @dns_status.nil?
+      dns_status_validator = EnumAttributeValidator.new('String', ["pending", "valid", "invalid"])
+      return false unless dns_status_validator.valid?(@dns_status)
+      return false if @domain_connect_supported.nil?
+      return false if @http_status.nil?
+      http_status_validator = EnumAttributeValidator.new('String', ["pending", "valid", "invalid"])
+      return false unless http_status_validator.valid?(@http_status)
+      return false if @is_organization_default.nil?
+      return false if @provider.nil?
+      provider_validator = EnumAttributeValidator.new('String', ["cloudflare", "vercel", "other", "unknown"])
+      return false unless provider_validator.valid?(@provider)
+      return false if @record.nil?
+      return false if @setup_mode.nil?
+      setup_mode_validator = EnumAttributeValidator.new('String', ["domain_connect", "manual"])
+      return false unless setup_mode_validator.valid?(@setup_mode)
+      return false if @status.nil?
+      status_validator = EnumAttributeValidator.new('String', ["pending_dns", "pending_tls", "checking", "active", "degraded", "archived"])
+      return false unless status_validator.valid?(@status)
+      return false if @tls_status.nil?
+      tls_status_validator = EnumAttributeValidator.new('String', ["pending", "valid", "invalid"])
+      return false unless tls_status_validator.valid?(@tls_status)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] desired_state Object to be assigned
+    def desired_state=(desired_state)
+      validator = EnumAttributeValidator.new('String', ["active", "disabled"])
+      unless validator.valid?(desired_state)
+        fail ArgumentError, "invalid value for \"desired_state\", must be one of #{validator.allowable_values}."
+      end
+      @desired_state = desired_state
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] dns_status Object to be assigned
+    def dns_status=(dns_status)
+      validator = EnumAttributeValidator.new('String', ["pending", "valid", "invalid"])
+      unless validator.valid?(dns_status)
+        fail ArgumentError, "invalid value for \"dns_status\", must be one of #{validator.allowable_values}."
+      end
+      @dns_status = dns_status
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] http_status Object to be assigned
+    def http_status=(http_status)
+      validator = EnumAttributeValidator.new('String', ["pending", "valid", "invalid"])
+      unless validator.valid?(http_status)
+        fail ArgumentError, "invalid value for \"http_status\", must be one of #{validator.allowable_values}."
+      end
+      @http_status = http_status
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] provider Object to be assigned
+    def provider=(provider)
+      validator = EnumAttributeValidator.new('String', ["cloudflare", "vercel", "other", "unknown"])
+      unless validator.valid?(provider)
+        fail ArgumentError, "invalid value for \"provider\", must be one of #{validator.allowable_values}."
+      end
+      @provider = provider
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] setup_mode Object to be assigned
+    def setup_mode=(setup_mode)
+      validator = EnumAttributeValidator.new('String', ["domain_connect", "manual"])
+      unless validator.valid?(setup_mode)
+        fail ArgumentError, "invalid value for \"setup_mode\", must be one of #{validator.allowable_values}."
+      end
+      @setup_mode = setup_mode
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] status Object to be assigned
+    def status=(status)
+      validator = EnumAttributeValidator.new('String', ["pending_dns", "pending_tls", "checking", "active", "degraded", "archived"])
+      unless validator.valid?(status)
+        fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
+      end
+      @status = status
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] tls_status Object to be assigned
+    def tls_status=(tls_status)
+      validator = EnumAttributeValidator.new('String', ["pending", "valid", "invalid"])
+      unless validator.valid?(tls_status)
+        fail ArgumentError, "invalid value for \"tls_status\", must be one of #{validator.allowable_values}."
+      end
+      @tls_status = tls_status
+    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 &&
+          assigned_sending_domain_ids == o.assigned_sending_domain_ids &&
+          cloudflare_hostname_id == o.cloudflare_hostname_id &&
+          desired_state == o.desired_state &&
+          dns_status == o.dns_status &&
+          domain_connect_supported == o.domain_connect_supported &&
+          domain_connect_url == o.domain_connect_url &&
+          http_status == o.http_status &&
+          is_organization_default == o.is_organization_default &&
+          label == o.label &&
+          last_checked_at == o.last_checked_at &&
+          provider == o.provider &&
+          provider_display_name == o.provider_display_name &&
+          provider_url == o.provider_url &&
+          record == o.record &&
+          setup_mode == o.setup_mode &&
+          status == o.status &&
+          tls_status == o.tls_status
+    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
+      [assigned_sending_domain_ids, cloudflare_hostname_id, desired_state, dns_status, domain_connect_supported, domain_connect_url, http_status, is_organization_default, label, last_checked_at, provider, provider_display_name, provider_url, record, setup_mode, status, tls_status].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