payrix-api-sdk 1.0.0

data/lib/payrix/models/logins_response.rb

@@ -0,0 +1,1188 @@
+# payrix
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payrix
+  # LoginsResponse Model.
+  class LoginsResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The ID of this resource.
+    # @return [String]
+    attr_accessor :id
+
+    # The date and time at which this resource was created. The format should be
+    # YYYY-MM-DD HH:MM:SS.SSSS
+    # @return [String]
+    attr_accessor :created
+
+    # The date and time at which this resource was modified. The format should
+    # be YYYY-MM-DD HH:MM:SS.SSSS
+    # @return [String]
+    attr_accessor :modified
+
+    # The date and time at which this resource was modified. The format should
+    # be YYYY-MM-DD HH:MM:SS.SSSS
+    # @return [Object]
+    attr_accessor :creator
+
+    # The identifier of the Login that last modified this resource.
+    # @return [String]
+    attr_accessor :modifier
+
+    # The identifier of the Login that last modified this resource.
+    # @return [Object]
+    attr_accessor :login
+
+    # The timestamp when this Login last logged in to the API. The format should
+    # be YYYY-MM-DD HH:MM:SS.
+    # @return [String]
+    attr_accessor :last_login
+
+    # The username associated with this Login. 
+    # This field is stored as a text string, all lowercase, and must be between
+    # 0 and 50 characters long.
+    # @return [String]
+    attr_accessor :username
+
+    # The password associated with this Login. 
+    # This field is stored as a text string and must be between 0 and 100
+    # characters long.
+    # @return [String]
+    attr_accessor :password
+
+    # The SSO (Single Sign On) ID setup for the login. 
+    # This field is stored as a text string and must be between 1 and 100
+    # characters long.
+    # @return [String]
+    attr_accessor :sso_id
+
+    # The first name associated with this Login.
+    # @return [String]
+    attr_accessor :first
+
+    # The middle name associated with this Login.
+    # @return [String]
+    attr_accessor :middle
+
+    # The last name associated with this Login.
+    # @return [String]
+    attr_accessor :last
+
+    # The email address associated with this Login.
+    # @return [String]
+    attr_accessor :email
+
+    # The fax number associated with this Login. 
+    # This field is stored as a text string and must be between 10 and 15
+    # characters long.
+    # @return [String]
+    attr_accessor :fax
+
+    # The phone number associated with this Login. 
+    # This field is stored as a text string and must be between 10 and 15
+    # characters long.
+    # @return [String]
+    attr_accessor :phone
+
+    # The country associated with this Customer. 
+    # Valid values for this field is the 3-letter ISO code for the country.
+    # @return [CountryEnum]
+    attr_accessor :country
+
+    # The ZIP code in the address associated with this Login. 
+    # This field is stored as a text string and must be between 1 and 20
+    # characters long.
+    # @return [String]
+    attr_accessor :zip
+
+    # The U.S. state or Canadian province relevant to the address provided here.
+    # If the location is within the U.S. and Canada, specify the 2-character
+    # postal abbreviation for the state. If the location is outside of the U.S.
+    # and Canada, provide the full state name. This field is stored as a text
+    # string and must be between 2 and 100 characters long.
+    #  
+    # <details>
+    # <summary>U.S. States</summary>
+    #  
+    #  - `AK` - **Alaska (US)**
+    #  
+    #  - `AR` - **Arkansas (US)**
+    #  
+    #  - `AL` - **Alabama (US)**
+    #  
+    #  - `AZ` - **Arizona (US)**
+    #  
+    #  - `CA` - **California (US)**
+    #  
+    #  - `CO` - **Colorado (US)**
+    #  
+    #  - `CT` - **Connecticut (US)**
+    #  
+    #  - `DE` - **Delaware (US)**
+    #  
+    #  - `FL` - **Florida (US)**
+    #  
+    #  - `GA` - **Georgia (US)**
+    #  
+    #  - `HI` - **Hawaii (US)**
+    #  
+    #  - `IA` - **Iowa (US)**
+    #  
+    #  - `ID` - **Idaho (US)**
+    #  
+    #  - `IL` - **Illinois (US)**
+    #  
+    #  - `IN` - **Indiana (US)**
+    #  
+    #  - `KY` - **Kentucky (US)**
+    #  
+    #  - `KS` - **Kansas (US)**
+    #  
+    #  - `LA` - **Louisiana (US)**
+    #  
+    #  - `MA` - **Massachusetts (US)**
+    #  
+    #  - `MD` - **Maryland (US)**
+    #  
+    #  - `ME` - **Maine (US)**
+    #  
+    #  - `MI` - **Michigan (US)**
+    #  
+    #  - `MN` - **Minnesota (US)**
+    #  
+    #  - `MO` - **Missouri (US)**
+    #  
+    #  - `MS` - **Mississippi (US)**
+    #  
+    #  - `MT` - **Montana (US)**
+    #  
+    #  - `NC` - **North Carolina (US)**
+    #  
+    #  - `ND` - **North Dakota (US)**
+    #  
+    #  - `NE` - **Nebraska (US)**
+    #  
+    #  - `NH` - **New Hampshire (US)**
+    #  
+    #  - `NJ` - **New Jersey (US)**
+    #  
+    #  - `NM` - **New Mexico (US)**
+    #  
+    #  - `NV` - **Nevada (US)**
+    #  
+    #  - `NY` - **New York (US)**
+    #  
+    #  - `OH` - **Ohio (US)**
+    #  
+    #  - `OK`- **Oklahoma (US)**
+    #  
+    #  - `OR` - **Oregon (US)**
+    #  
+    #  - `PA` - **Pennsylvania (US)**
+    #  
+    #  - `RI` - **Rhode Island (US)**
+    #  
+    #  - `SC`- **South Carolina (US)**
+    #  
+    #  - `SD` - **South Dakota (US)**
+    #  
+    #  - `TN` - **Tennessee (US)**
+    #  
+    #  - `TX` - **Texas (US)**
+    #  
+    #  - `UT` - **Utah (US)**
+    #  
+    #  - `VA` - **Virginia (US)**
+    #  
+    #  - `VT` - **Vermont (US)**
+    #  
+    #  - `WA` - **Washington (US)**
+    #  
+    #  - `WI` - **Wisconsin (US)**
+    #  
+    #  - `WV` - **West Virginia (US)**
+    #  
+    #  - `WY` - **Wyoming (US)**
+    #  </details>
+    #  <details>
+    # <summary>Canada Provinces and Territories</summary>
+    #  
+    #  - `AB` - **Alberta (CAN)**
+    #  
+    #  - `BC` - **British Columbia (CAN)**
+    #  
+    #  - `MB` - **Manitoba (CAN)**
+    #  
+    #  - `ON` - **Ontario (CAN)**
+    #  
+    #  - `NS` - **Nova Scotia (CAN)**
+    #  
+    #  - `NB` - **New Brunswick (CAN)**
+    #  
+    #  - `NL` - **Newfoundland and Labrador (CAN)**
+    #  
+    #  - `NT` - **Northwest Territories (CAN)**
+    #  
+    #  - `NU` - **Nunavut (CAN)**
+    #  
+    #  - `PE` - **Prince Edward Island (CAN)**
+    #  
+    #  - `QC` - **Quebec (CAN)**
+    #  
+    #  - `SK` - **Saskatchewan (CAN)**
+    #  
+    #  - `YT` - **Yukon (CAN)**
+    #  </details>
+    # @return [String]
+    attr_accessor :state
+
+    # The name of the city in the address associated with this Login. 
+    # This field is stored as a text string and must be between 1 and 500
+    # characters long.
+    # @return [String]
+    attr_accessor :city
+
+    # The second line of the address associated with this Login. 
+    # This field is stored as a text string and must be between 1 and 500
+    # characters long.
+    # @return [String]
+    attr_accessor :address2
+
+    # The first line of the address associated with this Login. 
+    # This field is stored as a text string and must be between 1 and 500
+    # characters long.
+    # @return [String]
+    attr_accessor :address1
+
+    # Whether the email associated with this Login was confirmed. This field is
+    # stored as an integer and will be set to '1' when the email is confirmed. 
+    # <details> <summary>Valid Values</summary>
+    #  - `0`  - **Not confirmed.**
+    #  - `1`  - **Confirmed.**
+    #  </details>
+    # @return [ConfirmedEnum]
+    attr_accessor :confirmed
+
+    # The roles associated with this Login, specified as an integer.
+    # @return [Integer]
+    attr_accessor :roles
+
+    # The partition that this Login is associated with.
+    # @return [String]
+    attr_accessor :partition
+
+    # The partition that this Login is associated with.
+    # @return [Object]
+    attr_accessor :division
+
+    # The parent division that this Login belongs to. Children of this Login
+    # will inherit its parent division.
+    # @return [String]
+    attr_accessor :parent_division
+
+    # The allowedResources field specifies the actions and resources a user can
+    # access. The JSON structure includes action keys (create, update, read,
+    # delete, totals) and lists of resources (e.g., logins, apikeys, sessions).
+    # Omitted action keys indicate no access for those actions.
+    # @return [String]
+    attr_accessor :allowed_resources
+
+    # The restrictedResources field defines the actions and resources a user is
+    # restricted from accessing. The JSON structure includes action keys
+    # (create, update, read, delete, totals) and lists of resources (e.g.,
+    # logins, apikeys, sessions). Omitted action keys indicate no restrictions
+    # for those actions.
+    # @return [String]
+    attr_accessor :restricted_resources
+
+    # Whether or not this user should have access to portal functionality. 
+    # <details>
+    # <summary>Valid Values</summary> 
+    #  - `0` - **No access to the portal**
+    #  - `1` - **Has access to the portal**
+    #  </details>
+    # @return [PortalAccessEnum]
+    attr_accessor :portal_access
+
+    # Whether or not this user should have multi factor authentication (MFA)
+    # feature.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Disabled**
+    # - `1` - **Enabled**
+    # </details>
+    # @return [MfaEnabled1Enum]
+    attr_accessor :mfa_enabled
+
+    # The MFA secret key used to link the MFA device with this Login. 
+    # This field is stored as a text string and must be between 1 and 128
+    # characters long.
+    # @return [String]
+    attr_accessor :mfa_secret
+
+    # The datetimestamp  when this Login was enabled for MFA.
+    # @return [String]
+    attr_accessor :mfa_enrolled_date
+
+    # The Type of the MFA enrolled. 
+    # This field is stored as a text string and must be between 1 and 50
+    # characters long.
+    # @return [String]
+    attr_accessor :mfa_type
+
+    # EffectiveRoles is included in the response when a user record is returned
+    # via API indicating the full effective roles of the user (as an integer),
+    # broken down by role, for roles that include other roles automatically.
+    # @return [Integer]
+    attr_accessor :effective_roles
+
+    # The end time of the current MFA SMS window which is a sliding window
+    # limitinig how many codes can be generated during a given window
+    # @return [Integer]
+    attr_accessor :mfa_sms_codes_count
+
+    # The most recent SMS Code which has been texted to the user
+    # @return [Integer]
+    attr_accessor :mfa_sms_window
+
+    # Whether the associated login can use loginAs or not
+    # @return [Integer]
+    attr_accessor :login_as_enabled
+
+    # Whether this resource is marked as inactive.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Active**
+    # - `1` - **Inactive**
+    # </details>
+    # @return [InactiveEnum]
+    attr_accessor :inactive
+
+    # Whether this resource is marked as frozen.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Not Frozen**
+    # - `1` - **Frozen**
+    # </details>
+    # @return [FrozenEnum]
+    attr_accessor :frozen
+
+    # Whether this resource is marked as frozen.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Not Frozen**
+    # - `1` - **Frozen**
+    # </details>
+    # @return [Array[AggregationsResponse]]
+    attr_accessor :aggregations
+
+    # Whether this resource is marked as frozen.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Not Frozen**
+    # - `1` - **Frozen**
+    # </details>
+    # @return [Array[ChangeRequest]]
+    attr_accessor :analyzed_change_requests
+
+    # Whether this resource is marked as frozen.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Not Frozen**
+    # - `1` - **Frozen**
+    # </details>
+    # @return [Array[ChangeRequest]]
+    attr_accessor :change_requests
+
+    # Whether this resource is marked as frozen.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Not Frozen**
+    # - `1` - **Frozen**
+    # </details>
+    # @return [Array[ConfirmCodesResponse]]
+    attr_accessor :confirm_codes
+
+    # Whether this resource is marked as frozen.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Not Frozen**
+    # - `1` - **Frozen**
+    # </details>
+    # @return [Array[CustomersResponse]]
+    attr_accessor :customers
+
+    # Whether this resource is marked as frozen.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Not Frozen**
+    # - `1` - **Frozen**
+    # </details>
+    # @return [Array[BillingsResponse]]
+    attr_accessor :billings
+
+    # Whether this resource is marked as frozen.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Not Frozen**
+    # - `1` - **Frozen**
+    # </details>
+    # @return [Array[DivisionsResponse]]
+    attr_accessor :divisions
+
+    # Whether this resource is marked as frozen.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Not Frozen**
+    # - `1` - **Frozen**
+    # </details>
+    # @return [Array[EntitiesResponse]]
+    attr_accessor :entities
+
+    # Whether this resource is marked as frozen.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Not Frozen**
+    # - `1` - **Frozen**
+    # </details>
+    # @return [Array[EntityReturnsResponse]]
+    attr_accessor :entity_returns
+
+    # Whether this resource is marked as frozen.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Not Frozen**
+    # - `1` - **Frozen**
+    # </details>
+    # @return [Array[InvoicesResponse]]
+    attr_accessor :invoices
+
+    # Whether this resource is marked as frozen.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Not Frozen**
+    # - `1` - **Frozen**
+    # </details>
+    # @return [Array[InvoiceParametersResponse]]
+    attr_accessor :invoice_parameters
+
+    # Whether this resource is marked as frozen.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Not Frozen**
+    # - `1` - **Frozen**
+    # </details>
+    # @return [Array[LoginsResponse]]
+    attr_accessor :logins
+
+    # Whether this resource is marked as frozen.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Not Frozen**
+    # - `1` - **Frozen**
+    # </details>
+    # @return [Array[LoginHelpersResponse]]
+    attr_accessor :logins_helpers
+
+    # Whether this resource is marked as frozen.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Not Frozen**
+    # - `1` - **Frozen**
+    # </details>
+    # @return [Array[NotesResponse]]
+    attr_accessor :notes
+
+    # Whether this resource is marked as frozen.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Not Frozen**
+    # - `1` - **Frozen**
+    # </details>
+    # @return [Array[MessageThreadsResponse]]
+    attr_accessor :message_threads
+
+    # Whether this resource is marked as frozen.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Not Frozen**
+    # - `1` - **Frozen**
+    # </details>
+    # @return [Array[OrgFlowsResponse]]
+    attr_accessor :org_flows
+
+    # Whether this resource is marked as frozen.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Not Frozen**
+    # - `1` - **Frozen**
+    # </details>
+    # @return [Array[OrgFlowsResponse]]
+    attr_accessor :org_flowsforlogin
+
+    # Whether this resource is marked as frozen.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Not Frozen**
+    # - `1` - **Frozen**
+    # </details>
+    # @return [Array[ProfitSharesResponse]]
+    attr_accessor :profit_shares
+
+    # Whether this resource is marked as frozen.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Not Frozen**
+    # - `1` - **Frozen**
+    # </details>
+    # @return [Array[SecretsResponse]]
+    attr_accessor :secrets
+
+    # Whether this resource is marked as frozen.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Not Frozen**
+    # - `1` - **Frozen**
+    # </details>
+    # @return [Array[TeamLoginResponse]]
+    attr_accessor :team_logins
+
+    # Whether this resource is marked as frozen.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Not Frozen**
+    # - `1` - **Frozen**
+    # </details>
+    # @return [Array[TeamsResponse]]
+    attr_accessor :teams
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['created'] = 'created'
+      @_hash['modified'] = 'modified'
+      @_hash['creator'] = 'creator'
+      @_hash['modifier'] = 'modifier'
+      @_hash['login'] = 'login'
+      @_hash['last_login'] = 'lastLogin'
+      @_hash['username'] = 'username'
+      @_hash['password'] = 'password'
+      @_hash['sso_id'] = 'ssoId'
+      @_hash['first'] = 'first'
+      @_hash['middle'] = 'middle'
+      @_hash['last'] = 'last'
+      @_hash['email'] = 'email'
+      @_hash['fax'] = 'fax'
+      @_hash['phone'] = 'phone'
+      @_hash['country'] = 'country'
+      @_hash['zip'] = 'zip'
+      @_hash['state'] = 'state'
+      @_hash['city'] = 'city'
+      @_hash['address2'] = 'address2'
+      @_hash['address1'] = 'address1'
+      @_hash['confirmed'] = 'confirmed'
+      @_hash['roles'] = 'roles'
+      @_hash['partition'] = 'partition'
+      @_hash['division'] = 'division'
+      @_hash['parent_division'] = 'parentDivision'
+      @_hash['allowed_resources'] = 'allowedResources'
+      @_hash['restricted_resources'] = 'restrictedResources'
+      @_hash['portal_access'] = 'portalAccess'
+      @_hash['mfa_enabled'] = 'mfaEnabled'
+      @_hash['mfa_secret'] = 'mfaSecret'
+      @_hash['mfa_enrolled_date'] = 'mfaEnrolledDate'
+      @_hash['mfa_type'] = 'mfaType'
+      @_hash['effective_roles'] = 'effectiveRoles'
+      @_hash['mfa_sms_codes_count'] = 'mfaSmsCodesCount'
+      @_hash['mfa_sms_window'] = 'mfaSmsWindow'
+      @_hash['login_as_enabled'] = 'loginAsEnabled'
+      @_hash['inactive'] = 'inactive'
+      @_hash['frozen'] = 'frozen'
+      @_hash['aggregations'] = 'aggregations'
+      @_hash['analyzed_change_requests'] = 'analyzedChangeRequests'
+      @_hash['change_requests'] = 'changeRequests'
+      @_hash['confirm_codes'] = 'confirmCodes'
+      @_hash['customers'] = 'customers'
+      @_hash['billings'] = 'billings'
+      @_hash['divisions'] = 'divisions'
+      @_hash['entities'] = 'entities'
+      @_hash['entity_returns'] = 'entityReturns'
+      @_hash['invoices'] = 'invoices'
+      @_hash['invoice_parameters'] = 'invoiceParameters'
+      @_hash['logins'] = 'logins'
+      @_hash['logins_helpers'] = 'loginsHelpers'
+      @_hash['notes'] = 'notes'
+      @_hash['message_threads'] = 'messageThreads'
+      @_hash['org_flows'] = 'orgFlows'
+      @_hash['org_flowsforlogin'] = 'orgFlowsforlogin'
+      @_hash['profit_shares'] = 'profitShares'
+      @_hash['secrets'] = 'secrets'
+      @_hash['team_logins'] = 'teamLogins'
+      @_hash['teams'] = 'teams'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        created
+        modified
+        creator
+        modifier
+        login
+        last_login
+        username
+        password
+        sso_id
+        first
+        middle
+        last
+        email
+        fax
+        phone
+        country
+        zip
+        state
+        city
+        address2
+        address1
+        confirmed
+        roles
+        partition
+        division
+        parent_division
+        allowed_resources
+        restricted_resources
+        portal_access
+        mfa_enabled
+        mfa_secret
+        mfa_enrolled_date
+        mfa_type
+        effective_roles
+        mfa_sms_codes_count
+        mfa_sms_window
+        login_as_enabled
+        inactive
+        frozen
+        aggregations
+        analyzed_change_requests
+        change_requests
+        confirm_codes
+        customers
+        billings
+        divisions
+        entities
+        entity_returns
+        invoices
+        invoice_parameters
+        logins
+        logins_helpers
+        notes
+        message_threads
+        org_flows
+        org_flowsforlogin
+        profit_shares
+        secrets
+        team_logins
+        teams
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = SKIP, created = SKIP, modified = SKIP, creator = SKIP,
+                   modifier = SKIP, login = SKIP, last_login = SKIP,
+                   username = SKIP, password = SKIP, sso_id = SKIP,
+                   first = SKIP, middle = SKIP, last = SKIP, email = SKIP,
+                   fax = SKIP, phone = SKIP, country = SKIP, zip = SKIP,
+                   state = SKIP, city = SKIP, address2 = SKIP, address1 = SKIP,
+                   confirmed = SKIP, roles = SKIP, partition = SKIP,
+                   division = SKIP, parent_division = SKIP,
+                   allowed_resources = SKIP, restricted_resources = SKIP,
+                   portal_access = SKIP, mfa_enabled = SKIP, mfa_secret = SKIP,
+                   mfa_enrolled_date = SKIP, mfa_type = SKIP,
+                   effective_roles = SKIP, mfa_sms_codes_count = SKIP,
+                   mfa_sms_window = SKIP, login_as_enabled = SKIP,
+                   inactive = InactiveEnum::ACTIVE,
+                   frozen = FrozenEnum::NOTFROZEN, aggregations = SKIP,
+                   analyzed_change_requests = SKIP, change_requests = SKIP,
+                   confirm_codes = SKIP, customers = SKIP, billings = SKIP,
+                   divisions = SKIP, entities = SKIP, entity_returns = SKIP,
+                   invoices = SKIP, invoice_parameters = SKIP, logins = SKIP,
+                   logins_helpers = SKIP, notes = SKIP, message_threads = SKIP,
+                   org_flows = SKIP, org_flowsforlogin = SKIP,
+                   profit_shares = SKIP, secrets = SKIP, team_logins = SKIP,
+                   teams = SKIP)
+      @id = id unless id == SKIP
+      @created = created unless created == SKIP
+      @modified = modified unless modified == SKIP
+      @creator = creator unless creator == SKIP
+      @modifier = modifier unless modifier == SKIP
+      @login = login unless login == SKIP
+      @last_login = last_login unless last_login == SKIP
+      @username = username unless username == SKIP
+      @password = password unless password == SKIP
+      @sso_id = sso_id unless sso_id == SKIP
+      @first = first unless first == SKIP
+      @middle = middle unless middle == SKIP
+      @last = last unless last == SKIP
+      @email = email unless email == SKIP
+      @fax = fax unless fax == SKIP
+      @phone = phone unless phone == SKIP
+      @country = country unless country == SKIP
+      @zip = zip unless zip == SKIP
+      @state = state unless state == SKIP
+      @city = city unless city == SKIP
+      @address2 = address2 unless address2 == SKIP
+      @address1 = address1 unless address1 == SKIP
+      @confirmed = confirmed unless confirmed == SKIP
+      @roles = roles unless roles == SKIP
+      @partition = partition unless partition == SKIP
+      @division = division unless division == SKIP
+      @parent_division = parent_division unless parent_division == SKIP
+      @allowed_resources = allowed_resources unless allowed_resources == SKIP
+      @restricted_resources = restricted_resources unless restricted_resources == SKIP
+      @portal_access = portal_access unless portal_access == SKIP
+      @mfa_enabled = mfa_enabled unless mfa_enabled == SKIP
+      @mfa_secret = mfa_secret unless mfa_secret == SKIP
+      @mfa_enrolled_date = mfa_enrolled_date unless mfa_enrolled_date == SKIP
+      @mfa_type = mfa_type unless mfa_type == SKIP
+      @effective_roles = effective_roles unless effective_roles == SKIP
+      @mfa_sms_codes_count = mfa_sms_codes_count unless mfa_sms_codes_count == SKIP
+      @mfa_sms_window = mfa_sms_window unless mfa_sms_window == SKIP
+      @login_as_enabled = login_as_enabled unless login_as_enabled == SKIP
+      @inactive = inactive unless inactive == SKIP
+      @frozen = frozen unless frozen == SKIP
+      @aggregations = aggregations unless aggregations == SKIP
+      @analyzed_change_requests = analyzed_change_requests unless analyzed_change_requests == SKIP
+      @change_requests = change_requests unless change_requests == SKIP
+      @confirm_codes = confirm_codes unless confirm_codes == SKIP
+      @customers = customers unless customers == SKIP
+      @billings = billings unless billings == SKIP
+      @divisions = divisions unless divisions == SKIP
+      @entities = entities unless entities == SKIP
+      @entity_returns = entity_returns unless entity_returns == SKIP
+      @invoices = invoices unless invoices == SKIP
+      @invoice_parameters = invoice_parameters unless invoice_parameters == SKIP
+      @logins = logins unless logins == SKIP
+      @logins_helpers = logins_helpers unless logins_helpers == SKIP
+      @notes = notes unless notes == SKIP
+      @message_threads = message_threads unless message_threads == SKIP
+      @org_flows = org_flows unless org_flows == SKIP
+      @org_flowsforlogin = org_flowsforlogin unless org_flowsforlogin == SKIP
+      @profit_shares = profit_shares unless profit_shares == SKIP
+      @secrets = secrets unless secrets == SKIP
+      @team_logins = team_logins unless team_logins == SKIP
+      @teams = teams unless teams == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      id = hash.key?('id') ? hash['id'] : SKIP
+      created = hash.key?('created') ? hash['created'] : SKIP
+      modified = hash.key?('modified') ? hash['modified'] : SKIP
+      creator = hash.key?('creator') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:LoginsResponseCreator), hash['creator']
+      ) : SKIP
+      modifier = hash.key?('modifier') ? hash['modifier'] : SKIP
+      login = hash.key?('login') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:LoginsResponseLogin), hash['login']
+      ) : SKIP
+      last_login = hash.key?('lastLogin') ? hash['lastLogin'] : SKIP
+      username = hash.key?('username') ? hash['username'] : SKIP
+      password = hash.key?('password') ? hash['password'] : SKIP
+      sso_id = hash.key?('ssoId') ? hash['ssoId'] : SKIP
+      first = hash.key?('first') ? hash['first'] : SKIP
+      middle = hash.key?('middle') ? hash['middle'] : SKIP
+      last = hash.key?('last') ? hash['last'] : SKIP
+      email = hash.key?('email') ? hash['email'] : SKIP
+      fax = hash.key?('fax') ? hash['fax'] : SKIP
+      phone = hash.key?('phone') ? hash['phone'] : SKIP
+      country = hash.key?('country') ? hash['country'] : SKIP
+      zip = hash.key?('zip') ? hash['zip'] : SKIP
+      state = hash.key?('state') ? hash['state'] : SKIP
+      city = hash.key?('city') ? hash['city'] : SKIP
+      address2 = hash.key?('address2') ? hash['address2'] : SKIP
+      address1 = hash.key?('address1') ? hash['address1'] : SKIP
+      confirmed = hash.key?('confirmed') ? hash['confirmed'] : SKIP
+      roles = hash.key?('roles') ? hash['roles'] : SKIP
+      partition = hash.key?('partition') ? hash['partition'] : SKIP
+      division = hash.key?('division') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:LoginsResponseDivision), hash['division']
+      ) : SKIP
+      parent_division =
+        hash.key?('parentDivision') ? hash['parentDivision'] : SKIP
+      allowed_resources =
+        hash.key?('allowedResources') ? hash['allowedResources'] : SKIP
+      restricted_resources =
+        hash.key?('restrictedResources') ? hash['restrictedResources'] : SKIP
+      portal_access = hash.key?('portalAccess') ? hash['portalAccess'] : SKIP
+      mfa_enabled = hash.key?('mfaEnabled') ? hash['mfaEnabled'] : SKIP
+      mfa_secret = hash.key?('mfaSecret') ? hash['mfaSecret'] : SKIP
+      mfa_enrolled_date =
+        hash.key?('mfaEnrolledDate') ? hash['mfaEnrolledDate'] : SKIP
+      mfa_type = hash.key?('mfaType') ? hash['mfaType'] : SKIP
+      effective_roles =
+        hash.key?('effectiveRoles') ? hash['effectiveRoles'] : SKIP
+      mfa_sms_codes_count =
+        hash.key?('mfaSmsCodesCount') ? hash['mfaSmsCodesCount'] : SKIP
+      mfa_sms_window = hash.key?('mfaSmsWindow') ? hash['mfaSmsWindow'] : SKIP
+      login_as_enabled =
+        hash.key?('loginAsEnabled') ? hash['loginAsEnabled'] : SKIP
+      inactive = hash['inactive'] ||= InactiveEnum::ACTIVE
+      frozen = hash['frozen'] ||= FrozenEnum::NOTFROZEN
+      # Parameter is an array, so we need to iterate through it
+      aggregations = nil
+      unless hash['aggregations'].nil?
+        aggregations = []
+        hash['aggregations'].each do |structure|
+          aggregations << (AggregationsResponse.from_hash(structure) if structure)
+        end
+      end
+
+      aggregations = SKIP unless hash.key?('aggregations')
+      # Parameter is an array, so we need to iterate through it
+      analyzed_change_requests = nil
+      unless hash['analyzedChangeRequests'].nil?
+        analyzed_change_requests = []
+        hash['analyzedChangeRequests'].each do |structure|
+          analyzed_change_requests << (ChangeRequest.from_hash(structure) if structure)
+        end
+      end
+
+      analyzed_change_requests = SKIP unless hash.key?('analyzedChangeRequests')
+      # Parameter is an array, so we need to iterate through it
+      change_requests = nil
+      unless hash['changeRequests'].nil?
+        change_requests = []
+        hash['changeRequests'].each do |structure|
+          change_requests << (ChangeRequest.from_hash(structure) if structure)
+        end
+      end
+
+      change_requests = SKIP unless hash.key?('changeRequests')
+      # Parameter is an array, so we need to iterate through it
+      confirm_codes = nil
+      unless hash['confirmCodes'].nil?
+        confirm_codes = []
+        hash['confirmCodes'].each do |structure|
+          confirm_codes << (ConfirmCodesResponse.from_hash(structure) if structure)
+        end
+      end
+
+      confirm_codes = SKIP unless hash.key?('confirmCodes')
+      # Parameter is an array, so we need to iterate through it
+      customers = nil
+      unless hash['customers'].nil?
+        customers = []
+        hash['customers'].each do |structure|
+          customers << (CustomersResponse.from_hash(structure) if structure)
+        end
+      end
+
+      customers = SKIP unless hash.key?('customers')
+      # Parameter is an array, so we need to iterate through it
+      billings = nil
+      unless hash['billings'].nil?
+        billings = []
+        hash['billings'].each do |structure|
+          billings << (BillingsResponse.from_hash(structure) if structure)
+        end
+      end
+
+      billings = SKIP unless hash.key?('billings')
+      # Parameter is an array, so we need to iterate through it
+      divisions = nil
+      unless hash['divisions'].nil?
+        divisions = []
+        hash['divisions'].each do |structure|
+          divisions << (DivisionsResponse.from_hash(structure) if structure)
+        end
+      end
+
+      divisions = SKIP unless hash.key?('divisions')
+      # Parameter is an array, so we need to iterate through it
+      entities = nil
+      unless hash['entities'].nil?
+        entities = []
+        hash['entities'].each do |structure|
+          entities << (EntitiesResponse.from_hash(structure) if structure)
+        end
+      end
+
+      entities = SKIP unless hash.key?('entities')
+      # Parameter is an array, so we need to iterate through it
+      entity_returns = nil
+      unless hash['entityReturns'].nil?
+        entity_returns = []
+        hash['entityReturns'].each do |structure|
+          entity_returns << (EntityReturnsResponse.from_hash(structure) if structure)
+        end
+      end
+
+      entity_returns = SKIP unless hash.key?('entityReturns')
+      # Parameter is an array, so we need to iterate through it
+      invoices = nil
+      unless hash['invoices'].nil?
+        invoices = []
+        hash['invoices'].each do |structure|
+          invoices << (InvoicesResponse.from_hash(structure) if structure)
+        end
+      end
+
+      invoices = SKIP unless hash.key?('invoices')
+      # Parameter is an array, so we need to iterate through it
+      invoice_parameters = nil
+      unless hash['invoiceParameters'].nil?
+        invoice_parameters = []
+        hash['invoiceParameters'].each do |structure|
+          invoice_parameters << (InvoiceParametersResponse.from_hash(structure) if structure)
+        end
+      end
+
+      invoice_parameters = SKIP unless hash.key?('invoiceParameters')
+      # Parameter is an array, so we need to iterate through it
+      logins = nil
+      unless hash['logins'].nil?
+        logins = []
+        hash['logins'].each do |structure|
+          logins << (LoginsResponse.from_hash(structure) if structure)
+        end
+      end
+
+      logins = SKIP unless hash.key?('logins')
+      # Parameter is an array, so we need to iterate through it
+      logins_helpers = nil
+      unless hash['loginsHelpers'].nil?
+        logins_helpers = []
+        hash['loginsHelpers'].each do |structure|
+          logins_helpers << (LoginHelpersResponse.from_hash(structure) if structure)
+        end
+      end
+
+      logins_helpers = SKIP unless hash.key?('loginsHelpers')
+      # Parameter is an array, so we need to iterate through it
+      notes = nil
+      unless hash['notes'].nil?
+        notes = []
+        hash['notes'].each do |structure|
+          notes << (NotesResponse.from_hash(structure) if structure)
+        end
+      end
+
+      notes = SKIP unless hash.key?('notes')
+      # Parameter is an array, so we need to iterate through it
+      message_threads = nil
+      unless hash['messageThreads'].nil?
+        message_threads = []
+        hash['messageThreads'].each do |structure|
+          message_threads << (MessageThreadsResponse.from_hash(structure) if structure)
+        end
+      end
+
+      message_threads = SKIP unless hash.key?('messageThreads')
+      # Parameter is an array, so we need to iterate through it
+      org_flows = nil
+      unless hash['orgFlows'].nil?
+        org_flows = []
+        hash['orgFlows'].each do |structure|
+          org_flows << (OrgFlowsResponse.from_hash(structure) if structure)
+        end
+      end
+
+      org_flows = SKIP unless hash.key?('orgFlows')
+      # Parameter is an array, so we need to iterate through it
+      org_flowsforlogin = nil
+      unless hash['orgFlowsforlogin'].nil?
+        org_flowsforlogin = []
+        hash['orgFlowsforlogin'].each do |structure|
+          org_flowsforlogin << (OrgFlowsResponse.from_hash(structure) if structure)
+        end
+      end
+
+      org_flowsforlogin = SKIP unless hash.key?('orgFlowsforlogin')
+      # Parameter is an array, so we need to iterate through it
+      profit_shares = nil
+      unless hash['profitShares'].nil?
+        profit_shares = []
+        hash['profitShares'].each do |structure|
+          profit_shares << (ProfitSharesResponse.from_hash(structure) if structure)
+        end
+      end
+
+      profit_shares = SKIP unless hash.key?('profitShares')
+      # Parameter is an array, so we need to iterate through it
+      secrets = nil
+      unless hash['secrets'].nil?
+        secrets = []
+        hash['secrets'].each do |structure|
+          secrets << (SecretsResponse.from_hash(structure) if structure)
+        end
+      end
+
+      secrets = SKIP unless hash.key?('secrets')
+      # Parameter is an array, so we need to iterate through it
+      team_logins = nil
+      unless hash['teamLogins'].nil?
+        team_logins = []
+        hash['teamLogins'].each do |structure|
+          team_logins << (TeamLoginResponse.from_hash(structure) if structure)
+        end
+      end
+
+      team_logins = SKIP unless hash.key?('teamLogins')
+      # Parameter is an array, so we need to iterate through it
+      teams = nil
+      unless hash['teams'].nil?
+        teams = []
+        hash['teams'].each do |structure|
+          teams << (TeamsResponse.from_hash(structure) if structure)
+        end
+      end
+
+      teams = SKIP unless hash.key?('teams')
+
+      # Create object from extracted values.
+      LoginsResponse.new(id,
+                         created,
+                         modified,
+                         creator,
+                         modifier,
+                         login,
+                         last_login,
+                         username,
+                         password,
+                         sso_id,
+                         first,
+                         middle,
+                         last,
+                         email,
+                         fax,
+                         phone,
+                         country,
+                         zip,
+                         state,
+                         city,
+                         address2,
+                         address1,
+                         confirmed,
+                         roles,
+                         partition,
+                         division,
+                         parent_division,
+                         allowed_resources,
+                         restricted_resources,
+                         portal_access,
+                         mfa_enabled,
+                         mfa_secret,
+                         mfa_enrolled_date,
+                         mfa_type,
+                         effective_roles,
+                         mfa_sms_codes_count,
+                         mfa_sms_window,
+                         login_as_enabled,
+                         inactive,
+                         frozen,
+                         aggregations,
+                         analyzed_change_requests,
+                         change_requests,
+                         confirm_codes,
+                         customers,
+                         billings,
+                         divisions,
+                         entities,
+                         entity_returns,
+                         invoices,
+                         invoice_parameters,
+                         logins,
+                         logins_helpers,
+                         notes,
+                         message_threads,
+                         org_flows,
+                         org_flowsforlogin,
+                         profit_shares,
+                         secrets,
+                         team_logins,
+                         teams)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [LoginsResponse | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, created: #{@created}, modified: #{@modified}, creator:"\
+      " #{@creator}, modifier: #{@modifier}, login: #{@login}, last_login: #{@last_login},"\
+      " username: #{@username}, password: #{@password}, sso_id: #{@sso_id}, first: #{@first},"\
+      " middle: #{@middle}, last: #{@last}, email: #{@email}, fax: #{@fax}, phone: #{@phone},"\
+      " country: #{@country}, zip: #{@zip}, state: #{@state}, city: #{@city}, address2:"\
+      " #{@address2}, address1: #{@address1}, confirmed: #{@confirmed}, roles: #{@roles},"\
+      " partition: #{@partition}, division: #{@division}, parent_division: #{@parent_division},"\
+      " allowed_resources: #{@allowed_resources}, restricted_resources: #{@restricted_resources},"\
+      " portal_access: #{@portal_access}, mfa_enabled: #{@mfa_enabled}, mfa_secret:"\
+      " #{@mfa_secret}, mfa_enrolled_date: #{@mfa_enrolled_date}, mfa_type: #{@mfa_type},"\
+      " effective_roles: #{@effective_roles}, mfa_sms_codes_count: #{@mfa_sms_codes_count},"\
+      " mfa_sms_window: #{@mfa_sms_window}, login_as_enabled: #{@login_as_enabled}, inactive:"\
+      " #{@inactive}, frozen: #{@frozen}, aggregations: #{@aggregations},"\
+      " analyzed_change_requests: #{@analyzed_change_requests}, change_requests:"\
+      " #{@change_requests}, confirm_codes: #{@confirm_codes}, customers: #{@customers}, billings:"\
+      " #{@billings}, divisions: #{@divisions}, entities: #{@entities}, entity_returns:"\
+      " #{@entity_returns}, invoices: #{@invoices}, invoice_parameters: #{@invoice_parameters},"\
+      " logins: #{@logins}, logins_helpers: #{@logins_helpers}, notes: #{@notes}, message_threads:"\
+      " #{@message_threads}, org_flows: #{@org_flows}, org_flowsforlogin: #{@org_flowsforlogin},"\
+      " profit_shares: #{@profit_shares}, secrets: #{@secrets}, team_logins: #{@team_logins},"\
+      " teams: #{@teams}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, created: #{@created.inspect}, modified:"\
+      " #{@modified.inspect}, creator: #{@creator.inspect}, modifier: #{@modifier.inspect}, login:"\
+      " #{@login.inspect}, last_login: #{@last_login.inspect}, username: #{@username.inspect},"\
+      " password: #{@password.inspect}, sso_id: #{@sso_id.inspect}, first: #{@first.inspect},"\
+      " middle: #{@middle.inspect}, last: #{@last.inspect}, email: #{@email.inspect}, fax:"\
+      " #{@fax.inspect}, phone: #{@phone.inspect}, country: #{@country.inspect}, zip:"\
+      " #{@zip.inspect}, state: #{@state.inspect}, city: #{@city.inspect}, address2:"\
+      " #{@address2.inspect}, address1: #{@address1.inspect}, confirmed: #{@confirmed.inspect},"\
+      " roles: #{@roles.inspect}, partition: #{@partition.inspect}, division:"\
+      " #{@division.inspect}, parent_division: #{@parent_division.inspect}, allowed_resources:"\
+      " #{@allowed_resources.inspect}, restricted_resources: #{@restricted_resources.inspect},"\
+      " portal_access: #{@portal_access.inspect}, mfa_enabled: #{@mfa_enabled.inspect},"\
+      " mfa_secret: #{@mfa_secret.inspect}, mfa_enrolled_date: #{@mfa_enrolled_date.inspect},"\
+      " mfa_type: #{@mfa_type.inspect}, effective_roles: #{@effective_roles.inspect},"\
+      " mfa_sms_codes_count: #{@mfa_sms_codes_count.inspect}, mfa_sms_window:"\
+      " #{@mfa_sms_window.inspect}, login_as_enabled: #{@login_as_enabled.inspect}, inactive:"\
+      " #{@inactive.inspect}, frozen: #{@frozen.inspect}, aggregations: #{@aggregations.inspect},"\
+      " analyzed_change_requests: #{@analyzed_change_requests.inspect}, change_requests:"\
+      " #{@change_requests.inspect}, confirm_codes: #{@confirm_codes.inspect}, customers:"\
+      " #{@customers.inspect}, billings: #{@billings.inspect}, divisions: #{@divisions.inspect},"\
+      " entities: #{@entities.inspect}, entity_returns: #{@entity_returns.inspect}, invoices:"\
+      " #{@invoices.inspect}, invoice_parameters: #{@invoice_parameters.inspect}, logins:"\
+      " #{@logins.inspect}, logins_helpers: #{@logins_helpers.inspect}, notes: #{@notes.inspect},"\
+      " message_threads: #{@message_threads.inspect}, org_flows: #{@org_flows.inspect},"\
+      " org_flowsforlogin: #{@org_flowsforlogin.inspect}, profit_shares:"\
+      " #{@profit_shares.inspect}, secrets: #{@secrets.inspect}, team_logins:"\
+      " #{@team_logins.inspect}, teams: #{@teams.inspect}>"
+    end
+  end
+end