payrix-api-sdk 1.0.0

data/lib/payrix/models/logins_post_request.rb

@@ -0,0 +1,975 @@
+# payrix
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payrix
+  # LoginsPostRequest Model.
+  class LoginsPostRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The parent user that owns this user. Defaults to authenticated user’s ID
+    # if no value is explicitly set.
+    # @return [String]
+    attr_accessor :login
+
+    # The partition that this Login is associated with. The partition
+    # association is required and opens access to partition-level administrators
+    # on this user and all records owned by this user. Defaults to authenticated
+    # user’s partition if no value is explicitly set.
+    # @return [String]
+    attr_accessor :partition
+
+    # The partition that this Login is associated with. The partition
+    # association is required and opens access to partition-level administrators
+    # on this user and all records owned by this user. Defaults to authenticated
+    # user’s partition if no value is explicitly set.
+    # @return [Object]
+    attr_accessor :division
+
+    # The parent division that this Login belongs to. Children of this Login
+    # will inherit its parent division. The parentDivision association may be
+    # used for whitelabeling the user experience for parent divisions that have
+    # implemented a whitelabel solution (as long as the child division that the
+    # user is associated with has not implemented their own). Defaults to
+    # authenticated user’s parentDivision if no value is explicitly set.
+    # @return [String]
+    attr_accessor :parent_division
+
+    # The roles associated with this Login, specified as an integer. <details>
+    # <summary>Single Roles- Valid Values</summary> <ul> <li><code>16</code> -
+    # Entity</li> <li><code>64</code> - Vendor</li> <li><code>128</code> -
+    # Merchant</li> <li><code>256</code> - Create Merchant</li>
+    # <li><code>512</code> - Password</li> <li><code>1024</code> - Log</li>
+    # <li><code>2048</code> - Unfreeze</li> <li><code>4096</code> - Modify
+    # Roles</li> <li><code>8192</code> - Payment IDs</li> <li><code>65536</code>
+    # - MCC</li> <li><code>131072</code> - TXN Report</li>
+    # <li><code>262144</code> - Disbursement</li> <li><code>524288</code> - Fund
+    # Reserve</li> <li><code>1048576</code> - Platform Refs</li>
+    # <li><code>2097152</code> - Verification</li> <li><code>4194304</code> -
+    # Fee</li> <li><code>8388608</code> - Challenge</li>
+    # <li><code>16777216</code> - Reserve TXN</li> <li><code>33554432</code> -
+    # Set Boarded</li> <li><code>67108864</code> - Assessment</li>
+    # <li><code>134217728</code> - Adjustment</li> <li><code>268435456</code> -
+    # Merchant Flow</li> <li><code>1073741824</code> - Confirm Email</li>
+    # <li><code>2147483648</code> - TIN Status</li> <li><code>4294967296</code>
+    # - Entity Route</li> <li><code>8589934592</code> - Files</li>
+    # <li><code>17179869184</code> - Unmask Private</li>
+    # <li><code>34359738368</code> - Unmask Bank</li>
+    # <li><code>68719476736</code> - Thread Create</li>
+    # <li><code>137438953472</code> - BIN Query</li>
+    # <li><code>274877906944</code> - BIN Change</li>
+    # <li><code>1099511627776</code> - Assessment View</li>
+    # <li><code>17592186044416</code> - Entity Return</li>
+    # <li><code>70368744177664</code> - Watchlist</li>
+    # <li><code>140737488355328</code> - Profit Share</li>
+    # <li><code>281474976710656</code> - MFA</li> </ul> </details> <details>
+    # <summary>Multi-Roles- Valid Values</summary> <ul> <li><code>144</code> -
+    # Entity, Merchant</li> <li><code>192</code> - Vendor, Merchant</li>
+    # <li><code>208</code> - Entity, Vendor, Merchant</li> <li><code>320</code>
+    # - Vendor, Create Merchant</li> <li><code>384</code> - Merchant, Create
+    # Merchant</li> <li><code>400</code> - Entity, Merchant, Create
+    # Merchant</li> <li><code>131136</code> - Vendor, TXN Report</li>
+    # <li><code>131200</code> - Merchant, TXN Report</li>
+    # <li><code>131456</code> - Merchant, Create Merchant, TXN Report</li>
+    # <li><code>1048640</code> - Vendor, Platform Refs</li>
+    # <li><code>1048704</code> - Merchant, Platform Refs</li>
+    # <li><code>1048768</code> - Vendor, Merchant, Platform Refs</li>
+    # <li><code>2097216</code> - Vendor, Verification</li>
+    # <li><code>4194368</code> - Vendor, Fee</li> <li><code>4194384</code> -
+    # Entity, Vendor, Fee</li> <li><code>134217792</code> - Vendor,
+    # Adjustment</li> <li><code>268435584</code> - Merchant, Merchant Flow</li>
+    # <li><code>272630160</code> - Entity, Merchant, Create Merchant, Fee,
+    # Merchant Flow</li> <li><code>272630224</code> - Entity, Vendor, Merchant,
+    # Create Merchant, Fee, Merchant Flow</li> <li><code>273154512</code> -
+    # Entity, Vendor, Merchant, Create Merchant, Fund Reserve, Fee, Merchant
+    # Flow</li> <li><code>1099511627840</code> - Vendor, Assessment View</li>
+    # <li><code>1099511758912</code> - Vendor, TXN Report, Assessment View</li>
+    # </ul> </details>
+    # @return [Integer]
+    attr_accessor :roles
+
+    # 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 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 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. <details>
+    # <summary>Instructions</summary> In addition to the roles for this login,
+    # you can specify API functionality by creating a JSON object as the value
+    # for this field using with data arrays titled: <code>”create”: []</code>,
+    # <code>”read”: []</code>, <code>”update”: []</code>, <code>”delete”:
+    # []</code>, and <code>”totals”: []</code> for their API CRUD functions
+    # <code>POST</code>, <code>GET</code>, <code>PUT</code>, <code>DELETE</code>
+    # with the <code>totals</code> array setting users ability to calculate and
+    # report on disbursements, funds, and other monetary totals relevant to the
+    # specified endpoint resources. Add the names of each endpoint resource
+    # separated by a comma (<code>,</code>) for which you want to provide
+    # functionality.
+    # For example, <code>{ "create": ["payouts"] }</code> allows this login to
+    # create payout transactions using the <code>POST /payouts</code> API
+    # request method.
+    # <ul> <li><strong>Note:</strong> Resources are case sensitive. Our API uses
+    # <a href="https://en.wikipedia.org/wiki/Camel_case">camelCase</a>. If you
+    # are unsure of formatting, refer to the API specification to copy the exact
+    # endpoint title without the initial forward slash ( / ) for the relevant
+    # allowedResources or restrictedResources arrays.</li> </ul>
+    # </details>
+    # @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. <details> <summary>Instructions</summary> In addition
+    # to the roles for this login, you can specify API functionality by creating
+    # a JSON object as the value for this field using with data arrays titled:
+    # <code>”create”: []</code>, <code>”read”: []</code>, <code>”update”:
+    # []</code>, <code>”delete”: []</code>, and <code>”totals”: []</code> for
+    # their API CRUD functions <code>POST</code>, <code>GET</code>,
+    # <code>PUT</code>, <code>DELETE</code> with the <code>totals</code> array
+    # setting users ability to calculate and report on disbursements, funds, and
+    # other monetary totals relevant to the specified endpoint resources. Add
+    # the names of each endpoint resource separated by a comma (<code>,</code>)
+    # for which you want to provide functionality.
+    # For example, <code>{ "create": ["payouts"] }</code> allows this login to
+    # create payout transactions using the <code>POST /payouts</code> API
+    # request method.
+    # <ul> <li><strong>Note:</strong> Resources are case sensitive. Our API uses
+    # <a href="https://en.wikipedia.org/wiki/Camel_case">camelCase</a>. If you
+    # are unsure of formatting, refer to the API specification to copy the exact
+    # endpoint title without the initial forward slash ( / ) for the relevant
+    # allowedResources or restrictedResources arrays.</li> </ul>
+    # </details>
+    # @return [String]
+    attr_accessor :restricted_resources
+
+    # Whether or not this user should have access to portal functionality.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **No Portal access.** 
+    # - `1` - **Portal access.**
+    # </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
+
+    # 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
+
+    # 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 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 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 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 country associated with this Customer/InvoiceResult, valid values for
+    # this field are the 3-letter ISO code for the country.
+    # @return [CountryEnum]
+    attr_accessor :country
+
+    # 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 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
+
+    # 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[AggregationsPostRequest]]
+    attr_accessor :aggregations
+
+    # Whether this resource is marked as frozen.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Not Frozen**
+    # - `1` - **Frozen**
+    # </details>
+    # @return [Array[CustomersPostRequest]]
+    attr_accessor :customers
+
+    # Whether this resource is marked as frozen.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Not Frozen**
+    # - `1` - **Frozen**
+    # </details>
+    # @return [Array[BillingsPostRequest]]
+    attr_accessor :billings
+
+    # Whether this resource is marked as frozen.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Not Frozen**
+    # - `1` - **Frozen**
+    # </details>
+    # @return [Array[DivisionsPostRequest]]
+    attr_accessor :divisions
+
+    # Whether this resource is marked as frozen.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Not Frozen**
+    # - `1` - **Frozen**
+    # </details>
+    # @return [Array[EntitiesPostRequest]]
+    attr_accessor :entities
+
+    # Whether this resource is marked as frozen.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Not Frozen**
+    # - `1` - **Frozen**
+    # </details>
+    # @return [Array[InvoiceParametersPostRequest]]
+    attr_accessor :invoice_parameters
+
+    # Whether this resource is marked as frozen.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Not Frozen**
+    # - `1` - **Frozen**
+    # </details>
+    # @return [Array[MessageThreadsPostRequest]]
+    attr_accessor :message_threads
+
+    # Whether this resource is marked as frozen.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Not Frozen**
+    # - `1` - **Frozen**
+    # </details>
+    # @return [Array[NotesPostRequest]]
+    attr_accessor :notes
+
+    # Whether this resource is marked as frozen.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Not Frozen**
+    # - `1` - **Frozen**
+    # </details>
+    # @return [Array[OrgFlowsPostRequest]]
+    attr_accessor :org_flows
+
+    # Whether this resource is marked as frozen.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Not Frozen**
+    # - `1` - **Frozen**
+    # </details>
+    # @return [Array[OrgFlowsPostRequest]]
+    attr_accessor :org_flowsforlogin
+
+    # Whether this resource is marked as frozen.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Not Frozen**
+    # - `1` - **Frozen**
+    # </details>
+    # @return [Array[ProfitSharesPostRequest]]
+    attr_accessor :profit_shares
+
+    # Whether this resource is marked as frozen.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Not Frozen**
+    # - `1` - **Frozen**
+    # </details>
+    # @return [Array[TeamLoginPostRequest]]
+    attr_accessor :team_logins
+
+    # Whether this resource is marked as frozen.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Not Frozen**
+    # - `1` - **Frozen**
+    # </details>
+    # @return [Array[TeamsPostRequest]]
+    attr_accessor :teams
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['login'] = 'login'
+      @_hash['partition'] = 'partition'
+      @_hash['division'] = 'division'
+      @_hash['parent_division'] = 'parentDivision'
+      @_hash['roles'] = 'roles'
+      @_hash['username'] = 'username'
+      @_hash['password'] = 'password'
+      @_hash['first'] = 'first'
+      @_hash['middle'] = 'middle'
+      @_hash['last'] = 'last'
+      @_hash['email'] = 'email'
+      @_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['address1'] = 'address1'
+      @_hash['address2'] = 'address2'
+      @_hash['city'] = 'city'
+      @_hash['state'] = 'state'
+      @_hash['zip'] = 'zip'
+      @_hash['country'] = 'country'
+      @_hash['phone'] = 'phone'
+      @_hash['fax'] = 'fax'
+      @_hash['inactive'] = 'inactive'
+      @_hash['frozen'] = 'frozen'
+      @_hash['aggregations'] = 'aggregations'
+      @_hash['customers'] = 'customers'
+      @_hash['billings'] = 'billings'
+      @_hash['divisions'] = 'divisions'
+      @_hash['entities'] = 'entities'
+      @_hash['invoice_parameters'] = 'invoiceParameters'
+      @_hash['message_threads'] = 'messageThreads'
+      @_hash['notes'] = 'notes'
+      @_hash['org_flows'] = 'orgFlows'
+      @_hash['org_flowsforlogin'] = 'orgFlowsforlogin'
+      @_hash['profit_shares'] = 'profitShares'
+      @_hash['team_logins'] = 'teamLogins'
+      @_hash['teams'] = 'teams'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        login
+        division
+        parent_division
+        roles
+        middle
+        allowed_resources
+        restricted_resources
+        portal_access
+        mfa_secret
+        mfa_enrolled_date
+        mfa_type
+        address1
+        address2
+        city
+        state
+        zip
+        country
+        phone
+        fax
+        inactive
+        frozen
+        aggregations
+        customers
+        billings
+        divisions
+        entities
+        invoice_parameters
+        message_threads
+        notes
+        org_flows
+        org_flowsforlogin
+        profit_shares
+        team_logins
+        teams
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(partition = nil, username = nil, password = nil, first = nil,
+                   last = nil, email = nil, mfa_enabled = nil, login = SKIP,
+                   division = SKIP, parent_division = SKIP, roles = 0,
+                   middle = SKIP, allowed_resources = SKIP,
+                   restricted_resources = SKIP,
+                   portal_access = PortalAccessEnum::HASACCESS,
+                   mfa_secret = SKIP, mfa_enrolled_date = SKIP, mfa_type = SKIP,
+                   address1 = SKIP, address2 = SKIP, city = SKIP, state = SKIP,
+                   zip = SKIP, country = SKIP, phone = SKIP, fax = SKIP,
+                   inactive = InactiveEnum::ACTIVE,
+                   frozen = FrozenEnum::NOTFROZEN, aggregations = SKIP,
+                   customers = SKIP, billings = SKIP, divisions = SKIP,
+                   entities = SKIP, invoice_parameters = SKIP,
+                   message_threads = SKIP, notes = SKIP, org_flows = SKIP,
+                   org_flowsforlogin = SKIP, profit_shares = SKIP,
+                   team_logins = SKIP, teams = SKIP)
+      @login = login unless login == SKIP
+      @partition = partition
+      @division = division unless division == SKIP
+      @parent_division = parent_division unless parent_division == SKIP
+      @roles = roles unless roles == SKIP
+      @username = username
+      @password = password
+      @first = first
+      @middle = middle unless middle == SKIP
+      @last = last
+      @email = email
+      @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
+      @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
+      @address1 = address1 unless address1 == SKIP
+      @address2 = address2 unless address2 == SKIP
+      @city = city unless city == SKIP
+      @state = state unless state == SKIP
+      @zip = zip unless zip == SKIP
+      @country = country unless country == SKIP
+      @phone = phone unless phone == SKIP
+      @fax = fax unless fax == SKIP
+      @inactive = inactive unless inactive == SKIP
+      @frozen = frozen unless frozen == SKIP
+      @aggregations = aggregations unless aggregations == SKIP
+      @customers = customers unless customers == SKIP
+      @billings = billings unless billings == SKIP
+      @divisions = divisions unless divisions == SKIP
+      @entities = entities unless entities == SKIP
+      @invoice_parameters = invoice_parameters unless invoice_parameters == SKIP
+      @message_threads = message_threads unless message_threads == SKIP
+      @notes = notes unless notes == 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
+      @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.
+      partition = hash.key?('partition') ? hash['partition'] : nil
+      username = hash.key?('username') ? hash['username'] : nil
+      password = hash.key?('password') ? hash['password'] : nil
+      first = hash.key?('first') ? hash['first'] : nil
+      last = hash.key?('last') ? hash['last'] : nil
+      email = hash.key?('email') ? hash['email'] : nil
+      mfa_enabled = hash.key?('mfaEnabled') ? hash['mfaEnabled'] : nil
+      login = hash.key?('login') ? hash['login'] : SKIP
+      division = hash.key?('division') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:LoginsPostRequestDivision), hash['division']
+      ) : SKIP
+      parent_division =
+        hash.key?('parentDivision') ? hash['parentDivision'] : SKIP
+      roles = hash['roles'] ||= 0
+      middle = hash.key?('middle') ? hash['middle'] : SKIP
+      allowed_resources =
+        hash.key?('allowedResources') ? hash['allowedResources'] : SKIP
+      restricted_resources =
+        hash.key?('restrictedResources') ? hash['restrictedResources'] : SKIP
+      portal_access = hash['portalAccess'] ||= PortalAccessEnum::HASACCESS
+      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
+      address1 = hash.key?('address1') ? hash['address1'] : SKIP
+      address2 = hash.key?('address2') ? hash['address2'] : SKIP
+      city = hash.key?('city') ? hash['city'] : SKIP
+      state = hash.key?('state') ? hash['state'] : SKIP
+      zip = hash.key?('zip') ? hash['zip'] : SKIP
+      country = hash.key?('country') ? hash['country'] : SKIP
+      phone = hash.key?('phone') ? hash['phone'] : SKIP
+      fax = hash.key?('fax') ? hash['fax'] : 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 << (AggregationsPostRequest.from_hash(structure) if structure)
+        end
+      end
+
+      aggregations = SKIP unless hash.key?('aggregations')
+      # Parameter is an array, so we need to iterate through it
+      customers = nil
+      unless hash['customers'].nil?
+        customers = []
+        hash['customers'].each do |structure|
+          customers << (CustomersPostRequest.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 << (BillingsPostRequest.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 << (DivisionsPostRequest.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 << (EntitiesPostRequest.from_hash(structure) if structure)
+        end
+      end
+
+      entities = SKIP unless hash.key?('entities')
+      # 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 << (InvoiceParametersPostRequest.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
+      message_threads = nil
+      unless hash['messageThreads'].nil?
+        message_threads = []
+        hash['messageThreads'].each do |structure|
+          message_threads << (MessageThreadsPostRequest.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
+      notes = nil
+      unless hash['notes'].nil?
+        notes = []
+        hash['notes'].each do |structure|
+          notes << (NotesPostRequest.from_hash(structure) if structure)
+        end
+      end
+
+      notes = SKIP unless hash.key?('notes')
+      # 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 << (OrgFlowsPostRequest.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 << (OrgFlowsPostRequest.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 << (ProfitSharesPostRequest.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
+      team_logins = nil
+      unless hash['teamLogins'].nil?
+        team_logins = []
+        hash['teamLogins'].each do |structure|
+          team_logins << (TeamLoginPostRequest.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 << (TeamsPostRequest.from_hash(structure) if structure)
+        end
+      end
+
+      teams = SKIP unless hash.key?('teams')
+
+      # Create object from extracted values.
+      LoginsPostRequest.new(partition,
+                            username,
+                            password,
+                            first,
+                            last,
+                            email,
+                            mfa_enabled,
+                            login,
+                            division,
+                            parent_division,
+                            roles,
+                            middle,
+                            allowed_resources,
+                            restricted_resources,
+                            portal_access,
+                            mfa_secret,
+                            mfa_enrolled_date,
+                            mfa_type,
+                            address1,
+                            address2,
+                            city,
+                            state,
+                            zip,
+                            country,
+                            phone,
+                            fax,
+                            inactive,
+                            frozen,
+                            aggregations,
+                            customers,
+                            billings,
+                            divisions,
+                            entities,
+                            invoice_parameters,
+                            message_threads,
+                            notes,
+                            org_flows,
+                            org_flowsforlogin,
+                            profit_shares,
+                            team_logins,
+                            teams)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [LoginsPostRequest | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.partition,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.username,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.password,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.first,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.last,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.email,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.mfa_enabled,
+                                  ->(val) { MfaEnabled1Enum.validate(val) })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['partition'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['username'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['password'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['first'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['last'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['email'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['mfaEnabled'],
+                                ->(val) { MfaEnabled1Enum.validate(val) })
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} login: #{@login}, partition: #{@partition}, division: #{@division},"\
+      " parent_division: #{@parent_division}, roles: #{@roles}, username: #{@username}, password:"\
+      " #{@password}, first: #{@first}, middle: #{@middle}, last: #{@last}, email: #{@email},"\
+      " 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},"\
+      " address1: #{@address1}, address2: #{@address2}, city: #{@city}, state: #{@state}, zip:"\
+      " #{@zip}, country: #{@country}, phone: #{@phone}, fax: #{@fax}, inactive: #{@inactive},"\
+      " frozen: #{@frozen}, aggregations: #{@aggregations}, customers: #{@customers}, billings:"\
+      " #{@billings}, divisions: #{@divisions}, entities: #{@entities}, invoice_parameters:"\
+      " #{@invoice_parameters}, message_threads: #{@message_threads}, notes: #{@notes}, org_flows:"\
+      " #{@org_flows}, org_flowsforlogin: #{@org_flowsforlogin}, profit_shares: #{@profit_shares},"\
+      " 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} login: #{@login.inspect}, partition: #{@partition.inspect}, division:"\
+      " #{@division.inspect}, parent_division: #{@parent_division.inspect}, roles:"\
+      " #{@roles.inspect}, username: #{@username.inspect}, password: #{@password.inspect}, first:"\
+      " #{@first.inspect}, middle: #{@middle.inspect}, last: #{@last.inspect}, email:"\
+      " #{@email.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}, address1:"\
+      " #{@address1.inspect}, address2: #{@address2.inspect}, city: #{@city.inspect}, state:"\
+      " #{@state.inspect}, zip: #{@zip.inspect}, country: #{@country.inspect}, phone:"\
+      " #{@phone.inspect}, fax: #{@fax.inspect}, inactive: #{@inactive.inspect}, frozen:"\
+      " #{@frozen.inspect}, aggregations: #{@aggregations.inspect}, customers:"\
+      " #{@customers.inspect}, billings: #{@billings.inspect}, divisions: #{@divisions.inspect},"\
+      " entities: #{@entities.inspect}, invoice_parameters: #{@invoice_parameters.inspect},"\
+      " message_threads: #{@message_threads.inspect}, notes: #{@notes.inspect}, org_flows:"\
+      " #{@org_flows.inspect}, org_flowsforlogin: #{@org_flowsforlogin.inspect}, profit_shares:"\
+      " #{@profit_shares.inspect}, team_logins: #{@team_logins.inspect}, teams:"\
+      " #{@teams.inspect}>"
+    end
+  end
+end