zippendo 1.2.4 → 1.2.6

data/lib/zippendo/models/list_order_channels200_response_data_inner.rb

@@ -0,0 +1,478 @@
+=begin
+#Zippendo Public API
+
+#Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_).  **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body:  1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined    to that brand — reads filtered, writes stamped. This is the recommended way to give a single    brand's team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual    request by sending the brand's id or slug in this header. Most SDKs let you set it once on the    client so every call inherits it.  A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token.  Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide.  List endpoints additionally take a `?brandScope=own|shared|both` parameter to narrow further within whichever brand context already applies. `own` returns only rows assigned to that brand, and requires a brand context — a brand-bound token, a resolved brand session, or the `X-Zippendo-Brand` header above — otherwise `400`. `shared` returns only the organization-wide rows (equivalent to filtering `brandId=none`). The default, `both`, keeps the existing behaviour: a brand context sees its own rows plus the organization-wide ones. Set `X-Zippendo-Brand-Scope` as a client default to apply the same choice to every request instead of repeating the query parameter on each call — an explicit `brandScope` query parameter always wins over the header, and a blank header value is ignored.  Brands themselves are managed under the **Brands** tag. Retiring a brand is done with `POST /orgs/{orgId}/brands/{brandId}/archive` — permanent deletion is a dashboard-only action, since it is refused while any order, shipment, member or token still references the brand. Brands require a plan that includes them; creating one beyond your plan's limit returns `403`.
+
+The version of the OpenAPI document: 1.0.0
+Contact: support@zippendo.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.24.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Zippendo
+  class ListOrderChannels200ResponseDataInner < ApiModelBase
+    # Unique order channel ID.
+    attr_accessor :id
+
+    # Display name of the channel.
+    attr_accessor :name
+
+    # Type of the order channel (sales platform).
+    attr_accessor :type
+
+    # Whether the channel is active.
+    attr_accessor :enabled
+
+    # Brand this channel belongs to, or null for organization-wide. Orders synced from this channel inherit it, and so do the shipments and documents made from them.
+    attr_accessor :brand_id
+
+    # Whether credentials are configured (values are never exposed).
+    attr_accessor :has_credentials
+
+    attr_accessor :settings
+
+    # Whether real-time webhooks are enabled.
+    attr_accessor :webhooks_enabled
+
+    # Timestamp of the last successful sync.
+    attr_accessor :last_sync_at
+
+    # Error message from the last failed sync.
+    attr_accessor :last_sync_error
+
+    # IDs of shipping rules linked to this channel.
+    attr_accessor :shipping_rule_ids
+
+    # Owning organization ID.
+    attr_accessor :org_id
+
+    # Creation timestamp (ISO 8601).
+    attr_accessor :created_at
+
+    # Last update timestamp (ISO 8601).
+    attr_accessor :updated_at
+
+    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
+      {
+        :'id' => :'id',
+        :'name' => :'name',
+        :'type' => :'type',
+        :'enabled' => :'enabled',
+        :'brand_id' => :'brandId',
+        :'has_credentials' => :'hasCredentials',
+        :'settings' => :'settings',
+        :'webhooks_enabled' => :'webhooksEnabled',
+        :'last_sync_at' => :'lastSyncAt',
+        :'last_sync_error' => :'lastSyncError',
+        :'shipping_rule_ids' => :'shippingRuleIds',
+        :'org_id' => :'orgId',
+        :'created_at' => :'createdAt',
+        :'updated_at' => :'updatedAt'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'id' => :'String',
+        :'name' => :'String',
+        :'type' => :'String',
+        :'enabled' => :'Boolean',
+        :'brand_id' => :'String',
+        :'has_credentials' => :'Boolean',
+        :'settings' => :'ListOrderChannels200ResponseDataInnerSettings',
+        :'webhooks_enabled' => :'Boolean',
+        :'last_sync_at' => :'Time',
+        :'last_sync_error' => :'String',
+        :'shipping_rule_ids' => :'Array<String>',
+        :'org_id' => :'String',
+        :'created_at' => :'String',
+        :'updated_at' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'brand_id',
+        :'last_sync_at',
+        :'last_sync_error',
+      ])
+    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 `Zippendo::ListOrderChannels200ResponseDataInner` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Zippendo::ListOrderChannels200ResponseDataInner`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      else
+        self.id = nil
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      else
+        self.name = nil
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      else
+        self.type = nil
+      end
+
+      if attributes.key?(:'enabled')
+        self.enabled = attributes[:'enabled']
+      else
+        self.enabled = nil
+      end
+
+      if attributes.key?(:'brand_id')
+        self.brand_id = attributes[:'brand_id']
+      else
+        self.brand_id = nil
+      end
+
+      if attributes.key?(:'has_credentials')
+        self.has_credentials = attributes[:'has_credentials']
+      else
+        self.has_credentials = nil
+      end
+
+      if attributes.key?(:'settings')
+        self.settings = attributes[:'settings']
+      else
+        self.settings = nil
+      end
+
+      if attributes.key?(:'webhooks_enabled')
+        self.webhooks_enabled = attributes[:'webhooks_enabled']
+      end
+
+      if attributes.key?(:'last_sync_at')
+        self.last_sync_at = attributes[:'last_sync_at']
+      end
+
+      if attributes.key?(:'last_sync_error')
+        self.last_sync_error = attributes[:'last_sync_error']
+      end
+
+      if attributes.key?(:'shipping_rule_ids')
+        if (value = attributes[:'shipping_rule_ids']).is_a?(Array)
+          self.shipping_rule_ids = value
+        end
+      end
+
+      if attributes.key?(:'org_id')
+        self.org_id = attributes[:'org_id']
+      else
+        self.org_id = nil
+      end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      else
+        self.created_at = nil
+      end
+
+      if attributes.key?(:'updated_at')
+        self.updated_at = attributes[:'updated_at']
+      else
+        self.updated_at = 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 @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @type.nil?
+        invalid_properties.push('invalid value for "type", type cannot be nil.')
+      end
+
+      if @enabled.nil?
+        invalid_properties.push('invalid value for "enabled", enabled cannot be nil.')
+      end
+
+      if @has_credentials.nil?
+        invalid_properties.push('invalid value for "has_credentials", has_credentials cannot be nil.')
+      end
+
+      if @settings.nil?
+        invalid_properties.push('invalid value for "settings", settings cannot be nil.')
+      end
+
+      pattern = Regexp.new(/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$/)
+      if !@last_sync_at.nil? && @last_sync_at !~ pattern
+        invalid_properties.push("invalid value for \"last_sync_at\", must conform to the pattern #{pattern}.")
+      end
+
+      if @org_id.nil?
+        invalid_properties.push('invalid value for "org_id", org_id cannot be nil.')
+      end
+
+      if @created_at.nil?
+        invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
+      end
+
+      if @updated_at.nil?
+        invalid_properties.push('invalid value for "updated_at", updated_at 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 @id.nil?
+      return false if @name.nil?
+      return false if @type.nil?
+      type_validator = EnumAttributeValidator.new('String', ["shopify", "woocommerce", "manual", "custom"])
+      return false unless type_validator.valid?(@type)
+      return false if @enabled.nil?
+      return false if @has_credentials.nil?
+      return false if @settings.nil?
+      return false if !@last_sync_at.nil? && @last_sync_at !~ Regexp.new(/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$/)
+      return false if @org_id.nil?
+      return false if @created_at.nil?
+      return false if @updated_at.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] id Value to be assigned
+    def id=(id)
+      if id.nil?
+        fail ArgumentError, 'id cannot be nil'
+      end
+
+      @id = id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] name Value to be assigned
+    def name=(name)
+      if name.nil?
+        fail ArgumentError, 'name cannot be nil'
+      end
+
+      @name = name
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] type Object to be assigned
+    def type=(type)
+      validator = EnumAttributeValidator.new('String', ["shopify", "woocommerce", "manual", "custom"])
+      unless validator.valid?(type)
+        fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
+      end
+      @type = type
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] enabled Value to be assigned
+    def enabled=(enabled)
+      if enabled.nil?
+        fail ArgumentError, 'enabled cannot be nil'
+      end
+
+      @enabled = enabled
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] has_credentials Value to be assigned
+    def has_credentials=(has_credentials)
+      if has_credentials.nil?
+        fail ArgumentError, 'has_credentials cannot be nil'
+      end
+
+      @has_credentials = has_credentials
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] settings Value to be assigned
+    def settings=(settings)
+      if settings.nil?
+        fail ArgumentError, 'settings cannot be nil'
+      end
+
+      @settings = settings
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] last_sync_at Value to be assigned
+    def last_sync_at=(last_sync_at)
+      pattern = Regexp.new(/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$/)
+      if !last_sync_at.nil? && last_sync_at !~ pattern
+        fail ArgumentError, "invalid value for \"last_sync_at\", must conform to the pattern #{pattern}."
+      end
+
+      @last_sync_at = last_sync_at
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] org_id Value to be assigned
+    def org_id=(org_id)
+      if org_id.nil?
+        fail ArgumentError, 'org_id cannot be nil'
+      end
+
+      @org_id = org_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] created_at Value to be assigned
+    def created_at=(created_at)
+      if created_at.nil?
+        fail ArgumentError, 'created_at cannot be nil'
+      end
+
+      @created_at = created_at
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] updated_at Value to be assigned
+    def updated_at=(updated_at)
+      if updated_at.nil?
+        fail ArgumentError, 'updated_at cannot be nil'
+      end
+
+      @updated_at = updated_at
+    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 &&
+          id == o.id &&
+          name == o.name &&
+          type == o.type &&
+          enabled == o.enabled &&
+          brand_id == o.brand_id &&
+          has_credentials == o.has_credentials &&
+          settings == o.settings &&
+          webhooks_enabled == o.webhooks_enabled &&
+          last_sync_at == o.last_sync_at &&
+          last_sync_error == o.last_sync_error &&
+          shipping_rule_ids == o.shipping_rule_ids &&
+          org_id == o.org_id &&
+          created_at == o.created_at &&
+          updated_at == o.updated_at
+    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
+      [id, name, type, enabled, brand_id, has_credentials, settings, webhooks_enabled, last_sync_at, last_sync_error, shipping_rule_ids, org_id, created_at, updated_at].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
+
+    # 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
+
+  end
+
+end