openapi: 3.2.0
info:
  title: NewSkies-Digital-Api Users API
  version: 4.8.6.23
  description: Navitaire Digital Api
servers:
- url: https://prod.api.tui/flight/newskies/rest
  description: TUI Prod
- url: https://playground.api.tui/flight/newskies/rest
  description: TUI Playground
security:
- JWT: []
tags:
- name: users
paths:
  /api/nsk/v1/users:
    post:
      tags:
      - users
      summary: Creates a new user and person (used by agents to create other users).
      description: 'This method is used by agents to create other users (either agents or customers).

        Use this method when you want to create both a user and a person at the same time.


        GraphQL endpoint: usersAdd'
      operationId: nsk_v1_users_post
      requestBody:
        x-name: request
        description: The new user request.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserCreateRequest'
        required: true
        x-position: 1
      responses:
        '201':
          description: The item was created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '400':
          description: There was a problem with the request and it could not be completed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
              examples:
                With Duplicate Agent Name:
                  description: The agent name already exists.
                  value:
                    errors:
                    - id: 5d7a5d1c-d481-9723-260d-59f53b861112
                      code: nsk:User:UserNameAlreadyExists
                      message: Agent name 'firstAgent' already exists.
                      type: Information
                      details: null
                      rawMessage: Agent name 'firstAgent' already exists.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                With Non-Existent Organization:
                  description: The organization is not found on the server.
                  value:
                    errors:
                    - id: 17df744c-6115-9771-9151-5e9faa488e44
                      code: nsk-server:OrganizationNotFound
                      message: The requested organization was not found. Organization ID = '0999'
                      type: Information
                      details: null
                      rawMessage: The requested organization was not found. Organization ID = '0999'
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
  /api/nsk/v2/users:
    get:
      tags:
      - users
      summary: Search user records.
      description: 'GraphQL endpoint: usersv2'
      operationId: nsk_v2_users_get
      parameters:
      - name: OrganizationCode
        in: query
        description: "The organization code to search by.\n            "
        schema:
          type:
          - string
          - 'null'
        x-position: 1
      - name: LocationGroupCode
        in: query
        description: "The location group code to search by.\n            "
        schema:
          type:
          - string
          - 'null'
        x-position: 2
      - name: DomainCode
        in: query
        description: "The domain code to search in.\n            "
        schema:
          type:
          - string
          - 'null'
        x-position: 3
      - name: Username
        in: query
        description: "The unique username to search by.\n            "
        schema:
          type:
          - string
          - 'null'
        x-position: 4
      - name: UsernameMatching
        in: query
        description: "The matching criteria for the username.\n             \nEnumeration values: 0 = StartsWith, 1 = EndsWith, 2 = Contains, 3 = ExactMatch"
        schema:
          $ref: '#/components/schemas/MatchCriteria'
        x-position: 5
      - name: FirstName
        in: query
        description: "The agent's first name to search by.\n            "
        schema:
          type:
          - string
          - 'null'
        x-position: 6
      - name: FirstNameMatching
        in: query
        description: "The matching criteria for the agent's first name.\n             \nEnumeration values: 0 = StartsWith, 1 = EndsWith, 2 = Contains, 3 = ExactMatch"
        schema:
          $ref: '#/components/schemas/MatchCriteria'
        x-position: 7
      - name: LastName
        in: query
        description: "The agent's last name to search by.\n            "
        schema:
          type:
          - string
          - 'null'
        x-position: 8
      - name: RoleCode
        in: query
        description: "The role code to search with.\n            "
        schema:
          type:
          - string
          - 'null'
        x-position: 9
      - name: Status
        in: query
        description: "The agent status to search by.\n             \nEnumeration values: 0 = Default, 1 = Active, 2 = Pending, 3 = Suspended, 4 = Terminated"
        schema:
          $ref: '#/components/schemas/UserStatus'
        x-position: 10
      - name: ReturnCount
        in: query
        description: "The number of results to return.\n            "
        schema:
          type:
          - integer
          - 'null'
        x-position: 11
      - name: LastIndex
        in: query
        description: "The last user index (used for paging).\n            "
        schema:
          type:
          - integer
          - 'null'
          format: int64
          maximum: 9.223372036854776e+18
          minimum: 0.0
        x-position: 12
      responses:
        '404':
          description: The item was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponseOfIListOfUserRecord'
    post:
      tags:
      - users
      summary: Creates a new user for a person (used by agents to create other users).
      description: 'This method is used by agents to create other users (either agents or customers) and connect them with an existing

        person.

        Use this method when a person already exists and you want to create a user for them.


        GraphQL endpoint: usersAddV2'
      operationId: nsk_v2_users_post
      requestBody:
        x-name: request
        description: The request for the user to be created.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserCreateRequestv2'
        required: true
        x-position: 1
      responses:
        '201':
          description: The item was created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '400':
          description: There was a problem with the request and it could not be completed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
              examples:
                With Duplicate Agent Name:
                  description: The agent name already exists.
                  value:
                    errors:
                    - id: 5d7a5d1c-d481-9723-260d-59f53b861112
                      code: nsk:User:UserNameAlreadyExists
                      message: Agent name 'firstAgent' already exists.
                      type: Information
                      details: null
                      rawMessage: Agent name 'firstAgent' already exists.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                With Non-Existent Organization:
                  description: The organization is not found on the server.
                  value:
                    errors:
                    - id: 17df744c-6115-9771-9151-5e9faa488e44
                      code: nsk-server:OrganizationNotFound
                      message: The requested organization was not found. Organization ID = '0999'
                      type: Information
                      details: null
                      rawMessage: The requested organization was not found. Organization ID = '0999'
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
  /api/nsk/v1/users/{userKey}:
    get:
      tags:
      - users
      summary: Retrieves the a specific user.
      description: 'GraphQL endpoint: users'
      operationId: nsk_v1_users_userKey_get
      parameters:
      - name: userKey
        in: path
        required: true
        description: The user key of the user to retrieve.
        schema:
          type: string
        x-position: 1
      responses:
        '404':
          description: The item was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponseOfUser'
    put:
      tags:
      - users
      summary: Updates the specific user.
      description: 'GraphQL endpoint: usersSet'
      operationId: nsk_v1_users_userKey_put
      parameters:
      - name: userKey
        in: path
        required: true
        description: The unique user key.
        schema:
          type: string
        x-position: 1
      requestBody:
        x-name: request
        description: The user edit request.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserRequest'
        required: true
        x-position: 2
      responses:
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '400':
          description: There was a problem with the request and it could not be completed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
              examples:
                With Duplicate Agent Name:
                  description: The agent name already exists.
                  value:
                    errors:
                    - id: 5d7a5d1c-d481-9723-260d-59f53b861112
                      code: nsk:User:UserNameAlreadyExists
                      message: Agent name 'firstAgent' already exists.
                      type: Information
                      details: null
                      rawMessage: Agent name 'firstAgent' already exists.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                With Non-Existent Organization:
                  description: The organization is not found on the server.
                  value:
                    errors:
                    - id: 17df744c-6115-9771-9151-5e9faa488e44
                      code: nsk-server:OrganizationNotFound
                      message: The requested organization was not found. Organization ID = '0999'
                      type: Information
                      details: null
                      rawMessage: The requested organization was not found. Organization ID = '0999'
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
        '500':
          description: A server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
    patch:
      tags:
      - users
      summary: Patches the current logged in user.
      description: 'GraphQL endpoint: usersModifyv2'
      operationId: nsk_v1_users_userKey_patch
      parameters:
      - name: userKey
        in: path
        required: true
        description: The unique user key.
        schema:
          type: string
        x-position: 1
      requestBody:
        x-name: request
        description: The user patch request.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeltaMapperOfUserRequest'
        required: true
        x-position: 2
      responses:
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '400':
          description: There was a problem with the request and it could not be completed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
              examples:
                With Duplicate Agent Name:
                  description: The agent name already exists.
                  value:
                    errors:
                    - id: 5d7a5d1c-d481-9723-260d-59f53b861112
                      code: nsk:User:UserNameAlreadyExists
                      message: Agent name 'firstAgent' already exists.
                      type: Information
                      details: null
                      rawMessage: Agent name 'firstAgent' already exists.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                With Non-Existent Organization:
                  description: The organization is not found on the server.
                  value:
                    errors:
                    - id: 17df744c-6115-9771-9151-5e9faa488e44
                      code: nsk-server:OrganizationNotFound
                      message: The requested organization was not found. Organization ID = '0999'
                      type: Information
                      details: null
                      rawMessage: The requested organization was not found. Organization ID = '0999'
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
        '500':
          description: A server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
    delete:
      tags:
      - users
      summary: Delete the user.
      description: 'This is a soft delete by setting the user record status to terminated.


        GraphQL endpoint: usersDelete'
      operationId: nsk_v1_users_userKey_delete
      parameters:
      - name: userKey
        in: path
        required: true
        description: User key.
        schema:
          type: string
        x-position: 1
      responses:
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
  /api/nsk/v1/users/{userKey}/bookings:
    get:
      tags:
      - users
      summary: Searches the specific user for upcoming and past bookings.
      description: 'GraphQL endpoint: usersBookingsv2'
      operationId: nsk_v1_users_userKey_bookings_get
      parameters:
      - name: userKey
        in: path
        required: true
        description: The unique user key.
        schema:
          type: string
        x-position: 1
      - name: AssociatedFirstName
        in: query
        description: "An associated passenger/contact first name.\n            "
        schema:
          type:
          - string
          - 'null'
        x-position: 2
      - name: AssociatedLastName
        in: query
        description: "An associated passenger/contact last name.\n            "
        schema:
          type:
          - string
          - 'null'
        x-position: 3
      - name: PhoneticSearch
        in: query
        description: "Flag indicating to search using the phonetic option.\n            "
        schema:
          type:
          - boolean
          - 'null'
        x-position: 4
      - name: TripIdentifier
        in: query
        description: "Filter by trip identifier.\n            "
        schema:
          type:
          - string
          - 'null'
        x-position: 5
      - name: Origin
        in: query
        description: "Filter by origin station code.\n            "
        schema:
          type:
          - string
          - 'null'
          maxLength: 3
          minLength: 0
        x-position: 6
      - name: Destination
        in: query
        description: "Filter by destination station code.\n            "
        schema:
          type:
          - string
          - 'null'
          maxLength: 3
          minLength: 0
        x-position: 7
      - name: SearchArchive
        in: query
        description: "Flag indicating to search archived bookings.\n            "
        schema:
          type:
          - boolean
          - 'null'
        x-position: 8
      - name: TripDate
        in: query
        description: "Filter by trip date.\n            "
        schema:
          type:
          - string
          - 'null'
          format: date-time
        x-position: 9
      - name: StartDate
        in: query
        description: "Filter by starting search date.\n            "
        schema:
          type:
          - string
          - 'null'
          format: date-time
        x-position: 10
      - name: EndDate
        in: query
        description: "Filter by ending search date.\n            "
        schema:
          type:
          - string
          - 'null'
          format: date-time
        x-position: 11
      - name: SearchByCustomerNumber
        in: query
        description: "Flag indicating to search by the users customer number instead of user identifier.\n            "
        schema:
          type:
          - boolean
          - 'null'
        x-position: 12
      - name: ReturnCount
        in: query
        description: "The number of results to be returned.\n            "
        schema:
          type: integer
          maximum: 5000.0
          minimum: 10.0
        x-position: 13
      - name: LastBookingKey
        in: query
        description: "The last booking key.\n            "
        schema:
          type:
          - string
          - 'null'
        x-position: 14
      - name: StartingIndex
        in: query
        description: "The starting index of the next set of bookings (used for paging).\n            "
        schema:
          type:
          - integer
          - 'null'
          format: int64
        x-position: 15
      responses:
        '404':
          description: The item was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponseOfIListOfBookingSearchResult'
  /api/nsk/v1/users/{userKey}/bookingsByPassenger:
    get:
      tags:
      - users
      summary: Searches the specific user upcoming and past bookings by passenger.
      description: 'This is similar to the user booking endpoint but returns more focused trip information.

        This endpoint will only return data where a bookings passenger customer number matches the current logged in user.

        Bookings made by the user but where the passenger customer are not assigned are ignored.

        The BeginDate will default to today, and the EndDate defaults to one month from today unless a value is provided.


        GraphQL endpoint: usersBookingsByPassenger'
      operationId: nsk_v1_users_userKey_bookingsByPassenger_get
      parameters:
      - name: userKey
        in: path
        required: true
        description: The user key.
        schema:
          type: string
        x-position: 1
      - name: StartDate
        in: query
        description: "Booking start search date.\n            "
        schema:
          type:
          - string
          - 'null'
          format: date-time
        x-position: 2
      - name: EndDate
        in: query
        description: "Booking end search date.\n            "
        schema:
          type:
          - string
          - 'null'
          format: date-time
        x-position: 3
      responses:
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponseOfIListOfBookingTripResult'
  /api/nsk/v1/users/{userKey}/password/change:
    post:
      tags:
      - users
      summary: Changes a specifics user's password.
      description: 'Requires agent permissions.


        GraphQL endpoint: usersChangePassword'
      operationId: nsk_v1_users_userKey_password_change_post
      parameters:
      - name: userKey
        in: path
        required: true
        description: The unique user key.
        schema:
          type: string
        x-position: 1
      requestBody:
        x-name: request
        description: The change password request.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserChangePasswordRequestBase'
        required: true
        x-position: 2
      responses:
        '201':
          description: The item was created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
  /api/nsk/v1/users/{userKey}/password/reset:
    post:
      tags:
      - users
      summary: Invokes the forgot password reset for a specific user.
      description: 'Requires agent permissions.


        GraphQL endpoint: usersForgotPassword'
      operationId: nsk_v1_users_userKey_password_reset_post
      parameters:
      - name: userKey
        in: path
        required: true
        description: The unique user key.
        schema:
          type: string
        x-position: 1
      responses:
        '202':
          description: The request was accepted successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
  /api/nsk/v1/users/{userKey}/person:
    get:
      tags:
      - users
      summary: Retrieves the specific user's person.
      description: 'GraphQL endpoint: usersPerson'
      operationId: nsk_v1_users_userKey_person_get
      parameters:
      - name: userKey
        in: path
        required: true
        description: The user key of the person record to retrieve.
        schema:
          type: string
        x-position: 1
      responses:
        '404':
          description: The item was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponseOfPerson'
    put:
      tags:
      - users
      summary: Updates the specific user's person record basic information.
      description: 'GraphQL endpoint: usersPersonSet'
      operationId: nsk_v1_users_userKey_person_put
      parameters:
      - name: userKey
        in: path
        required: true
        description: The unique user key.
        schema:
          type: string
        x-position: 1
      requestBody:
        x-name: request
        description: The person edit request.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PersonEditRequest'
            examples:
              Person Edit Request:
                description: Example request for updating person's basic information.
                value:
                  name:
                    first: John
                    middle: Cee
                    last: Doe
                    title: Mr.
                    suffix: null
                  type: 1
                  status: 0
                  details:
                    gender: 1
                    dateOfBirth: '2006-07-09T05:55:15.829325+00:00'
                    nationality: US
                    residentCountry: US
                    passengerType: ADT
                    preferredCultureCode: en-US
                    preferredCurrencyCode: USD
                    nationalIdNumber: null
                    declaredGender: null
                  notificationPreference: 0
        required: true
        x-position: 2
      responses:
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '400':
          description: There was a problem with the request and it could not be completed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
              examples:
                With Invalid User Key:
                  description: The user key is not valid or does not exist.
                  value:
                    errors:
                    - id: null
                      code: nsk:Exceptions:InvalidKey
                      message: The identifier 'userKey' with value 'MTW' is invalid.
                      type: Validation
                      details:
                        userKey: MTW
                      rawMessage: The identifier 'userKey' with value 'MTW' is invalid.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                With Invalid Preferred Culture Code:
                  description: The provided culture code in the request is an invalid culture identifier.
                  value:
                    errors:
                    - id: null
                      code: nsk:Person:InvalidPreferredCulture
                      message: nsk:Person:InvalidPreferredCulture
                      type: Validation
                      details: null
                      rawMessage: The preferred culture code 'ZZZ' is invalid.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                With Invalid Preferred Currency Code:
                  description: The provided currency code in the request is not valid or does not exist.
                  value:
                    errors:
                    - id: null
                      code: nsk:Person:InvalidPreferredCurrency
                      message: nsk:Person:InvalidPreferredCurrency
                      type: Validation
                      details: null
                      rawMessage: The preferred currency code 'ZZZ' is invalid.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                With Invalid First Name:
                  description: The provided first name in the request starts with a numerical or special character.
                  value:
                    errors:
                    - id: null
                      code: nsk:Validation:InvalidFirstNameCharacters
                      message: 'A first name may not begin with any of these characters: :@#$%&_+*-=~^`“"''‘,.:;!?|/\(){}[]<>0123456789.'
                      type: Validation
                      details: null
                      rawMessage: 'A first name may not begin with any of these characters: :@#$%&_+*-=~^`“"''‘,.:;!?|/\(){}[]<>0123456789.'
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                With Invalid Middle Name:
                  description: The provided middle name in the request starts with a special character.
                  value:
                    errors:
                    - id: null
                      code: nsk:Validation:InvalidMiddleNameCharacters
                      message: 'A middle name may not begin with any of these characters: :@#$%&_+*-=~^`“"''‘,.:;!?|/\(){}[]<>.'
                      type: Validation
                      details: null
                      rawMessage: 'A middle name may not begin with any of these characters: :@#$%&_+*-=~^`“"''‘,.:;!?|/\(){}[]<>.'
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                With Invalid Last Name:
                  description: The provided last name in the request starts with a numerical or special character.
                  value:
                    errors:
                    - id: null
                      code: nsk:Validation:InvalidLastNameCharacters
                      message: 'A last name may not begin with any of these characters: :@#$%&_+*-=~^`“"''‘,.:;!?|/\(){}[]<>0123456789.'
                      type: Validation
                      details: null
                      rawMessage: 'A last name may not begin with any of these characters: :@#$%&_+*-=~^`“"''‘,.:;!?|/\(){}[]<>0123456789.'
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                Update Status Not Allowed:
                  description: The logged-in user is not allowed to update the person's status.
                  value:
                    errors:
                    - id: null
                      code: nsk:Person:StatusUpdateNotAllowed
                      message: nsk:Person:StatusUpdateNotAllowed
                      type: Validation
                      details: null
                      rawMessage: The logged-in user is not allowed to update their status.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                Update Type Not Allowed:
                  description: The logged-in user is not allowed to update the person's type.
                  value:
                    errors:
                    - id: null
                      code: nsk:Person:TypeUpdateNotAllowed
                      message: nsk:Person:TypeUpdateNotAllowed
                      type: Validation
                      details: null
                      rawMessage: The logged-in user is not allowed to update their type.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                With Null Request:
                  description: Example response when attempting to call the endpoint with a null request
                  value:
                    errors:
                    - id: null
                      code: core:Validation:NullRequest
                      message: The request is null or couldn't be converted to the expected data type.
                      type: Error
                      details: null
                      rawMessage: The request is null or couldn't be converted to the expected data type.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
        '401':
          description: Authorization Not Allowed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '500':
          description: A server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
    patch:
      tags:
      - users
      summary: Patches the specific user's person records basic information.
      description: 'GraphQL endpoint: usersPersonModify'
      operationId: nsk_v1_users_userKey_person_patch
      parameters:
      - name: userKey
        in: path
        required: true
        description: The unique user key.
        schema:
          type: string
        x-position: 1
      requestBody:
        x-name: request
        description: The person patch request.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeltaMapperOfPersonEditRequest'
            examples:
              Person Edit Request:
                description: Example request for updating person's basic information.
                value:
                  name:
                    first: John
                    middle: Cee
                    last: Doe
                    title: Mr.
                    suffix: null
                  type: 1
                  status: 0
                  details:
                    gender: 1
                    dateOfBirth: '2006-07-09T05:55:15.8336689+00:00'
                    nationality: US
                    residentCountry: US
                    passengerType: ADT
                    preferredCultureCode: en-US
                    preferredCurrencyCode: USD
                    nationalIdNumber: null
                    declaredGender: null
                  notificationPreference: 0
        required: true
        x-position: 2
      responses:
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '400':
          description: There was a problem with the request and it could not be completed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
              examples:
                With Invalid User Key:
                  description: The user key is not valid or does not exist.
                  value:
                    errors:
                    - id: null
                      code: nsk:Exceptions:InvalidKey
                      message: The identifier 'userKey' with value 'MTW' is invalid.
                      type: Validation
                      details:
                        userKey: MTW
                      rawMessage: The identifier 'userKey' with value 'MTW' is invalid.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                With Invalid Preferred Culture Code:
                  description: The provided culture code in the request is an invalid culture identifier.
                  value:
                    errors:
                    - id: null
                      code: nsk:Person:InvalidPreferredCulture
                      message: nsk:Person:InvalidPreferredCulture
                      type: Validation
                      details: null
                      rawMessage: The preferred culture code 'ZZZ' is invalid.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                With Invalid Preferred Currency Code:
                  description: The provided currency code in the request is not valid or does not exist.
                  value:
                    errors:
                    - id: null
                      code: nsk:Person:InvalidPreferredCurrency
                      message: nsk:Person:InvalidPreferredCurrency
                      type: Validation
                      details: null
                      rawMessage: The preferred currency code 'ZZZ' is invalid.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                With Invalid First Name:
                  description: The provided first name in the request starts with a numerical or special character.
                  value:
                    errors:
                    - id: null
                      code: nsk:Validation:InvalidFirstNameCharacters
                      message: 'A first name may not begin with any of these characters: :@#$%&_+*-=~^`“"''‘,.:;!?|/\(){}[]<>0123456789.'
                      type: Validation
                      details: null
                      rawMessage: 'A first name may not begin with any of these characters: :@#$%&_+*-=~^`“"''‘,.:;!?|/\(){}[]<>0123456789.'
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                With Invalid Middle Name:
                  description: The provided middle name in the request starts with a special character.
                  value:
                    errors:
                    - id: null
                      code: nsk:Validation:InvalidMiddleNameCharacters
                      message: 'A middle name may not begin with any of these characters: :@#$%&_+*-=~^`“"''‘,.:;!?|/\(){}[]<>.'
                      type: Validation
                      details: null
                      rawMessage: 'A middle name may not begin with any of these characters: :@#$%&_+*-=~^`“"''‘,.:;!?|/\(){}[]<>.'
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                With Invalid Last Name:
                  description: The provided last name in the request starts with a numerical or special character.
                  value:
                    errors:
                    - id: null
                      code: nsk:Validation:InvalidLastNameCharacters
                      message: 'A last name may not begin with any of these characters: :@#$%&_+*-=~^`“"''‘,.:;!?|/\(){}[]<>0123456789.'
                      type: Validation
                      details: null
                      rawMessage: 'A last name may not begin with any of these characters: :@#$%&_+*-=~^`“"''‘,.:;!?|/\(){}[]<>0123456789.'
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                Update Status Not Allowed:
                  description: The logged-in user is not allowed to update the person's status.
                  value:
                    errors:
                    - id: null
                      code: nsk:Person:StatusUpdateNotAllowed
                      message: nsk:Person:StatusUpdateNotAllowed
                      type: Validation
                      details: null
                      rawMessage: The logged-in user is not allowed to update their status.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                Update Type Not Allowed:
                  description: The logged-in user is not allowed to update the person's type.
                  value:
                    errors:
                    - id: null
                      code: nsk:Person:TypeUpdateNotAllowed
                      message: nsk:Person:TypeUpdateNotAllowed
                      type: Validation
                      details: null
                      rawMessage: The logged-in user is not allowed to update their type.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                With Null Request:
                  description: Example response when attempting to call the endpoint with a null request
                  value:
                    errors:
                    - id: null
                      code: core:Validation:NullRequest
                      message: The request is null or couldn't be converted to the expected data type.
                      type: Error
                      details: null
                      rawMessage: The request is null or couldn't be converted to the expected data type.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
        '401':
          description: Authorization Not Allowed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '500':
          description: A server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
  /api/nsk/v1/users/{userKey}/person/addresses:
    get:
      tags:
      - users
      summary: Gets all addresses from the specific user's person.
      description: Gets all addresses from the specific user's person.
      operationId: nsk_v1_users_userKey_person_addresses_get
      parameters:
      - name: userKey
        in: path
        required: true
        description: The unique user key.
        schema:
          type: string
        x-position: 1
      responses:
        '404':
          description: The item was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponseOfIListOfPersonAddress'
    post:
      tags:
      - users
      summary: Creates a new address on the specific user's person.
      description: 'GraphQL endpoint: usersPersonAddressAdd'
      operationId: nsk_v1_users_userKey_person_addresses_post
      parameters:
      - name: userKey
        in: path
        required: true
        description: The unique user key.
        schema:
          type: string
        x-position: 1
      requestBody:
        x-name: request
        description: The new address.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PersonAddressCreateRequest'
        required: true
        x-position: 2
      responses:
        '201':
          description: The item was created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
  /api/nsk/v1/users/{userKey}/person/addresses/{personAddressKey}:
    get:
      tags:
      - users
      summary: Gets a specific address from the specific user's person.
      description: 'GraphQL endpoint: usersPersonAddress'
      operationId: nsk_v1_users_userKey_person_addresses_personAddressKey_get
      parameters:
      - name: userKey
        in: path
        required: true
        description: The unique user key.
        schema:
          type: string
        x-position: 1
      - name: personAddressKey
        in: path
        required: true
        description: The unique person address key.
        schema:
          type: string
        x-position: 2
      responses:
        '404':
          description: The item was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponseOfPersonAddress'
    put:
      tags:
      - users
      summary: Updates a specific address on the specific user's person.
      description: 'GraphQL endpoint: usersPersonAddressSet'
      operationId: nsk_v1_users_userKey_person_addresses_personAddressKey_put
      parameters:
      - name: userKey
        in: path
        required: true
        description: The unique user key.
        schema:
          type: string
        x-position: 1
      - name: personAddressKey
        in: path
        required: true
        description: The unique person address key.
        schema:
          type: string
        x-position: 2
      requestBody:
        x-name: request
        description: The modified address.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PersonAddressEditRequest'
        required: true
        x-position: 3
      responses:
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '500':
          description: A server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
    patch:
      tags:
      - users
      summary: Patches a specific address on the specific user's person.
      description: 'GraphQL endpoint: usersPersonAddressModify'
      operationId: nsk_v1_users_userKey_person_addresses_personAddressKey_patch
      parameters:
      - name: userKey
        in: path
        required: true
        description: The unique user key.
        schema:
          type: string
        x-position: 1
      - name: personAddressKey
        in: path
        required: true
        description: The unique person address key.
        schema:
          type: string
        x-position: 2
      requestBody:
        x-name: request
        description: The patched address.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeltaMapperOfPersonAddressEditRequest'
        required: true
        x-position: 3
      responses:
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '500':
          description: A server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
    delete:
      tags:
      - users
      summary: Deletes a specific address on the specific user's person.
      description: 'GraphQL endpoint: usersPersonAddressDelete'
      operationId: nsk_v1_users_userKey_person_addresses_personAddressKey_delete
      parameters:
      - name: userKey
        in: path
        required: true
        description: The unique user key.
        schema:
          type: string
        x-position: 1
      - name: personAddressKey
        in: path
        required: true
        description: The unique person address key.
        schema:
          type: string
        x-position: 2
      responses:
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
  /api/nsk/v1/users/{userKey}/person/affiliations:
    get:
      tags:
      - users
      summary: Gets all affiliations from the specific user's person.
      description: 'GraphQL endpoint: usersPersonAffiliations'
      operationId: nsk_v1_users_userKey_person_affiliations_get
      parameters:
      - name: userKey
        in: path
        required: true
        description: The unique user key.
        schema:
          type: string
        x-position: 1
      responses:
        '404':
          description: The item was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponseOfIListOfPersonAffiliation'
    post:
      tags:
      - users
      summary: Creates a new affiliation for the specific user's person.
      description: 'GraphQL endpoint: usersPersonAffiliationAdd'
      operationId: nsk_v1_users_userKey_person_affiliations_post
      parameters:
      - name: userKey
        in: path
        required: true
        description: The unique user key.
        schema:
          type: string
        x-position: 1
      requestBody:
        x-name: request
        description: The new affiliation.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PersonAffiliationRequest'
            examples:
              Person Affiliation Request:
                description: Example request for creating or updating a person's affiliation.
                value:
                  name: John Doe
        required: true
        x-position: 2
      responses:
        '201':
          description: The item was created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '400':
          description: There was a problem with the request and it could not be completed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
              examples:
                With Invalid User Key:
                  description: The user key is not valid or does not exist.
                  value:
                    errors:
                    - id: null
                      code: nsk:Exceptions:InvalidKey
                      message: The identifier 'userKey' with value 'MTW' is invalid.
                      type: Validation
                      details:
                        userKey: MTW
                      rawMessage: The identifier 'userKey' with value 'MTW' is invalid.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                With Null Request:
                  description: Example response when attempting to call the endpoint with a null request
                  value:
                    errors:
                    - id: null
                      code: core:Validation:NullRequest
                      message: The request is null or couldn't be converted to the expected data type.
                      type: Error
                      details: null
                      rawMessage: The request is null or couldn't be converted to the expected data type.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
        '401':
          description: Authorization Not Allowed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
  /api/nsk/v1/users/{userKey}/person/affiliations/{personAffiliationKey}:
    get:
      tags:
      - users
      summary: Gets a specific affiliation from the specific user's person.
      description: 'GraphQL endpoint: usersPersonAffiliation'
      operationId: nsk_v1_users_userKey_person_affiliations_personAffiliationKey_get
      parameters:
      - name: userKey
        in: path
        required: true
        description: The unique user key.
        schema:
          type: string
        x-position: 1
      - name: personAffiliationKey
        in: path
        required: true
        description: The unique person affiliation key.
        schema:
          type: string
        x-position: 2
      responses:
        '404':
          description: The item was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponseOfPersonAffiliation'
    put:
      tags:
      - users
      summary: Updates a specific affiliation for the specific user's person.
      description: 'GraphQL endpoint: usersPersonAffiliationSet'
      operationId: nsk_v1_users_userKey_person_affiliations_personAffiliationKey_put
      parameters:
      - name: userKey
        in: path
        required: true
        description: The unique user key.
        schema:
          type: string
        x-position: 1
      - name: personAffiliationKey
        in: path
        required: true
        description: The unique person affiliation key.
        schema:
          type: string
        x-position: 2
      requestBody:
        x-name: request
        description: The modified affiliation.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PersonAffiliationRequest'
            examples:
              Person Affiliation Request:
                description: Example request for creating or updating a person's affiliation.
                value:
                  name: John Doe
        required: true
        x-position: 3
      responses:
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '400':
          description: There was a problem with the request and it could not be completed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
              examples:
                With Invalid User Key:
                  description: The user key is not valid or does not exist.
                  value:
                    errors:
                    - id: null
                      code: nsk:Exceptions:InvalidKey
                      message: The identifier 'userKey' with value 'MTW' is invalid.
                      type: Validation
                      details:
                        userKey: MTW
                      rawMessage: The identifier 'userKey' with value 'MTW' is invalid.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                With Invalid Person Affiliation Key:
                  description: The person affiliation key is not valid or does not exist.
                  value:
                    errors:
                    - id: null
                      code: nsk:Exceptions:UpdateFailed
                      message: nsk:Exceptions:UpdateFailed
                      type: Validation
                      details: null
                      rawMessage: Attempted update of object 'PersonAffiliation' has failed. Please verify this object exists.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                With Null Request:
                  description: Example response when attempting to call the endpoint with a null request
                  value:
                    errors:
                    - id: null
                      code: core:Validation:NullRequest
                      message: The request is null or couldn't be converted to the expected data type.
                      type: Error
                      details: null
                      rawMessage: The request is null or couldn't be converted to the expected data type.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
        '401':
          description: Authorization Not Allowed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '500':
          description: A server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
    delete:
      tags:
      - users
      summary: Deletes a specific affiliation for the specific user's person.
      description: 'GraphQL endpoint: usersPersonAffiliationDelete'
      operationId: nsk_v1_users_userKey_person_affiliations_personAffiliationKey_delete
      parameters:
      - name: userKey
        in: path
        required: true
        description: The unique user key.
        schema:
          type: string
        x-position: 1
      - name: personAffiliationKey
        in: path
        required: true
        description: The unique person affiliation key.
        schema:
          type: string
        x-position: 2
      responses:
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '400':
          description: There was a problem with the request and it could not be completed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
              examples:
                With Invalid User Key:
                  description: The user key is not valid or does not exist.
                  value:
                    errors:
                    - id: null
                      code: nsk:Exceptions:InvalidKey
                      message: The identifier 'userKey' with value 'MTW' is invalid.
                      type: Validation
                      details:
                        userKey: MTW
                      rawMessage: The identifier 'userKey' with value 'MTW' is invalid.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
        '401':
          description: Authorization Not Allowed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
  /api/nsk/v1/users/{userKey}/person/aliases:
    get:
      tags:
      - users
      summary: Gets all aliases from the specific user's person.
      description: Gets all aliases from the specific user's person.
      operationId: nsk_v1_users_userKey_person_aliases_get
      parameters:
      - name: userKey
        in: path
        required: true
        description: The unique user key.
        schema:
          type: string
        x-position: 1
      responses:
        '404':
          description: The item was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponseOfIListOfPersonAlias'
    post:
      tags:
      - users
      summary: Creates a new alias on the specific user's person.
      description: 'GraphQL endpoint: usersPersonAliasAdd'
      operationId: nsk_v1_users_userKey_person_aliases_post
      parameters:
      - name: userKey
        in: path
        required: true
        description: The unique user key.
        schema:
          type: string
        x-position: 1
      requestBody:
        x-name: request
        description: The new alias.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PersonAliasRequest'
            examples:
              Person Alias Request:
                description: Example request for creating or updating a person's alias.
                value:
                  type: 0
                  first: John
                  middle: Cee
                  last: Doe
                  title: Mr.
                  suffix: null
        required: true
        x-position: 2
      responses:
        '201':
          description: The item was created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '400':
          description: There was a problem with the request and it could not be completed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
              examples:
                With Invalid User Key:
                  description: The user key is not valid or does not exist.
                  value:
                    errors:
                    - id: null
                      code: nsk:Exceptions:InvalidKey
                      message: The identifier 'userKey' with value 'MTW' is invalid.
                      type: Validation
                      details:
                        userKey: MTW
                      rawMessage: The identifier 'userKey' with value 'MTW' is invalid.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                With Null Request:
                  description: Example response when attempting to call the endpoint with a null request
                  value:
                    errors:
                    - id: null
                      code: core:Validation:NullRequest
                      message: The request is null or couldn't be converted to the expected data type.
                      type: Error
                      details: null
                      rawMessage: The request is null or couldn't be converted to the expected data type.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
        '401':
          description: Authorization Not Allowed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
  /api/nsk/v1/users/{userKey}/person/aliases/{personAliasKey}:
    get:
      tags:
      - users
      summary: Gets a specific alias from the specific user's person.
      description: 'GraphQL endpoint: usersPersonAlias'
      operationId: nsk_v1_users_userKey_person_aliases_personAliasKey_get
      parameters:
      - name: userKey
        in: path
        required: true
        description: The unique user key.
        schema:
          type: string
        x-position: 1
      - name: personAliasKey
        in: path
        required: true
        description: The unique person alias key.
        schema:
          type: string
        x-position: 2
      responses:
        '404':
          description: The item was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponseOfPersonAlias'
    put:
      tags:
      - users
      summary: Updates a specific alias on the specific user's person.
      description: 'GraphQL endpoint: usersPersonAliasSet'
      operationId: nsk_v1_users_userKey_person_aliases_personAliasKey_put
      parameters:
      - name: userKey
        in: path
        required: true
        description: The unique user key.
        schema:
          type: string
        x-position: 1
      - name: personAliasKey
        in: path
        required: true
        description: The unique person alias key.
        schema:
          type: string
        x-position: 2
      requestBody:
        x-name: request
        description: The modified alias.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PersonAliasRequest'
            examples:
              Person Alias Request:
                description: Example request for creating or updating a person's alias.
                value:
                  type: 0
                  first: John
                  middle: Cee
                  last: Doe
                  title: Mr.
                  suffix: null
        required: true
        x-position: 3
      responses:
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '400':
          description: There was a problem with the request and it could not be completed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
              examples:
                With Invalid User Key:
                  description: The user key is not valid or does not exist.
                  value:
                    errors:
                    - id: null
                      code: nsk:Exceptions:InvalidKey
                      message: The identifier 'userKey' with value 'MTW' is invalid.
                      type: Validation
                      details:
                        userKey: MTW
                      rawMessage: The identifier 'userKey' with value 'MTW' is invalid.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                With Invalid Person Alias Key:
                  description: The person alias key is not valid or does not exist.
                  value:
                    errors:
                    - id: null
                      code: nsk:Exceptions:UpdateFailed
                      message: nsk:Exceptions:UpdateFailed
                      type: Validation
                      details: null
                      rawMessage: Attempted update of object 'PersonAlias' has failed. Please verify this object exists.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                With Null Request:
                  description: Example response when attempting to call the endpoint with a null request
                  value:
                    errors:
                    - id: null
                      code: core:Validation:NullRequest
                      message: The request is null or couldn't be converted to the expected data type.
                      type: Error
                      details: null
                      rawMessage: The request is null or couldn't be converted to the expected data type.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
        '401':
          description: Authorization Not Allowed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '500':
          description: A server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
    patch:
      tags:
      - users
      summary: Patches a specific alias on the specific user's person.
      description: 'GraphQL endpoint: usersPersonAliasModify'
      operationId: nsk_v1_users_userKey_person_aliases_personAliasKey_patch
      parameters:
      - name: userKey
        in: path
        required: true
        description: The unique user key.
        schema:
          type: string
        x-position: 1
      - name: personAliasKey
        in: path
        required: true
        description: The unique person alias key.
        schema:
          type: string
        x-position: 2
      requestBody:
        x-name: request
        description: The patched alias.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeltaMapperOfPersonAliasRequest'
            examples:
              Person Alias Request:
                description: Example request for creating or updating a person's alias.
                value:
                  type: 0
                  first: John
                  middle: Cee
                  last: Doe
                  title: Mr.
                  suffix: null
        required: true
        x-position: 3
      responses:
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '400':
          description: There was a problem with the request and it could not be completed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
              examples:
                With Invalid User Key:
                  description: The user key is not valid or does not exist.
                  value:
                    errors:
                    - id: null
                      code: nsk:Exceptions:InvalidKey
                      message: The identifier 'userKey' with value 'MTW' is invalid.
                      type: Validation
                      details:
                        userKey: MTW
                      rawMessage: The identifier 'userKey' with value 'MTW' is invalid.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                With Invalid Person Alias Key:
                  description: The person alias key is not valid or does not exist.
                  value:
                    errors:
                    - id: null
                      code: nsk:Exceptions:InvalidKey
                      message: The identifier 'personAliasKey' with value 'MTW' is invalid.
                      type: Validation
                      details:
                        personAliasKey: MTW
                      rawMessage: The identifier 'personAliasKey' with value 'MTW' is invalid.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                With Null Request:
                  description: Example response when attempting to call the endpoint with a null request
                  value:
                    errors:
                    - id: null
                      code: core:Validation:NullRequest
                      message: The request is null or couldn't be converted to the expected data type.
                      type: Error
                      details: null
                      rawMessage: The request is null or couldn't be converted to the expected data type.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
        '401':
          description: Authorization Not Allowed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '500':
          description: A server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
    delete:
      tags:
      - users
      summary: Deletes a specific alias on the specific user's person.
      description: 'GraphQL endpoint: usersPersonAliasDelete'
      operationId: nsk_v1_users_userKey_person_aliases_personAliasKey_delete
      parameters:
      - name: userKey
        in: path
        required: true
        description: The unique user key.
        schema:
          type: string
        x-position: 1
      - name: personAliasKey
        in: path
        required: true
        description: The unique person alias key.
        schema:
          type: string
        x-position: 2
      responses:
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '400':
          description: There was a problem with the request and it could not be completed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
              examples:
                With Invalid User Key:
                  description: The user key is not valid or does not exist.
                  value:
                    errors:
                    - id: null
                      code: nsk:Exceptions:InvalidKey
                      message: The identifier 'userKey' with value 'MTW' is invalid.
                      type: Validation
                      details:
                        userKey: MTW
                      rawMessage: The identifier 'userKey' with value 'MTW' is invalid.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
        '401':
          description: Authorization Not Allowed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
  /api/nsk/v1/users/{userKey}/person/comments:
    get:
      tags:
      - users
      summary: Gets all comments from the specific user's person.
      description: 'GraphQL endpoint: usersPersonComments'
      operationId: nsk_v1_users_userKey_person_comments_get
      parameters:
      - name: userKey
        in: path
        required: true
        description: The unique user key.
        schema:
          type: string
        x-position: 1
      responses:
        '404':
          description: The item was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponseOfIListOfPersonComment'
    post:
      tags:
      - users
      summary: Creates a new comment on the specific user's person.
      description: 'GraphQL endpoint: usersPersonCommentAdd'
      operationId: nsk_v1_users_userKey_person_comments_post
      parameters:
      - name: userKey
        in: path
        required: true
        description: The unique user key.
        schema:
          type: string
        x-position: 1
      requestBody:
        x-name: request
        description: The new comment.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PersonCommentRequest'
            examples:
              Person Comment Request:
                description: Example request for creating or updating a person's comment.
                value:
                  text: Comment
                  type: 0
        required: true
        x-position: 2
      responses:
        '201':
          description: The item was created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '400':
          description: There was a problem with the request and it could not be completed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
              examples:
                With Invalid User Key:
                  description: The user key is not valid or does not exist.
                  value:
                    errors:
                    - id: null
                      code: nsk:Exceptions:InvalidKey
                      message: The identifier 'userKey' with value 'MTW' is invalid.
                      type: Validation
                      details:
                        userKey: MTW
                      rawMessage: The identifier 'userKey' with value 'MTW' is invalid.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                With Null Request:
                  description: Example response when attempting to call the endpoint with a null request
                  value:
                    errors:
                    - id: null
                      code: core:Validation:NullRequest
                      message: The request is null or couldn't be converted to the expected data type.
                      type: Error
                      details: null
                      rawMessage: The request is null or couldn't be converted to the expected data type.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
        '401':
          description: Authorization Not Allowed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
  /api/nsk/v1/users/{userKey}/person/comments/{personCommentKey}:
    get:
      tags:
      - users
      summary: Gets a specific comment from the specific user's person.
      description: 'GraphQL endpoint: usersPersonComment'
      operationId: nsk_v1_users_userKey_person_comments_personCommentKey_get
      parameters:
      - name: userKey
        in: path
        required: true
        description: The unique user key.
        schema:
          type: string
        x-position: 1
      - name: personCommentKey
        in: path
        required: true
        description: The unique person comment key.
        schema:
          type: string
        x-position: 2
      responses:
        '404':
          description: The item was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponseOfPersonComment'
    put:
      tags:
      - users
      summary: Updates a specific comment on the specific user's person.
      description: 'GraphQL endpoint: usersPersonCommentSet'
      operationId: nsk_v1_users_userKey_person_comments_personCommentKey_put
      parameters:
      - name: userKey
        in: path
        required: true
        description: The unique user key.
        schema:
          type: string
        x-position: 1
      - name: personCommentKey
        in: path
        required: true
        description: The unique person comment key.
        schema:
          type: string
        x-position: 2
      requestBody:
        x-name: request
        description: The modified comment.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PersonCommentRequest'
            examples:
              Person Comment Request:
                description: Example request for creating or updating a person's comment.
                value:
                  text: Comment
                  type: 0
        required: true
        x-position: 3
      responses:
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '400':
          description: There was a problem with the request and it could not be completed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
              examples:
                With Invalid User Key:
                  description: The user key is not valid or does not exist.
                  value:
                    errors:
                    - id: null
                      code: nsk:Exceptions:InvalidKey
                      message: The identifier 'userKey' with value 'MTW' is invalid.
                      type: Validation
                      details:
                        userKey: MTW
                      rawMessage: The identifier 'userKey' with value 'MTW' is invalid.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                With Invalid Person Comment Key:
                  description: The person comment key is not valid or does not exist.
                  value:
                    errors:
                    - id: null
                      code: nsk:Exceptions:UpdateFailed
                      message: nsk:Exceptions:UpdateFailed
                      type: Validation
                      details: null
                      rawMessage: Attempted update of object 'PersonComment' has failed. Please verify this object exists.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                With Null Request:
                  description: Example response when attempting to call the endpoint with a null request
                  value:
                    errors:
                    - id: null
                      code: core:Validation:NullRequest
                      message: The request is null or couldn't be converted to the expected data type.
                      type: Error
                      details: null
                      rawMessage: The request is null or couldn't be converted to the expected data type.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
        '401':
          description: Authorization Not Allowed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '500':
          description: A server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
    patch:
      tags:
      - users
      summary: Patches a specific comment on the specific user's person.
      description: 'GraphQL endpoint: usersPersonCommentModify'
      operationId: nsk_v1_users_userKey_person_comments_personCommentKey_patch
      parameters:
      - name: userKey
        in: path
        required: true
        description: The unique user key.
        schema:
          type: string
        x-position: 1
      - name: personCommentKey
        in: path
        required: true
        description: The unique person comment key.
        schema:
          type: string
        x-position: 2
      requestBody:
        x-name: request
        description: The patched comment.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeltaMapperOfPersonCommentRequest'
            examples:
              Person Comment Request:
                description: Example request for creating or updating a person's comment.
                value:
                  text: Comment
                  type: 0
        required: true
        x-position: 3
      responses:
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '400':
          description: There was a problem with the request and it could not be completed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
              examples:
                With Invalid User Key:
                  description: The user key is not valid or does not exist.
                  value:
                    errors:
                    - id: null
                      code: nsk:Exceptions:InvalidKey
                      message: The identifier 'userKey' with value 'MTW' is invalid.
                      type: Validation
                      details:
                        userKey: MTW
                      rawMessage: The identifier 'userKey' with value 'MTW' is invalid.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                With Invalid Person Comment Key:
                  description: The person comment key is not valid or does not exist.
                  value:
                    errors:
                    - id: null
                      code: nsk:Exceptions:UpdateFailed
                      message: nsk:Exceptions:UpdateFailed
                      type: Validation
                      details: null
                      rawMessage: Attempted update of object 'PersonComment' has failed. Please verify this object exists.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                With Null Request:
                  description: Example response when attempting to call the endpoint with a null request
                  value:
                    errors:
                    - id: null
                      code: core:Validation:NullRequest
                      message: The request is null or couldn't be converted to the expected data type.
                      type: Error
                      details: null
                      rawMessage: The request is null or couldn't be converted to the expected data type.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
        '401':
          description: Authorization Not Allowed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '500':
          description: A server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
    delete:
      tags:
      - users
      summary: Deletes a specific comment on the specific user's person.
      description: 'GraphQL endpoint: usersPersonCommentDelete'
      operationId: nsk_v1_users_userKey_person_comments_personCommentKey_delete
      parameters:
      - name: userKey
        in: path
        required: true
        description: The unique user key.
        schema:
          type: string
        x-position: 1
      - name: personCommentKey
        in: path
        required: true
        description: The unique person comment key.
        schema:
          type: string
        x-position: 2
      responses:
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '400':
          description: There was a problem with the request and it could not be completed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
              examples:
                With Invalid User Key:
                  description: The user key is not valid or does not exist.
                  value:
                    errors:
                    - id: null
                      code: nsk:Exceptions:InvalidKey
                      message: The identifier 'userKey' with value 'MTW' is invalid.
                      type: Validation
                      details:
                        userKey: MTW
                      rawMessage: The identifier 'userKey' with value 'MTW' is invalid.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
        '401':
          description: Authorization Not Allowed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
  /api/nsk/v1/users/{userKey}/person/emails:
    get:
      tags:
      - users
      summary: Gets all email addresses from the specific user's person.
      description: Gets all email addresses from the specific user's person.
      operationId: nsk_v1_users_userKey_person_emails_get
      parameters:
      - name: userKey
        in: path
        required: true
        description: The user key of the user whose email addresses to retrieve.
        schema:
          type: string
        x-position: 1
      responses:
        '404':
          description: The item was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponseOfIListOfPersonEmail'
    post:
      tags:
      - users
      summary: Creates a new email address on the specific user's person.
      description: 'The "type" property for the request is a single character.  See the "/resources/EmailTypes"

        endpoint for valid email type codes.


        GraphQL endpoint: usersPersonEmailAdd'
      operationId: nsk_v1_users_userKey_person_emails_post
      parameters:
      - name: userKey
        in: path
        required: true
        description: The unique user key.
        schema:
          type: string
        x-position: 1
      requestBody:
        x-name: request
        description: The new email address.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmailCreateRequest'
        required: true
        x-position: 2
      responses:
        '201':
          description: The item was created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
  /api/nsk/v1/users/{userKey}/person/emails/{personEmailAddressKey}:
    get:
      tags:
      - users
      summary: Gets a specific email address from the specific user's person.
      description: 'GraphQL endpoint: usersPersonEmail'
      operationId: nsk_v1_users_userKey_person_emails_personEmailAddressKey_get
      parameters:
      - name: userKey
        in: path
        required: true
        description: The unique user key.
        schema:
          type: string
        x-position: 1
      - name: personEmailAddressKey
        in: path
        required: true
        description: The unique person email address key.
        schema:
          type: string
        x-position: 2
      responses:
        '404':
          description: The item was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponseOfPersonEmail'
    put:
      tags:
      - users
      summary: Updates a specific email address on the specific user's person.
      description: 'GraphQL endpoint: usersPersonEmailSet'
      operationId: nsk_v1_users_userKey_person_emails_personEmailAddressKey_put
      parameters:
      - name: userKey
        in: path
        required: true
        description: The specific user key.
        schema:
          type: string
        x-position: 1
      - name: personEmailAddressKey
        in: path
        required: true
        description: The unique person email address key.
        schema:
          type: string
        x-position: 2
      requestBody:
        x-name: request
        description: The modified email address.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmailEditRequest'
        required: true
        x-position: 3
      responses:
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '500':
          description: A server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
    patch:
      tags:
      - users
      summary: Patches a specific email address on the specific user's person.
      description: 'GraphQL endpoint: usersPersonEmailModify'
      operationId: nsk_v1_users_userKey_person_emails_personEmailAddressKey_patch
      parameters:
      - name: userKey
        in: path
        required: true
        description: The unique user key.
        schema:
          type: string
        x-position: 1
      - name: personEmailAddressKey
        in: path
        required: true
        description: The unique person email address key.
        schema:
          type: string
        x-position: 2
      requestBody:
        x-name: request
        description: The patched email address.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeltaMapperOfEmailEditRequest'
        required: true
        x-position: 3
      responses:
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '500':
          description: A server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
    delete:
      tags:
      - users
      summary: Deletes a specific email address on the specific user's person.
      description: 'GraphQL endpoint: usersPersonEmailDelete'
      operationId: nsk_v1_users_userKey_person_emails_personEmailAddressKey_delete
      parameters:
      - name: userKey
        in: path
        required: true
        description: The unique user key.
        schema:
          type: string
        x-position: 1
      - name: personEmailAddressKey
        in: path
        required: true
        description: The unique person email address key.
        schema:
          type: string
        x-position: 2
      responses:
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
  /api/nsk/v1/users/{userKey}/person/information:
    get:
      tags:
      - users
      summary: Gets all information for a specific user's person.
      description: 'GraphQL endpoint: usersPersonInformations'
      operationId: nsk_v1_users_userKey_person_information_get
      parameters:
      - name: userKey
        in: path
        required: true
        description: The unique user key.
        schema:
          type: string
        x-position: 1
      responses:
        '404':
          description: The item was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponseOfIListOfPersonInformation'
              examples:
                Retrieve Person Information:
                  description: Successful retrieval of person information
                  value:
                    personInformationKey: NTcxMzkhQQ-
                    size: 246
                    personInformationTypeCode: A
                    data: <address> <name>John Doe</name> <street>Harrison Street</street> <city>Los Angeles</city> <country>US</country </address>
    post:
      tags:
      - users
      summary: Creates new information for a specific user's person.
      description: 'GraphQL endpoint: usersPersonInformationAdd'
      operationId: nsk_v1_users_userKey_person_information_post
      parameters:
      - name: userKey
        in: path
        required: true
        description: The unique user key.
        schema:
          type: string
        x-position: 1
      requestBody:
        x-name: request
        description: The new information.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PersonInformationCreateRequest'
            examples:
              Create Person Information:
                description: Example request for creating person information. For a list of valid person information type code, kindly refer to the GET /api/nsk/v1/resources/PersonInformationTypes endpoint.
                value:
                  personInformationTypeCode: A
                  data: <address> <name>John Doe</name> <street>Harrison Street</street> <city>Los Angeles</city> <country>US</country </address>
        required: true
        x-position: 2
      responses:
        '201':
          description: The item was created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '400':
          description: There was a problem with the request and it could not be completed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
              examples:
                With Invalid User Key:
                  description: The user key is not valid nor does not exist.
                  value:
                    errors:
                    - id: 99cd1b2b-ccc3-4733-7fa4-2bf49b1d98c0
                      code: nsk:Exceptions:InvalidKey
                      message: The identifier 'userKey' with value 'MTW' is invalid.
                      type: Validation
                      details:
                        userKey: MTW
                      rawMessage: The identifier 'userKey' with value 'MTW' is invalid.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                With Null Request:
                  description: Example response when attempting to call the endpoint with a null request
                  value:
                    errors:
                    - id: 99cd1b2b-ccc3-4733-7fa4-2bf49b1d98c0
                      code: core:Validation:NullRequest
                      message: The request is null or couldn't be converted to the expected data type.
                      type: Error
                      details: null
                      rawMessage: The request is null or couldn't be converted to the expected data type.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
  /api/nsk/v1/users/{userKey}/person/information/{personInformationKey}:
    get:
      tags:
      - users
      summary: Gets specific information for a specific user's person.
      description: 'GraphQL endpoint: usersPersonInformation'
      operationId: nsk_v1_users_userKey_person_information_personInformationKey_get
      parameters:
      - name: userKey
        in: path
        required: true
        description: The unique user key.
        schema:
          type: string
        x-position: 1
      - name: personInformationKey
        in: path
        required: true
        description: The unique person information key.
        schema:
          type: string
        x-position: 2
      responses:
        '404':
          description: The item was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponseOfPersonInformation'
              examples:
                Retrieve Person Information:
                  description: Successful retrieval of person information
                  value:
                    personInformationKey: NTcxMzkhQQ-
                    size: 246
                    personInformationTypeCode: A
                    data: <address> <name>John Doe</name> <street>Harrison Street</street> <city>Los Angeles</city> <country>US</country </address>
    put:
      tags:
      - users
      summary: Updates specific information for a specific user's person.
      description: 'GraphQL endpoint: usersPersonInformationSet'
      operationId: nsk_v1_users_userKey_person_information_personInformationKey_put
      parameters:
      - name: userKey
        in: path
        required: true
        description: The unique user key.
        schema:
          type: string
        x-position: 1
      - name: personInformationKey
        in: path
        required: true
        description: The unique person information key.
        schema:
          type: string
        x-position: 2
      requestBody:
        x-name: request
        description: The modified information.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PersonInformationEditRequest'
            examples:
              Modify Person Information:
                description: Example request for modifying person information
                value:
                  data: <address> <name>John Doe</name> <street>Harrison Street</street> <city>Los Angeles</city> <country>US</country </address>
        required: true
        x-position: 3
      responses:
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '400':
          description: There was a problem with the request and it could not be completed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
              examples:
                With Invalid User Key:
                  description: The user key is not valid nor does not exist.
                  value:
                    errors:
                    - id: 99cd1b2b-ccc3-4733-7fa4-2bf49b1d98c0
                      code: nsk:Exceptions:InvalidKey
                      message: The identifier 'userKey' with value 'MTW' is invalid.
                      type: Validation
                      details:
                        userKey: MTW
                      rawMessage: The identifier 'userKey' with value 'MTW' is invalid.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                With Invalid or Null Person Information Key:
                  description: The person information key is empty, not valid or does not exist.
                  value:
                    errors:
                    - id: 99cd1b2b-ccc3-4733-7fa4-2bf49b1d98c0
                      code: core:Validation:NullRequest
                      message: The request is null or couldn't be converted to the expected data type.
                      type: Error
                      details: null
                      rawMessage: The request is null or couldn't be converted to the expected data type.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                With Null Request:
                  description: Example response when attempting to call the endpoint with a null request
                  value:
                    errors:
                    - id: 99cd1b2b-ccc3-4733-7fa4-2bf49b1d98c0
                      code: core:Validation:NullRequest
                      message: The request is null or couldn't be converted to the expected data type.
                      type: Error
                      details: null
                      rawMessage: The request is null or couldn't be converted to the expected data type.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
        '500':
          description: A server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
    patch:
      tags:
      - users
      summary: Patches specific information for a specific user's person.
      description: 'GraphQL endpoint: usersPersonInformationModify'
      operationId: nsk_v1_users_userKey_person_information_personInformationKey_patch
      parameters:
      - name: userKey
        in: path
        required: true
        description: The unique user key.
        schema:
          type: string
        x-position: 1
      - name: personInformationKey
        in: path
        required: true
        description: The unique person information key.
        schema:
          type: string
        x-position: 2
      requestBody:
        x-name: request
        description: The patched information.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeltaMapperOfPersonInformationEditRequest'
            examples:
              Modify Person Information:
                description: Example request for modifying person information
                value:
                  data: <address> <name>John Doe</name> <street>Harrison Street</street> <city>Los Angeles</city> <country>US</country </address>
        required: true
        x-position: 3
      responses:
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '400':
          description: There was a problem with the request and it could not be completed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
              examples:
                With Invalid User Key:
                  description: The user key is not valid nor does not exist.
                  value:
                    errors:
                    - id: 99cd1b2b-ccc3-4733-7fa4-2bf49b1d98c0
                      code: nsk:Exceptions:InvalidKey
                      message: The identifier 'userKey' with value 'MTW' is invalid.
                      type: Validation
                      details:
                        userKey: MTW
                      rawMessage: The identifier 'userKey' with value 'MTW' is invalid.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                With Invalid or Null Person Information Key:
                  description: The person information key is empty, not valid or does not exist.
                  value:
                    errors:
                    - id: 99cd1b2b-ccc3-4733-7fa4-2bf49b1d98c0
                      code: nsk:Exceptions:UpdateFailed
                      message: nsk:Exceptions:UpdateFailed
                      type: Validation
                      details: null
                      rawMessage: Attempted update of object 'PersonInformation' has failed. Please verify this object exists.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                With Null Request:
                  description: Example response when attempting to call the endpoint with a null request
                  value:
                    errors:
                    - id: 99cd1b2b-ccc3-4733-7fa4-2bf49b1d98c0
                      code: core:Validation:NullRequest
                      message: The request is null or couldn't be converted to the expected data type.
                      type: Error
                      details: null
                      rawMessage: The request is null or couldn't be converted to the expected data type.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
        '500':
          description: A server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
    delete:
      tags:
      - users
      summary: Deletes specific information for a specific user's person.
      description: 'GraphQL endpoint: usersPersonInformationDelete'
      operationId: nsk_v1_users_userKey_person_information_personInformationKey_delete
      parameters:
      - name: userKey
        in: path
        required: true
        description: The unique user key.
        schema:
          type: string
        x-position: 1
      - name: personInformationKey
        in: path
        required: true
        description: The unique person information key.
        schema:
          type: string
        x-position: 2
      responses:
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
  /api/nsk/v1/users/{userKey}/person/phoneNumbers:
    get:
      tags:
      - users
      summary: Gets all phone numbers from the specific user's person.
      description: Gets all phone numbers from the specific user's person.
      operationId: nsk_v1_users_userKey_person_phoneNumbers_get
      parameters:
      - name: userKey
        in: path
        required: true
        description: The unique user key.
        schema:
          type: string
        x-position: 1
      responses:
        '404':
          description: The item was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponseOfIListOfPersonPhoneNumber'
    post:
      tags:
      - users
      summary: Creates a new phone number on the specific user's person.
      description: 'GraphQL endpoint: usersPersonPhoneNumberAdd'
      operationId: nsk_v1_users_userKey_person_phoneNumbers_post
      parameters:
      - name: userKey
        in: path
        required: true
        description: The unique user key.
        schema:
          type: string
        x-position: 1
      requestBody:
        x-name: request
        description: The new phone number.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PersonPhoneNumberRequest'
        required: true
        x-position: 2
      responses:
        '201':
          description: The item was created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
  /api/nsk/v1/users/{userKey}/person/phoneNumbers/{personPhoneNumberKey}:
    get:
      tags:
      - users
      summary: Gets a specific phone number from the specific user's person.
      description: 'GraphQL endpoint: usersPersonPhoneNumber'
      operationId: nsk_v1_users_userKey_person_phoneNumbers_personPhoneNumberKey_get
      parameters:
      - name: userKey
        in: path
        required: true
        description: The unique user key.
        schema:
          type: string
        x-position: 1
      - name: personPhoneNumberKey
        in: path
        required: true
        description: The unique person phone number key.
        schema:
          type: string
        x-position: 2
      responses:
        '404':
          description: The item was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponseOfPersonPhoneNumber'
    put:
      tags:
      - users
      summary: Updates a specific phone number on the specific user's person.
      description: 'GraphQL endpoint: usersPersonPhoneNumberSet'
      operationId: nsk_v1_users_userKey_person_phoneNumbers_personPhoneNumberKey_put
      parameters:
      - name: userKey
        in: path
        required: true
        description: The unique user key.
        schema:
          type: string
        x-position: 1
      - name: personPhoneNumberKey
        in: path
        required: true
        description: The unique person phone number key.
        schema:
          type: string
        x-position: 2
      requestBody:
        x-name: request
        description: The modified phone number.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PersonPhoneNumberRequest'
        required: true
        x-position: 3
      responses:
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '500':
          description: A server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
    patch:
      tags:
      - users
      summary: Patches a specific phone number on the specific user's person.
      description: 'GraphQL endpoint: usersPersonPhoneNumberModify'
      operationId: nsk_v1_users_userKey_person_phoneNumbers_personPhoneNumberKey_patch
      parameters:
      - name: userKey
        in: path
        required: true
        description: The unique user key.
        schema:
          type: string
        x-position: 1
      - name: personPhoneNumberKey
        in: path
        required: true
        description: The unique person phone number key.
        schema:
          type: string
        x-position: 2
      requestBody:
        x-name: request
        description: The patched phone number.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeltaMapperOfPersonPhoneNumberRequest'
        required: true
        x-position: 3
      responses:
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '500':
          description: A server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
    delete:
      tags:
      - users
      summary: Deletes a specific phone number on the specific user's person.
      description: 'GraphQL endpoint: usersPersonPhoneNumberDelete'
      operationId: nsk_v1_users_userKey_person_phoneNumbers_personPhoneNumberKey_delete
      parameters:
      - name: userKey
        in: path
        required: true
        description: The unique user key.
        schema:
          type: string
        x-position: 1
      - name: personPhoneNumberKey
        in: path
        required: true
        description: The unique person phone number key.
        schema:
          type: string
        x-position: 2
      responses:
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
  /api/nsk/v1/users/{userKey}/person/preferences:
    get:
      tags:
      - users
      summary: Gets all preferences for a specific user's person.
      description: Gets all preferences for a specific user's person.
      operationId: nsk_v1_users_userKey_person_preferences_get
      parameters:
      - name: userKey
        in: path
        required: true
        description: The unique person key.
        schema:
          type: string
        x-position: 1
      responses:
        '404':
          description: The item was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponseOfIListOfPersonPreference'
    post:
      tags:
      - users
      summary: Creates a new preference for a specific user's person.
      description: 'GraphQL endpoint: usersPersonPreferenceAdd'
      operationId: nsk_v1_users_userKey_person_preferences_post
      parameters:
      - name: userKey
        in: path
        required: true
        description: The unique user key.
        schema:
          type: string
        x-position: 1
      requestBody:
        x-name: request
        description: The new preference.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PersonPreferenceCreateRequest'
        required: true
        x-position: 2
      responses:
        '201':
          description: The item was created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
  /api/nsk/v1/users/{userKey}/person/preferences/{personPreferenceKey}:
    get:
      tags:
      - users
      summary: Gets a specific preference for a specific user's person.
      description: 'GraphQL endpoint: usersPersonPreference'
      operationId: nsk_v1_users_userKey_person_preferences_personPreferenceKey_get
      parameters:
      - name: userKey
        in: path
        required: true
        description: The unique user key.
        schema:
          type: string
        x-position: 1
      - name: personPreferenceKey
        in: path
        required: true
        description: The unique person preference key.
        schema:
          type: string
        x-position: 2
      responses:
        '404':
          description: The item was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponseOfPersonPreference'
    put:
      tags:
      - users
      summary: Updates a specific preference for a specific user's person.
      description: 'GraphQL endpoint: usersPersonPreferenceSet'
      operationId: nsk_v1_users_userKey_person_preferences_personPreferenceKey_put
      parameters:
      - name: userKey
        in: path
        required: true
        description: The unique user key.
        schema:
          type: string
        x-position: 1
      - name: personPreferenceKey
        in: path
        required: true
        description: The unique person preference key.
        schema:
          type: string
        x-position: 2
      requestBody:
        x-name: request
        description: The modified preference.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PersonPreferenceEditRequest'
        required: true
        x-position: 3
      responses:
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '500':
          description: A server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
    patch:
      tags:
      - users
      summary: Patches a specific preference for a specific user's person.
      description: 'GraphQL endpoint: usersPersonPreferenceModify'
      operationId: nsk_v1_users_userKey_person_preferences_personPreferenceKey_patch
      parameters:
      - name: userKey
        in: path
        required: true
        description: The unique user key.
        schema:
          type: string
        x-position: 1
      - name: personPreferenceKey
        in: path
        required: true
        description: The unique person preference key.
        schema:
          type: string
        x-position: 2
      requestBody:
        x-name: request
        description: The patched preference.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeltaMapperOfPersonPreferenceEditRequest'
        required: true
        x-position: 3
      responses:
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '500':
          description: A server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
    delete:
      tags:
      - users
      summary: Deletes a specific preference for a specific user's person.
      description: 'GraphQL endpoint: usersPersonPreferenceDelete'
      operationId: nsk_v1_users_userKey_person_preferences_personPreferenceKey_delete
      parameters:
      - name: userKey
        in: path
        required: true
        description: The unique user key.
        schema:
          type: string
        x-position: 1
      - name: personPreferenceKey
        in: path
        required: true
        description: The unique person preference key.
        schema:
          type: string
        x-position: 2
      responses:
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
  /api/nsk/v1/users/{userKey}/person/programs:
    get:
      tags:
      - users
      summary: Gets all programs from the specific user's person.
      description: 'GraphQL endpoint: usersPersonPrograms'
      operationId: nsk_v1_users_userKey_person_programs_get
      parameters:
      - name: userKey
        in: path
        required: true
        description: The unique user key.
        schema:
          type: string
        x-position: 1
      responses:
        '404':
          description: The item was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponseOfIListOfPersonCustomerProgram'
    post:
      tags:
      - users
      summary: Creates a new program on the specific user's person.
      description: 'GraphQL endpoint: usersPersonProgramAdd'
      operationId: nsk_v1_users_userKey_person_programs_post
      parameters:
      - name: userKey
        in: path
        required: true
        description: The unique user key.
        schema:
          type: string
        x-position: 1
      requestBody:
        x-name: request
        description: The new program.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PersonCustomerProgramCreateRequest'
            examples:
              Person Customer Program Create Request:
                description: Example request for creating a person's customer program.
                value:
                  programCode: LOY
                  programNumber: '12345'
                  effectiveDate: '2026-07-10T00:00:00+00:00'
                  expirationDate: '2027-07-09T00:00:00+00:00'
                  default: true
                  programLevelCode: A
        required: true
        x-position: 2
      responses:
        '201':
          description: The item was created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '400':
          description: There was a problem with the request and it could not be completed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
              examples:
                With Invalid User Key:
                  description: The user key is not valid or does not exist.
                  value:
                    errors:
                    - id: null
                      code: nsk:Exceptions:InvalidKey
                      message: The identifier 'userKey' with value 'MTW' is invalid.
                      type: Validation
                      details:
                        userKey: MTW
                      rawMessage: The identifier 'userKey' with value 'MTW' is invalid.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                With Null Request:
                  description: Example response when attempting to call the endpoint with a null request
                  value:
                    errors:
                    - id: null
                      code: core:Validation:NullRequest
                      message: The request is null or couldn't be converted to the expected data type.
                      type: Error
                      details: null
                      rawMessage: The request is null or couldn't be converted to the expected data type.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                With Invalid Program Code:
                  description: The program code is not valid or does not exist.
                  value:
                    errors:
                    - id: null
                      code: nsk:Person:InvalidProgramCode
                      message: nsk:Person:InvalidProgramCode
                      type: Validation
                      details: null
                      rawMessage: The program code 'ZZZ' is invalid.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                With Invalid Program Level Code:
                  description: The program level code is not valid or does not exist.
                  value:
                    errors:
                    - id: null
                      code: nsk:Person:InvalidProgramLevelCode
                      message: nsk:Person:InvalidProgramLevelCode
                      type: Validation
                      details: null
                      rawMessage: The program level code 'ZZZ' is invalid.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
        '401':
          description: Authorization Not Allowed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
  /api/nsk/v1/users/{userKey}/person/programs/{personProgramKey}:
    get:
      tags:
      - users
      summary: Gets a specific program from the specific user's person.
      description: 'GraphQL endpoint: usersPersonProgram'
      operationId: nsk_v1_users_userKey_person_programs_personProgramKey_get
      parameters:
      - name: userKey
        in: path
        required: true
        description: The unique user key.
        schema:
          type: string
        x-position: 1
      - name: personProgramKey
        in: path
        required: true
        description: The unique person program key.
        schema:
          type: string
        x-position: 2
      responses:
        '404':
          description: The item was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponseOfPersonCustomerProgram'
    put:
      tags:
      - users
      summary: Updates a specific program on the specific user's person.
      description: 'GraphQL endpoint: usersPersonProgramSet'
      operationId: nsk_v1_users_userKey_person_programs_personProgramKey_put
      parameters:
      - name: userKey
        in: path
        required: true
        description: The unique user key.
        schema:
          type: string
        x-position: 1
      - name: personProgramKey
        in: path
        required: true
        description: The unique person program key.
        schema:
          type: string
        x-position: 2
      requestBody:
        x-name: request
        description: The modified program.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PersonCustomerProgramEditRequest'
            examples:
              Person Customer Program Edit Request:
                description: Example request for updating a person's customer program.
                value:
                  programNumber: '12345'
                  effectiveDate: '2026-07-10T00:00:00+00:00'
                  expirationDate: '2027-07-09T00:00:00+00:00'
                  default: true
                  programLevelCode: A
        required: true
        x-position: 3
      responses:
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '400':
          description: There was a problem with the request and it could not be completed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
              examples:
                With Invalid User Key:
                  description: The user key is not valid or does not exist.
                  value:
                    errors:
                    - id: null
                      code: nsk:Exceptions:InvalidKey
                      message: The identifier 'userKey' with value 'MTW' is invalid.
                      type: Validation
                      details:
                        userKey: MTW
                      rawMessage: The identifier 'userKey' with value 'MTW' is invalid.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                With Invalid Person Program Key:
                  description: The person program key is not valid or does not exist.
                  value:
                    errors:
                    - id: null
                      code: nsk:Exceptions:UpdateFailed
                      message: nsk:Exceptions:UpdateFailed
                      type: Validation
                      details: null
                      rawMessage: Attempted update of object 'PersonCustomerProgram' has failed. Please verify this object exists.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                With Invalid Program Level Code:
                  description: The program level code is not valid or does not exist.
                  value:
                    errors:
                    - id: null
                      code: nsk:Person:InvalidProgramLevelCode
                      message: nsk:Person:InvalidProgramLevelCode
                      type: Validation
                      details: null
                      rawMessage: The program level code 'ZZZ' is invalid.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                With Null Request:
                  description: Example response when attempting to call the endpoint with a null request
                  value:
                    errors:
                    - id: null
                      code: core:Validation:NullRequest
                      message: The request is null or couldn't be converted to the expected data type.
                      type: Error
                      details: null
                      rawMessage: The request is null or couldn't be converted to the expected data type.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
        '401':
          description: Authorization Not Allowed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '500':
          description: A server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
    patch:
      tags:
      - users
      summary: Patches a specific program on the specific user's person.
      description: 'GraphQL endpoint: usersPersonProgramModify'
      operationId: nsk_v1_users_userKey_person_programs_personProgramKey_patch
      parameters:
      - name: userKey
        in: path
        required: true
        description: The unique user key.
        schema:
          type: string
        x-position: 1
      - name: personProgramKey
        in: path
        required: true
        description: The unique person program key.
        schema:
          type: string
        x-position: 2
      requestBody:
        x-name: request
        description: The patched program.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeltaMapperOfPersonCustomerProgramEditRequest'
            examples:
              Person Customer Program Edit Request:
                description: Example request for updating a person's customer program.
                value:
                  programNumber: '12345'
                  effectiveDate: '2026-07-10T00:00:00+00:00'
                  expirationDate: '2027-07-09T00:00:00+00:00'
                  default: true
                  programLevelCode: A
        required: true
        x-position: 3
      responses:
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '400':
          description: There was a problem with the request and it could not be completed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
              examples:
                With Invalid User Key:
                  description: The user key is not valid or does not exist.
                  value:
                    errors:
                    - id: null
                      code: nsk:Exceptions:InvalidKey
                      message: The identifier 'userKey' with value 'MTW' is invalid.
                      type: Validation
                      details:
                        userKey: MTW
                      rawMessage: The identifier 'userKey' with value 'MTW' is invalid.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                With Invalid Person Program Key:
                  description: The person program key is not valid or does not exist.
                  value:
                    errors:
                    - id: null
                      code: nsk:Exceptions:InvalidKey
                      message: The identifier 'personProgramKey' with value 'MTW' is invalid.
                      type: Validation
                      details:
                        personProgramKey: MTW
                      rawMessage: The identifier 'personProgramKey' with value 'MTW' is invalid.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                With Invalid Program Level Code:
                  description: The program level code is not valid or does not exist.
                  value:
                    errors:
                    - id: null
                      code: nsk:Person:InvalidProgramLevelCode
                      message: nsk:Person:InvalidProgramLevelCode
                      type: Validation
                      details: null
                      rawMessage: The program level code 'ZZZ' is invalid.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                With Null Request:
                  description: Example response when attempting to call the endpoint with a null request
                  value:
                    errors:
                    - id: null
                      code: core:Validation:NullRequest
                      message: The request is null or couldn't be converted to the expected data type.
                      type: Error
                      details: null
                      rawMessage: The request is null or couldn't be converted to the expected data type.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
        '401':
          description: Authorization Not Allowed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '500':
          description: A server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
    delete:
      tags:
      - users
      summary: Deletes a specific program on the specific user's person.
      description: 'GraphQL endpoint: usersPersonProgramDelete'
      operationId: nsk_v1_users_userKey_person_programs_personProgramKey_delete
      parameters:
      - name: userKey
        in: path
        required: true
        description: The unique user key.
        schema:
          type: string
        x-position: 1
      - name: personProgramKey
        in: path
        required: true
        description: The unique person address key.
        schema:
          type: string
        x-position: 2
      responses:
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '400':
          description: There was a problem with the request and it could not be completed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
              examples:
                With Invalid User Key:
                  description: The user key is not valid or does not exist.
                  value:
                    errors:
                    - id: null
                      code: nsk:Exceptions:InvalidKey
                      message: The identifier 'userKey' with value 'MTW' is invalid.
                      type: Validation
                      details:
                        userKey: MTW
                      rawMessage: The identifier 'userKey' with value 'MTW' is invalid.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
        '401':
          description: Authorization Not Allowed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
  /api/nsk/v1/users/{userKey}/person/storedPayments:
    get:
      tags:
      - users
      summary: Gets all stored payments from the specific user's person.
      description: Gets all stored payments from the specific user's person.
      operationId: nsk_v1_users_userKey_person_storedPayments_get
      parameters:
      - name: userKey
        in: path
        required: true
        description: The unique user key.
        schema:
          type: string
        x-position: 1
      responses:
        '404':
          description: The item was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponseOfIListOfPersonStoredPayment'
    post:
      tags:
      - users
      summary: Creates a new stored payment on the specific user's person.
      description: 'GraphQL endpoint: usersPersonStoredPaymentAdd'
      operationId: nsk_v1_users_userKey_person_storedPayments_post
      parameters:
      - name: userKey
        in: path
        required: true
        description: The unique user key.
        schema:
          type: string
        x-position: 1
      requestBody:
        x-name: request
        description: The new stored payment.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PersonStoredPaymentRequest'
        required: true
        x-position: 2
      responses:
        '201':
          description: The item was created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
  /api/nsk/v1/users/{userKey}/person/storedPayments/{personStoredPaymentKey}:
    get:
      tags:
      - users
      summary: Gets a specific stored payment from the specific user's person.
      description: 'GraphQL endpoint: usersPersonStoredPayment'
      operationId: nsk_v1_users_userKey_person_storedPayments_personStoredPaymentKey_get
      parameters:
      - name: userKey
        in: path
        required: true
        description: The unique user key.
        schema:
          type: string
        x-position: 1
      - name: personStoredPaymentKey
        in: path
        required: true
        description: The unique person stored payment key.
        schema:
          type: string
        x-position: 2
      responses:
        '404':
          description: The item was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponseOfPersonStoredPayment'
    put:
      tags:
      - users
      summary: Updates a specific stored payment on the specific user's person.
      description: 'To update the account number please DELETE and POST a new stored payment.


        GraphQL endpoint: usersPersonStoredPaymentSet'
      operationId: nsk_v1_users_userKey_person_storedPayments_personStoredPaymentKey_put
      parameters:
      - name: userKey
        in: path
        required: true
        description: The unique user key.
        schema:
          type: string
        x-position: 1
      - name: personStoredPaymentKey
        in: path
        required: true
        description: The unique person stored payment key.
        schema:
          type: string
        x-position: 2
      requestBody:
        x-name: request
        description: The modified stored payment.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PersonStoredPaymentUpdateRequest'
        required: true
        x-position: 3
      responses:
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '500':
          description: A server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
    patch:
      tags:
      - users
      summary: Patches a specific stored payment on the specific user's person.
      description: 'To update the account number please DELETE and POST a new stored payment.


        GraphQL endpoint: usersPersonStoredPaymentModify'
      operationId: nsk_v1_users_userKey_person_storedPayments_personStoredPaymentKey_patch
      parameters:
      - name: userKey
        in: path
        required: true
        description: The unique user key.
        schema:
          type: string
        x-position: 1
      - name: personStoredPaymentKey
        in: path
        required: true
        description: The unique person stored payment key.
        schema:
          type: string
        x-position: 2
      requestBody:
        x-name: request
        description: The patched stored payment.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeltaMapperOfPersonStoredPaymentUpdateRequest'
        required: true
        x-position: 3
      responses:
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '500':
          description: A server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
    delete:
      tags:
      - users
      summary: Deletes a specific stored payment on the specific user's person.
      description: 'GraphQL endpoint: usersPersonStoredPaymentDelete'
      operationId: nsk_v1_users_userKey_person_storedPayments_personStoredPaymentKey_delete
      parameters:
      - name: userKey
        in: path
        required: true
        description: The unique user key.
        schema:
          type: string
        x-position: 1
      - name: personStoredPaymentKey
        in: path
        required: true
        description: The unique person stored payment key.
        schema:
          type: string
        x-position: 2
      responses:
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
  /api/nsk/v1/users/{userKey}/person/travelDocuments:
    get:
      tags:
      - users
      summary: Gets all travel documents from the specific user's person.
      description: Gets all travel documents from the specific user's person.
      operationId: nsk_v1_users_userKey_person_travelDocuments_get
      parameters:
      - name: userKey
        in: path
        required: true
        description: The unique user key.
        schema:
          type: string
        x-position: 1
      responses:
        '404':
          description: The item was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponseOfIListOfPersonTravelDocument'
    post:
      tags:
      - users
      summary: 'Creates a new travel document on the specific user''s person.

        Note: Gender and Date of Birth on the Travel Document will overwrite the values on the related person object.

        This is by design due to New Skies validation on the Gender property, and on the Travel Document

        Date of Birth being trusted over the person record Date of Birth.'
      description: 'GraphQL endpoint: usersPersonTravelDocumentAddv2'
      operationId: nsk_v1_users_userKey_person_travelDocuments_post
      parameters:
      - name: userKey
        in: path
        required: true
        description: The unique user key.
        schema:
          type: string
        x-position: 1
      requestBody:
        x-name: request
        description: The new travel document.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PersonTravelDocumentRequest'
            examples:
              Person Travel Document Request:
                description: Example request for creating a person's travel document.
                value:
                  default: true
                  documentTypeCode: P
                  birthCountry: US
                  issuedByCode: US
                  name:
                    first: John
                    middle: Cee
                    last: Doe
                    title: Mr.
                    suffix: null
                  nationality: US
                  expirationDate: '2034-07-09T05:55:15.9015943+00:00'
                  number: P12345678
                  issuedDate: '2024-07-09T05:55:15.9015969+00:00'
                  gender: 1
                  dateOfBirth: '2001-07-09T05:55:15.9015974+00:00'
                  declaredGender: Male
                  placeOfBirth: US
                  placeOfIssue: US
        required: true
        x-position: 2
      responses:
        '201':
          description: The item was created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '400':
          description: There was a problem with the request and it could not be completed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
              examples:
                With Invalid User Key:
                  description: The user key is not valid or does not exist.
                  value:
                    errors:
                    - id: null
                      code: nsk:Exceptions:InvalidKey
                      message: The identifier 'userKey' with value 'MTW' is invalid.
                      type: Validation
                      details:
                        userKey: MTW
                      rawMessage: The identifier 'userKey' with value 'MTW' is invalid.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                With Invalid Travel Document Type:
                  description: The travel document type provided is not valid or not configured in the system.
                  value:
                    errors:
                    - id: null
                      code: nsk:Person:InvalidTravelDocumentType
                      message: nsk:Person:InvalidTravelDocumentType
                      type: Validation
                      details: null
                      rawMessage: The document type code 'ZZZ' is invalid.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                With Duplicate Travel Document:
                  description: The travel document already exists.
                  value:
                    errors:
                    - id: null
                      code: nsk:Exceptions:DuplicateCreateFailed
                      message: nsk:Exceptions:DuplicateCreateFailed
                      type: Validation
                      details: null
                      rawMessage: Attempted create of object 'PersonTravelDocument' has failed. The object already exists.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                With Null Request:
                  description: Example response when attempting to call the endpoint with a null request
                  value:
                    errors:
                    - id: null
                      code: core:Validation:NullRequest
                      message: The request is null or couldn't be converted to the expected data type.
                      type: Error
                      details: null
                      rawMessage: The request is null or couldn't be converted to the expected data type.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
        '401':
          description: Authorization Not Allowed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
  /api/nsk/v1/users/{userKey}/person/travelDocuments/{personTravelDocumentKey}:
    get:
      tags:
      - users
      summary: Gets a specific travel document from the specific user's person.
      description: 'GraphQL endpoint: usersPersonTravelDocumentv2'
      operationId: nsk_v1_users_userKey_person_travelDocuments_personTravelDocumentKey_get
      parameters:
      - name: userKey
        in: path
        required: true
        description: The unique user key.
        schema:
          type: string
        x-position: 1
      - name: personTravelDocumentKey
        in: path
        required: true
        description: The unique person travel document key.
        schema:
          type: string
        x-position: 2
      responses:
        '404':
          description: The item was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponseOfPersonTravelDocument'
    delete:
      tags:
      - users
      summary: Deletes a specific travel document on the specific user's person.
      description: 'GraphQL endpoint: usersPersonTravelDocumentDeletev2'
      operationId: nsk_v1_users_userKey_person_travelDocuments_personTravelDocumentKey_delete
      parameters:
      - name: userKey
        in: path
        required: true
        description: The unique user key.
        schema:
          type: string
        x-position: 1
      - name: personTravelDocumentKey
        in: path
        required: true
        description: The unique person travel document key.
        schema:
          type: string
        x-position: 2
      responses:
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '400':
          description: There was a problem with the request and it could not be completed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
              examples:
                With Invalid User Key:
                  description: The user key is not valid or does not exist.
                  value:
                    errors:
                    - id: null
                      code: nsk:Exceptions:InvalidKey
                      message: The identifier 'userKey' with value 'MTW' is invalid.
                      type: Validation
                      details:
                        userKey: MTW
                      rawMessage: The identifier 'userKey' with value 'MTW' is invalid.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
        '401':
          description: Authorization Not Allowed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
  /api/nsk/v2/users/{userKey}/person/travelDocuments/{personTravelDocumentKey}:
    put:
      tags:
      - users
      summary: 'Updates a specific travel document on the specific user''s person.

        Note: Gender and Date of Birth on the Travel Document will overwrite the values on the related person object.

        This is by design due to New Skies validation on the Gender property, and on the Travel Document

        Date of Birth being trusted over the person record Date of Birth.'
      description: 'GraphQL endpoint: usersPersonTravelDocumentSetv2'
      operationId: nsk_v2_users_userKey_person_travelDocuments_personTravelDocumentKey_put
      parameters:
      - name: userKey
        in: path
        required: true
        description: The unique user key.
        schema:
          type: string
        x-position: 1
      - name: personTravelDocumentKey
        in: path
        required: true
        description: The unique person travel document key.
        schema:
          type: string
        x-position: 2
      requestBody:
        x-name: request
        description: The modified travel document.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TravelDocumentEditRequestv2'
            examples:
              Person Travel Document Edit Request:
                description: Example request for updating a person's travel document.
                value:
                  birthCountry: US
                  name:
                    first: John
                    middle: Cee
                    last: Doe
                    title: Mr.
                    suffix: null
                  nationality: US
                  expirationDate: '2034-07-09T05:55:15.933836+00:00'
                  number: P12345678
                  issuedDate: '2024-07-09T05:55:15.9338714+00:00'
                  default: true
                  gender: 1
                  dateOfBirth: '2001-07-09T05:55:15.933929+00:00'
                  declaredGender: Male
                  placeOfBirth: US
                  placeOfIssue: US
        required: true
        x-position: 3
      responses:
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '400':
          description: There was a problem with the request and it could not be completed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
              examples:
                With Invalid User Key:
                  description: The user key is not valid or does not exist.
                  value:
                    errors:
                    - id: null
                      code: nsk:Exceptions:InvalidKey
                      message: The identifier 'userKey' with value 'MTW' is invalid.
                      type: Validation
                      details:
                        userKey: MTW
                      rawMessage: The identifier 'userKey' with value 'MTW' is invalid.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                With Invalid Person Travel Document Key:
                  description: The travel document key is not valid or does not exist.
                  value:
                    errors:
                    - id: null
                      code: nsk:Exceptions:InvalidKey
                      message: The identifier 'personTravelDocumentKey' with value 'MTW' is invalid.
                      type: Validation
                      details:
                        personTravelDocumentKey: MTW
                      rawMessage: The identifier 'personTravelDocumentKey' with value 'MTW' is invalid.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                With Null Request:
                  description: Example response when attempting to call the endpoint with a null request
                  value:
                    errors:
                    - id: null
                      code: core:Validation:NullRequest
                      message: The request is null or couldn't be converted to the expected data type.
                      type: Error
                      details: null
                      rawMessage: The request is null or couldn't be converted to the expected data type.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
        '401':
          description: Authorization Not Allowed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '500':
          description: A server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
    patch:
      tags:
      - users
      summary: 'Patches a specific travel document on the specific user''s person.

        Note: Gender and Date of Birth on the Travel Document will overwrite the values on the related person object.

        This is by design due to New Skies validation on the Gender property, and on the Travel Document

        Date of Birth being trusted over the person record Date of Birth.'
      description: 'GraphQL endpoint: usersPersonTravelDocumentModifyv2'
      operationId: nsk_v2_users_userKey_person_travelDocuments_personTravelDocumentKey_patch
      parameters:
      - name: userKey
        in: path
        required: true
        description: The unique user key.
        schema:
          type: string
        x-position: 1
      - name: personTravelDocumentKey
        in: path
        required: true
        description: The unique person travel document key.
        schema:
          type: string
        x-position: 2
      requestBody:
        x-name: request
        description: The patched travel document.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeltaMapperOfTravelDocumentEditRequestv2'
            examples:
              Person Travel Document Edit Request:
                description: Example request for updating a person's travel document.
                value:
                  birthCountry: US
                  name:
                    first: John
                    middle: Cee
                    last: Doe
                    title: Mr.
                    suffix: null
                  nationality: US
                  expirationDate: '2034-07-09T05:55:15.9376019+00:00'
                  number: P12345678
                  issuedDate: '2024-07-09T05:55:15.937603+00:00'
                  default: true
                  gender: 1
                  dateOfBirth: '2001-07-09T05:55:15.9376033+00:00'
                  declaredGender: Male
                  placeOfBirth: US
                  placeOfIssue: US
        required: true
        x-position: 3
      responses:
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '400':
          description: There was a problem with the request and it could not be completed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
              examples:
                With Invalid User Key:
                  description: The user key is not valid or does not exist.
                  value:
                    errors:
                    - id: null
                      code: nsk:Exceptions:InvalidKey
                      message: The identifier 'userKey' with value 'MTW' is invalid.
                      type: Validation
                      details:
                        userKey: MTW
                      rawMessage: The identifier 'userKey' with value 'MTW' is invalid.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                With Invalid Person Travel Document Key:
                  description: The travel document key is not valid or does not exist.
                  value:
                    errors:
                    - id: null
                      code: nsk:Exceptions:InvalidKey
                      message: The identifier 'personTravelDocumentKey' with value 'MTW' is invalid.
                      type: Validation
                      details:
                        personTravelDocumentKey: MTW
                      rawMessage: The identifier 'personTravelDocumentKey' with value 'MTW' is invalid.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                With Null Request:
                  description: Example response when attempting to call the endpoint with a null request
                  value:
                    errors:
                    - id: null
                      code: core:Validation:NullRequest
                      message: The request is null or couldn't be converted to the expected data type.
                      type: Error
                      details: null
                      rawMessage: The request is null or couldn't be converted to the expected data type.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
        '401':
          description: Authorization Not Allowed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '500':
          description: A server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
  /api/nsk/v1/users/{userKey}/person/travelNotifications:
    get:
      tags:
      - users
      summary: Gets person travel notifications for a user's person.
      description: 'GraphQL endpoint: usersPersonTravelNotifications'
      operationId: nsk_v1_users_userKey_person_travelNotifications_get
      parameters:
      - name: userKey
        in: path
        required: true
        description: The user key.
        schema:
          type: string
        x-position: 1
      responses:
        '404':
          description: The item was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponseOfIListOfPersonTravelNotification'
    post:
      tags:
      - users
      summary: Creates a person travel notification for a user's person.
      description: 'GraphQL endpoint: usersPersonTravelNotificationAdd'
      operationId: nsk_v1_users_userKey_person_travelNotifications_post
      parameters:
      - name: userKey
        in: path
        required: true
        description: The user key.
        schema:
          type: string
        x-position: 1
      requestBody:
        x-name: request
        description: The travel notification create request.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TravelNotificationCreateRequest'
        required: true
        x-position: 2
      responses:
        '201':
          description: The item was created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
  /api/nsk/v1/users/{userKey}/person/travelNotifications/{travelNotificationKey}:
    get:
      tags:
      - users
      summary: Gets a person travel notification for a user's person.
      description: 'GraphQL endpoint: usersPersonTravelNotification'
      operationId: nsk_v1_users_userKey_person_travelNotifications_travelNotificationKey_get
      parameters:
      - name: userKey
        in: path
        required: true
        description: The user key.
        schema:
          type: string
        x-position: 1
      - name: travelNotificationKey
        in: path
        required: true
        description: The person travel notification key.
        schema:
          type: string
        x-position: 2
      responses:
        '404':
          description: The item was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponseOfPersonTravelNotification'
    put:
      tags:
      - users
      summary: Updates a person travel notification for a user's person.
      description: 'GraphQL endpoint: usersPersonTravelNotificationSet'
      operationId: nsk_v1_users_userKey_person_travelNotifications_travelNotificationKey_put
      parameters:
      - name: userKey
        in: path
        required: true
        description: The user key.
        schema:
          type: string
        x-position: 1
      - name: travelNotificationKey
        in: path
        required: true
        description: The travel notification key.
        schema:
          type: string
        x-position: 2
      requestBody:
        x-name: request
        description: The travel notification edit request.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TravelNotificationEditRequest'
        required: true
        x-position: 3
      responses:
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '500':
          description: A server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
    patch:
      tags:
      - users
      summary: Patches a person travel notification for a user's person.
      description: 'GraphQL endpoint: usersPersonTravelNotificationModify'
      operationId: nsk_v1_users_userKey_person_travelNotifications_travelNotificationKey_patch
      parameters:
      - name: userKey
        in: path
        required: true
        description: The user key.
        schema:
          type: string
        x-position: 1
      - name: travelNotificationKey
        in: path
        required: true
        description: The travel notification key.
        schema:
          type: string
        x-position: 2
      requestBody:
        x-name: request
        description: The delta mapper travel notification edit request.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeltaMapperOfTravelNotificationEditRequest'
        required: true
        x-position: 3
      responses:
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '500':
          description: A server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
    delete:
      tags:
      - users
      summary: Deletes a person travel notification for a user's person.
      description: 'GraphQL endpoint: usersPersonTravelNotificationDelete'
      operationId: nsk_v1_users_userKey_person_travelNotifications_travelNotificationKey_delete
      parameters:
      - name: userKey
        in: path
        required: true
        description: The user key.
        schema:
          type: string
        x-position: 1
      - name: travelNotificationKey
        in: path
        required: true
        description: The travel notification key.
        schema:
          type: string
        x-position: 2
      responses:
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
  /api/nsk/v1/users/{userKey}/person/travelNotifications/{travelNotificationKey}/events:
    get:
      tags:
      - users
      summary: Gets notification events for a person travel notification for a user's person.
      description: 'GraphQL endpoint: usersPersonNotificationEvents'
      operationId: nsk_v1_users_userKey_person_travelNotifications_travelNotificationKey_events_get
      parameters:
      - name: userKey
        in: path
        required: true
        description: The user key.
        schema:
          type: string
        x-position: 1
      - name: travelNotificationKey
        in: path
        required: true
        description: The travel notification key.
        schema:
          type: string
        x-position: 2
      responses:
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponseOfIListOfNotificationEvent'
        '404':
          description: The item was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
    post:
      tags:
      - users
      summary: Creates a notification event for a person travel notification for a user's person.
      description: 'GraphQL endpoint: usersPersonNotificationEventAdd'
      operationId: nsk_v1_users_userKey_person_travelNotifications_travelNotificationKey_events_post
      parameters:
      - name: userKey
        in: path
        required: true
        description: The user key.
        schema:
          type: string
        x-position: 1
      - name: travelNotificationKey
        in: path
        required: true
        description: The travel notification key.
        schema:
          type: string
        x-position: 2
      requestBody:
        x-name: request
        description: The notification event create request.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationEventCreateRequest'
        required: true
        x-position: 3
      responses:
        '201':
          description: The item was created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
  /api/nsk/v1/users/{userKey}/person/travelNotifications/{travelNotificationKey}/events/{eventType}:
    get:
      tags:
      - users
      summary: Gets a notification event for a person travel notification for a user's person.
      description: 'GraphQL endpoint: usersPersonNotificationEvent'
      operationId: nsk_v1_users_userKey_person_travelNotifications_travelNotificationKey_events_eventType_get
      parameters:
      - name: userKey
        in: path
        required: true
        description: The user key.
        schema:
          type: string
        x-position: 1
      - name: travelNotificationKey
        in: path
        required: true
        description: The travel notification key.
        schema:
          type: string
        x-position: 2
      - name: eventType
        in: path
        required: true
        description: "The event type. \nEnumeration values: 0 = DepartureDelay, 1 = ArrivalDelay, 2 = ScheduleChange, 3 = CheckIn, 4 = GateInformation"
        schema:
          $ref: '#/components/schemas/NotificationEventType'
        x-position: 3
      responses:
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponseOfNotificationEvent'
        '404':
          description: The item was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
    delete:
      tags:
      - users
      summary: Deletes a notification event from a person travel notification for a user's person.
      description: 'GraphQL endpoint: usersPersonNotificationEventDelete'
      operationId: nsk_v1_users_userKey_person_travelNotifications_travelNotificationKey_events_eventType_delete
      parameters:
      - name: userKey
        in: path
        required: true
        description: The user key.
        schema:
          type: string
        x-position: 1
      - name: travelNotificationKey
        in: path
        required: true
        description: The travel notification key.
        schema:
          type: string
        x-position: 2
      - name: eventType
        in: path
        required: true
        description: "The notification event type. \nEnumeration values: 0 = DepartureDelay, 1 = ArrivalDelay, 2 = ScheduleChange, 3 = CheckIn, 4 = GateInformation"
        schema:
          $ref: '#/components/schemas/NotificationEventType'
        x-position: 3
      responses:
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
  /api/nsk/v1/users/{userKey}/person/travelNotifications/{travelNotificationKey}/timedEvents:
    get:
      tags:
      - users
      summary: Gets notification timed events for a person travel notification for a user's person.
      description: 'GraphQL endpoint: usersPersonNotificationTimedEvents'
      operationId: nsk_v1_users_userKey_person_travelNotifications_travelNotificationKey_timedEvents_get
      parameters:
      - name: userKey
        in: path
        required: true
        description: The user key.
        schema:
          type: string
        x-position: 1
      - name: travelNotificationKey
        in: path
        required: true
        description: The travel notification key.
        schema:
          type: string
        x-position: 2
      responses:
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponseOfIListOfNotificationTimedEvent'
        '404':
          description: The item was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
    post:
      tags:
      - users
      summary: Creates a notification timed event for a person travel notification for a user's person.
      description: 'GraphQL endpoint: usersPersonNotificationTimedEventAdd'
      operationId: nsk_v1_users_userKey_person_travelNotifications_travelNotificationKey_timedEvents_post
      parameters:
      - name: userKey
        in: path
        required: true
        description: The user key.
        schema:
          type: string
        x-position: 1
      - name: travelNotificationKey
        in: path
        required: true
        description: The travel notification key.
        schema:
          type: string
        x-position: 2
      requestBody:
        x-name: request
        description: The notification timed even create request.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationTimedEventCreateRequest'
        required: true
        x-position: 3
      responses:
        '201':
          description: The item was created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
  /api/nsk/v1/users/{userKey}/person/travelNotifications/{travelNotificationKey}/timedEvents/{timedEventType}:
    get:
      tags:
      - users
      summary: Gets a notification timed event for a person travel notification for a user's person.
      description: 'GraphQL endpoint: usersPersonNotificationTimedEvent'
      operationId: nsk_v1_users_userKey_person_travelNotifications_travelNotificationKey_timedEvents_timedEventType_get
      parameters:
      - name: userKey
        in: path
        required: true
        description: The user key.
        schema:
          type: string
        x-position: 1
      - name: travelNotificationKey
        in: path
        required: true
        description: The travel notification key.
        schema:
          type: string
        x-position: 2
      - name: timedEventType
        in: path
        required: true
        description: "The timed event type. \nEnumeration values: 0 = Departure, 1 = Arrival"
        schema:
          $ref: '#/components/schemas/NotificationTimedEventType'
        x-position: 3
      responses:
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponseOfNotificationTimedEvent'
        '404':
          description: The item was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
    put:
      tags:
      - users
      summary: Updates a notification timed event for a person travel notification for a user's person.
      description: 'GraphQL endpoint: usersPersonNotificationTimedEventSet'
      operationId: nsk_v1_users_userKey_person_travelNotifications_travelNotificationKey_timedEvents_timedEventType_put
      parameters:
      - name: userKey
        in: path
        required: true
        description: The user key.
        schema:
          type: string
        x-position: 1
      - name: travelNotificationKey
        in: path
        required: true
        description: The travel notification key.
        schema:
          type: string
        x-position: 2
      - name: timedEventType
        in: path
        required: true
        description: "The notification timed event type. \nEnumeration values: 0 = Departure, 1 = Arrival"
        schema:
          $ref: '#/components/schemas/NotificationTimedEventType'
        x-position: 3
      requestBody:
        x-name: request
        description: The updated notification timed event request.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationTimedEventEditRequest'
        required: true
        x-position: 4
      responses:
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '500':
          description: A server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
    delete:
      tags:
      - users
      summary: Deletes a notification timed event from a person travel notification for a user's person.
      description: 'GraphQL endpoint: usersPersonNotificationTimedEventDelete'
      operationId: nsk_v1_users_userKey_person_travelNotifications_travelNotificationKey_timedEvents_timedEventType_delete
      parameters:
      - name: userKey
        in: path
        required: true
        description: The user key.
        schema:
          type: string
        x-position: 1
      - name: travelNotificationKey
        in: path
        required: true
        description: The travel notification key.
        schema:
          type: string
        x-position: 2
      - name: timedEventType
        in: path
        required: true
        description: "The notification timed event type. \nEnumeration values: 0 = Departure, 1 = Arrival"
        schema:
          $ref: '#/components/schemas/NotificationTimedEventType'
        x-position: 3
      responses:
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
  /api/nsk/v1/users/{userKey}/preferences/skySpeedSettings:
    get:
      tags:
      - users
      summary: Retrieves the default SkySpeed settings user preferences of the specified user.
      description: 'GraphQL endpoint: usersPreferencesSkySpeedSettings'
      operationId: nsk_v1_users_userKey_preferences_skySpeedSettings_get
      parameters:
      - name: userKey
        in: path
        required: true
        description: The unique identifier of the user.
        schema:
          type: string
        x-position: 1
      responses:
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponseOfSkySpeedSettingsUserPreferences'
        '404':
          description: The item was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
      deprecated: true
    put:
      tags:
      - users
      summary: Updates the default SkySpeed settings user preferences of the specified user.
      description: 'If the SkySpeed settings of the current user is disabled and an update is made,

        the settings will automatically be enabled and updated.


        If given, each string property is validated if it exists and is active.


        The collection currency setting can only be CollectionCurrencySetting.None if the collection currency code is

        null or empty.


        A bad request will be returned if the collection currency code and collection currency setting are:

        - Collection Currency Code is not null or empty and the Collection Currency Setting is set to

        CollectionCurrency.None.

        - Collection Currency Code is null or empty and the Collection Currency Setting is set to

        CollectionCurrency.Both (Any value except for CollectionCurrencySetting.None).


        GraphQL endpoint: usersPreferencesSkySpeedSettingsSet'
      operationId: nsk_v1_users_userKey_preferences_skySpeedSettings_put
      parameters:
      - name: userKey
        in: path
        required: true
        description: The unique identifier of the user.
        schema:
          type: string
        x-position: 1
      requestBody:
        x-name: request
        description: The SkySpeed settings user preferences.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SkySpeedSettingsUserPreferences'
        required: true
        x-position: 2
      responses:
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '404':
          description: The item was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
      deprecated: true
  /api/nsk/v2/users/{userKey}/preferences/skySpeedSettings:
    get:
      tags:
      - users
      summary: Retrieves the default SkySpeed settings user preferences of the specified user.
      description: 'GraphQL endpoint: usersPreferencesSkySpeedSettingsv2'
      operationId: nsk_v2_users_userKey_preferences_skySpeedSettings_get
      parameters:
      - name: userKey
        in: path
        required: true
        description: The unique identifier of the user.
        schema:
          type: string
        x-position: 1
      responses:
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponseOfSkySpeedSettingsUserPreferences'
              examples:
                Sky Speed preferences found.:
                  description: Example response when Sky Speed preferences are successfully retrieved.
                  value:
                    data:
                      currencyCode: USD
                      cultureCode: en-US
                      countryCode: US
                      nationality: US
                      collectionCurrencyCode: EUR
                      collectionCurrencySetting: 2
                      flightResultFareType: 1
        '404':
          description: The item was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
              examples:
                Sky Speed preferences not found:
                  description: Example response when a GET returns a 404 not found HTTP status code.
                  value:
                    data: null
    put:
      tags:
      - users
      summary: Updates the default SkySpeed settings user preferences of the specified user.
      description: 'If the SkySpeed settings of the current user is disabled and an update is made,

        the settings will automatically be enabled and updated.


        If given, each string property is validated if it exists and is active.


        The collection currency setting can only be CollectionCurrencySetting.None if the collection currency code is

        null or empty.


        A bad request will be returned if the collection currency code and collection currency setting are:

        - Collection Currency Code is not null or empty and the Collection Currency Setting is set to

        CollectionCurrency.None.

        - Collection Currency Code is null or empty and the Collection Currency Setting is set to

        CollectionCurrency.Both (Any value except for CollectionCurrencySetting.None).


        GraphQL endpoint: usersPreferencesSkySpeedSettingsSetv2'
      operationId: nsk_v2_users_userKey_preferences_skySpeedSettings_put
      parameters:
      - name: userKey
        in: path
        required: true
        description: The unique identifier of the user.
        schema:
          type: string
        x-position: 1
      requestBody:
        x-name: request
        description: The SkySpeed settings user preferences.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SkySpeedSettingsUserPreferences'
            examples:
              Update Sky Speed settings:
                description: Example request for updating Sky Speed user settings preferences.
                value:
                  currencyCode: USD
                  cultureCode: en-US
                  countryCode: US
                  nationality: US
                  collectionCurrencyCode: EUR
                  collectionCurrencySetting: 3
                  flightResultFareType: 0
        required: true
        x-position: 2
      responses:
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
              examples:
                Sky Speed preferences updated:
                  description: Example response when update is successful.
                  value:
                    data: null
        '400':
          description: There was a problem with the request and it could not be completed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
              examples:
                String length attribute errors:
                  description: Example response when a request property string length is too long.
                  value:
                    errors:
                    - id: null
                      code: SkySpeedSettingsUserPreferences.CurrencyCode:StringLengthAttribute
                      message: SkySpeedSettingsUserPreferences.CurrencyCode:StringLengthAttribute
                      type: Validation
                      details:
                        member: CurrencyCode
                        model: SkySpeedSettingsUserPreferences
                        validation: StringLengthAttribute
                      rawMessage: The field SkySpeedSettingsUserPreferences must be a string with a maximum length of 3.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                    - id: null
                      code: SkySpeedSettingsUserPreferences.CultureCode:StringLengthAttribute
                      message: SkySpeedSettingsUserPreferences.CultureCode:StringLengthAttribute
                      type: Validation
                      details:
                        member: CultureCode
                        model: SkySpeedSettingsUserPreferences
                        validation: StringLengthAttribute
                      rawMessage: The field SkySpeedSettingsUserPreferences must be a string with a maximum length of 3.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                    - id: null
                      code: SkySpeedSettingsUserPreferences.CountryCode:StringLengthAttribute
                      message: SkySpeedSettingsUserPreferences.CountryCode:StringLengthAttribute
                      type: Validation
                      details:
                        member: CountryCode
                        model: SkySpeedSettingsUserPreferences
                        validation: StringLengthAttribute
                      rawMessage: The field SkySpeedSettingsUserPreferences must be a string with a maximum length of 3.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                    - id: null
                      code: SkySpeedSettingsUserPreferences.Nationality:StringLengthAttribute
                      message: SkySpeedSettingsUserPreferences.Nationality:StringLengthAttribute
                      type: Validation
                      details:
                        member: Nationality
                        model: SkySpeedSettingsUserPreferences
                        validation: StringLengthAttribute
                      rawMessage: The field SkySpeedSettingsUserPreferences must be a string with a maximum length of 3.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                    - id: null
                      code: SkySpeedSettingsUserPreferences.CollectionCurrencyCode:StringLengthAttribute
                      message: SkySpeedSettingsUserPreferences.CollectionCurrencyCode:StringLengthAttribute
                      type: Validation
                      details:
                        member: CollectionCurrencyCode
                        model: SkySpeedSettingsUserPreferences
                        validation: StringLengthAttribute
                      rawMessage: The field SkySpeedSettingsUserPreferences must be a string with a maximum length of 3.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                    data: null
                Invalid request codes:
                  description: Example response when certain codes have invalid data.
                  value:
                    errors:
                    - id: null
                      code: nsk:UserPreferences:SkySpeedSettings:InvalidCurrencyCode
                      message: The currency code `AAA` does not exist or is inactive.
                      type: null
                      details:
                        currencyCode: AAA
                      rawMessage: null
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                    - id: null
                      code: nsk:UserPreferences:SkySpeedSettings:InvalidCultureCode
                      message: The culture code `AS-ASD` does not exist or is inactive.
                      type: null
                      details:
                        cultureCode: AS-ASD
                      rawMessage: null
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                    - id: null
                      code: nsk:UserPreferences:SkySpeedSettings:InvalidCountryCode
                      message: The country code `QQ` does not exist or is inactive.
                      type: null
                      details:
                        countryCode: QQ
                      rawMessage: null
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                    - id: null
                      code: nsk:UserPreferences:SkySpeedSettings:InvalidNationality
                      message: The nationality `QQ` does not exist or is inactive.
                      type: null
                      details:
                        nationality: QQ
                      rawMessage: null
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                    - id: null
                      code: nsk:UserPreferences:SkySpeedSettings:InvalidCollectionCurrencyCode
                      message: The collection currency code `AAA` does not exist or is inactive.
                      type: null
                      details:
                        collectionCurrencyCode: AAA
                      rawMessage: null
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                    data: null
                Enum out of range error code:
                  description: Example response when an enumeration request value is out of the expected enumeration values.
                  value:
                    errors:
                    - id: null
                      code: core:Validation:EnumOutOfRange
                      message: core:Validation:EnumOutOfRange
                      type: Validation
                      details:
                        name: CollectionCurrencySetting
                        value: '6'
                      rawMessage: The enum 'CollectionCurrencySetting' contains an invalid value of '6'.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                    data: null
                Invalid collected currency code and setting combination.:
                  description: Example response when an invalid combination of collected currency code and setting is requested.
                  value:
                    errors:
                    - id: null
                      code: nsk:UserPreferences:SkySpeedSettings:InvalidCollectionCurrencyCodeAndSetting
                      message: nsk:UserPreferences:SkySpeedSettings:InvalidCollectionCurrencyCodeAndSetting
                      type: null
                      details:
                        collectionCurrencyCode: USD
                        collectionCurrencyCodeSetting: None
                      rawMessage: The collection currency code `USD` and setting `None` are invalid.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                    data: null
                Null request.:
                  description: Example response when null request is received by the endpoint.
                  value:
                    errors:
                    - id: null
                      code: nsk:UserPreferences:SkySpeedSettings:SkySpeedSettingsUserPreferencesRequired
                      message: nsk:UserPreferences:SkySpeedSettings:SkySpeedSettingsUserPreferencesRequired
                      type: Error
                      details: null
                      rawMessage: The SkySpeedSettingsUserPreferences is required.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                    data: null
  /api/nsk/v1/users/{userKey}/roles:
    get:
      tags:
      - users
      summary: Gets all roles for a specific user.
      description: Gets all roles for a specific user.
      operationId: nsk_v1_users_userKey_roles_get
      parameters:
      - name: userKey
        in: path
        required: true
        description: The unique user key.
        schema:
          type: string
        x-position: 1
      responses:
        '404':
          description: The item was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponseOfIListOfUserRole'
    post:
      tags:
      - users
      summary: Creates a new role for a specific user.
      description: 'GraphQL endpoint: usersRoleAdd'
      operationId: nsk_v1_users_userKey_roles_post
      parameters:
      - name: userKey
        in: path
        required: true
        description: The unique user key.
        schema:
          type: string
        x-position: 1
      requestBody:
        x-name: request
        description: The new role.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserRoleCreateRequest'
        required: true
        x-position: 2
      responses:
        '201':
          description: The item was created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
  /api/nsk/v1/users/{userKey}/roles/{userRoleKey}:
    get:
      tags:
      - users
      summary: Gets a specific role for a specific user.
      description: 'GraphQL endpoint: usersRole'
      operationId: nsk_v1_users_userKey_roles_userRoleKey_get
      parameters:
      - name: userKey
        in: path
        required: true
        description: The unique user key.
        schema:
          type: string
        x-position: 1
      - name: userRoleKey
        in: path
        required: true
        description: The unique user role key
        schema:
          type: string
        x-position: 2
      responses:
        '404':
          description: The item was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponseOfUserRole'
    put:
      tags:
      - users
      summary: Updates a specific role for a specific user.
      description: 'GraphQL endpoint: usersRoleSet'
      operationId: nsk_v1_users_userKey_roles_userRoleKey_put
      parameters:
      - name: userKey
        in: path
        required: true
        description: The unique user key.
        schema:
          type: string
        x-position: 1
      - name: userRoleKey
        in: path
        required: true
        description: The unique user role key.
        schema:
          type: string
        x-position: 2
      requestBody:
        x-name: request
        description: The modified role.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserRoleEditRequest'
        required: true
        x-position: 3
      responses:
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '500':
          description: A server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
    patch:
      tags:
      - users
      summary: Patches a specific role for a specific user.
      description: 'GraphQL endpoint: usersRoleModify'
      operationId: nsk_v1_users_userKey_roles_userRoleKey_patch
      parameters:
      - name: userKey
        in: path
        required: true
        description: The unique user key.
        schema:
          type: string
        x-position: 1
      - name: userRoleKey
        in: path
        required: true
        description: The unique user role key.
        schema:
          type: string
        x-position: 2
      requestBody:
        x-name: request
        description: The patched role.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeltaMapperOfUserRolePatchRequest'
        required: true
        x-position: 3
      responses:
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '500':
          description: A server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
    delete:
      tags:
      - users
      summary: Deletes a specific role for a specific user.
      description: 'GraphQL endpoint: usersRoleDelete'
      operationId: nsk_v1_users_userKey_roles_userRoleKey_delete
      parameters:
      - name: userKey
        in: path
        required: true
        description: The unique user key.
        schema:
          type: string
        x-position: 1
      - name: userRoleKey
        in: path
        required: true
        description: The unique user role key.
        schema:
          type: string
        x-position: 2
      responses:
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
  /api/nsk/v1/users/byPerson/{personKey}:
    get:
      tags:
      - users
      summary: Retrieves the a specific user by the person key.
      description: 'GraphQL endpoint: usersByPerson'
      operationId: nsk_v1_users_byPerson_personKey_get
      parameters:
      - name: personKey
        in: path
        required: true
        description: The person key of the user to retrieve.
        schema:
          type: string
        x-position: 1
      responses:
        '404':
          description: The item was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponseOfUser'
components:
  schemas:
    NotificationTimedEventEditRequest:
      type: object
      description: "A travel notification timed event edit request.\n            "
      additionalProperties: false
      properties:
        minutesToEvent:
          type: integer
          description: "The minutes to the event.\n            "
          format: int32
    Person:
      type: object
      description: "Defines a person.\n            "
      additionalProperties: false
      required:
      - name
      properties:
        name:
          description: "The persons true name.\n            "
          $ref: '#/components/schemas/PersonName'
        emailAddresses:
          type:
          - array
          - 'null'
          description: "The collection of registered email address.\n            "
          items:
            $ref: '#/components/schemas/PersonEmail'
        phoneNumbers:
          type:
          - array
          - 'null'
          description: "The collection of registered phone numbers.\n            "
          items:
            $ref: '#/components/schemas/PersonPhoneNumber'
        addresses:
          type:
          - array
          - 'null'
          description: "The collection of known addresses.\n            "
          items:
            $ref: '#/components/schemas/PersonAddress'
        storedPayments:
          type:
          - array
          - 'null'
          description: "The collection of registered stored payments.\n            "
          items:
            $ref: '#/components/schemas/PersonStoredPayment'
        travelDocuments:
          type:
          - array
          - 'null'
          description: "The collection of registered travel documents.\n            "
          items:
            $ref: '#/components/schemas/PersonTravelDocument'
        programs:
          type:
          - array
          - 'null'
          description: "The collection of enrolled customer programs.\n            "
          items:
            $ref: '#/components/schemas/PersonCustomerProgram'
        comments:
          type:
          - array
          - 'null'
          description: "The collection of comments.\n            "
          items:
            $ref: '#/components/schemas/PersonComment'
        preferences:
          type:
          - array
          - 'null'
          description: "The collection of preferences.\n            "
          items:
            $ref: '#/components/schemas/PersonPreference'
        aliases:
          type:
          - array
          - 'null'
          description: "The collection of alternate names for the person.\n            "
          items:
            $ref: '#/components/schemas/PersonAlias'
        affiliates:
          type:
          - array
          - 'null'
          description: "The collection of affiliations for the person.\n            "
          items:
            $ref: '#/components/schemas/PersonAffiliation'
        customerNumber:
          type:
          - string
          - 'null'
          description: "The unique person customer number.\n            "
          maxLength: 20
          minLength: 0
        type:
          description: "The type of person.\n            "
          $ref: '#/components/schemas/PersonType'
        status:
          description: "The status of the person.\n            "
          $ref: '#/components/schemas/PersonStatus'
        details:
          description: "The person's basic information.\n            "
          $ref: '#/components/schemas/PersonBasicInformation'
        notificationPreference:
          description: "The person's notification preference.\n            "
          $ref: '#/components/schemas/NotificationPreference'
        personKey:
          type:
          - string
          - 'null'
          description: "The unique person key.\n            "
        createdDate:
          type: string
          description: "The date the record was created.\n            "
          format: date-time
    FlightResultFareType:
      type: integer
      description: "Defines which fares will be included in the flight results.\n            \n\n0 = All\n1 = Monetary\n2 = Loyalty"
      x-enumNames:
      - All
      - Monetary
      - Loyalty
      enum:
      - 0
      - 1
      - 2
    IJsonResponseOfIListOfPersonStoredPayment:
      type: object
      description: "Defines the JSON response contract.\n            "
      additionalProperties: false
      properties:
        data:
          type:
          - array
          - 'null'
          description: "The payload data.\n            "
          items:
            $ref: '#/components/schemas/PersonStoredPayment'
        errors:
          type:
          - array
          - 'null'
          description: "The collection of errors being thrown.\n            "
          items:
            $ref: '#/components/schemas/ErrorResponse'
        messages:
          type:
          - array
          - 'null'
          description: "The collection of informational messages.\n            "
          items:
            $ref: '#/components/schemas/Message'
    IJsonResponseOfIListOfPersonCustomerProgram:
      type: object
      description: "Defines the JSON response contract.\n            "
      additionalProperties: false
      properties:
        data:
          type:
          - array
          - 'null'
          description: "The payload data.\n            "
          items:
            $ref: '#/components/schemas/PersonCustomerProgram'
        errors:
          type:
          - array
          - 'null'
          description: "The collection of errors being thrown.\n            "
          items:
            $ref: '#/components/schemas/ErrorResponse'
        messages:
          type:
          - array
          - 'null'
          description: "The collection of informational messages.\n            "
          items:
            $ref: '#/components/schemas/Message'
    IJsonResponseOfIListOfPersonTravelNotification:
      type: object
      description: "Defines the JSON response contract.\n            "
      additionalProperties: false
      properties:
        data:
          type:
          - array
          - 'null'
          description: "The payload data.\n            "
          items:
            $ref: '#/components/schemas/PersonTravelNotification'
        errors:
          type:
          - array
          - 'null'
          description: "The collection of errors being thrown.\n            "
          items:
            $ref: '#/components/schemas/ErrorResponse'
        messages:
          type:
          - array
          - 'null'
          description: "The collection of informational messages.\n            "
          items:
            $ref: '#/components/schemas/Message'
    PersonStatus:
      type: integer
      description: "The status of the person.\n            \n\n0 = Active\n1 = Terminated\n2 = Suspended"
      x-enumNames:
      - Active
      - Terminated
      - Suspended
      enum:
      - 0
      - 1
      - 2
    PersonAddress:
      type: object
      description: "Defines a unique person address.\n            "
      additionalProperties: false
      required:
      - addressTypeCode
      properties:
        addressTypeCode:
          type: string
          description: "The type of address.\nPlease note that this should be a char and not a string.\n            "
          maxLength: 1
          minLength: 1
        default:
          type: boolean
          description: "Flag indicating if the address is the persons default.\n            "
        lineOne:
          type:
          - string
          - 'null'
          description: "The address line one.\n            "
          maxLength: 128
          minLength: 0
        lineTwo:
          type:
          - string
          - 'null'
          description: "The address line two.\n            "
          maxLength: 128
          minLength: 0
        lineThree:
          type:
          - string
          - 'null'
          description: "The address line 3.\n            "
          maxLength: 128
          minLength: 0
        countryCode:
          type:
          - string
          - 'null'
          description: "The country code.\n            "
          maxLength: 2
          minLength: 0
        provinceState:
          type:
          - string
          - 'null'
          description: "The province state.\n            "
          maxLength: 3
          minLength: 0
        city:
          type:
          - string
          - 'null'
          description: "The city.\n            "
          maxLength: 32
          minLength: 0
        postalCode:
          type:
          - string
          - 'null'
          description: "The postal code.\n            "
          maxLength: 10
          minLength: 0
        personAddressKey:
          type:
          - string
          - 'null'
          description: "The unique person address key.\n            "
    NotificationTimedEventCreateRequest:
      type: object
      description: "A travel notification timed event create request.\n            "
      additionalProperties: false
      required:
      - type
      properties:
        minutesToEvent:
          type: integer
          description: "The minutes to the event.\n            "
          format: int32
        type:
          description: "The travel notification timed event type.\n            "
          $ref: '#/components/schemas/NotificationTimedEventType'
    IJsonResponseOfIListOfUserRecord:
      type: object
      description: "Defines the JSON response contract.\n            "
      additionalProperties: false
      properties:
        data:
          type:
          - array
          - 'null'
          description: "The payload data.\n            "
          items:
            $ref: '#/components/schemas/UserRecord'
        errors:
          type:
          - array
          - 'null'
          description: "The collection of errors being thrown.\n            "
          items:
            $ref: '#/components/schemas/ErrorResponse'
        messages:
          type:
          - array
          - 'null'
          description: "The collection of informational messages.\n            "
          items:
            $ref: '#/components/schemas/Message'
    PersonCustomerProgramEditRequest:
      type: object
      description: "Defines a person's customer program edit request.\n            "
      additionalProperties: false
      required:
      - programNumber
      properties:
        programNumber:
          type: string
          description: "The unique program number for the person.\n            "
          maxLength: 32
          minLength: 0
        effectiveDate:
          type:
          - string
          - 'null'
          description: "The effective date.\n            "
          format: date-time
        expirationDate:
          type:
          - string
          - 'null'
          description: "The expiration date.\n            "
          format: date-time
        default:
          type: boolean
          description: "True if this is set as the default program.\n            "
        programLevelCode:
          type:
          - string
          - 'null'
          description: "The program level.\n            "
          maxLength: 3
          minLength: 0
    UserChangePasswordRequestBase:
      type: object
      description: "Defines a change password request base.\n            "
      additionalProperties: false
      required:
      - newPassword
      properties:
        newPassword:
          type: string
          description: "The new password.\n            "
          maxLength: 256
          minLength: 0
    IJsonResponseOfPersonPreference:
      type: object
      description: "Defines the JSON response contract.\n            "
      additionalProperties: false
      properties:
        data:
          description: "The payload data.\n            "
          $ref: '#/components/schemas/PersonPreference'
        errors:
          type:
          - array
          - 'null'
          description: "The collection of errors being thrown.\n            "
          items:
            $ref: '#/components/schemas/ErrorResponse'
        messages:
          type:
          - array
          - 'null'
          description: "The collection of informational messages.\n            "
          items:
            $ref: '#/components/schemas/Message'
    DeltaMapperOfPersonPreferenceEditRequest:
      type: object
      description: "Map delta changes of a specific type T to another object.\n            "
      additionalProperties: false
      properties:
        value:
          type:
          - string
          - 'null'
          description: "The value of the preference.\n            "
    IJsonResponseOfPersonAddress:
      type: object
      description: "Defines the JSON response contract.\n            "
      additionalProperties: false
      properties:
        data:
          description: "The payload data.\n            "
          $ref: '#/components/schemas/PersonAddress'
        errors:
          type:
          - array
          - 'null'
          description: "The collection of errors being thrown.\n            "
          items:
            $ref: '#/components/schemas/ErrorResponse'
        messages:
          type:
          - array
          - 'null'
          description: "The collection of informational messages.\n            "
          items:
            $ref: '#/components/schemas/Message'
    PersonPreferenceEditRequest:
      type: object
      description: "Defines the person preference edit request.\n            "
      additionalProperties: false
      properties:
        value:
          type:
          - string
          - 'null'
          description: "The value of the preference.\n            "
    IJsonResponseOfIListOfPersonPhoneNumber:
      type: object
      description: "Defines the JSON response contract.\n            "
      additionalProperties: false
      properties:
        data:
          type:
          - array
          - 'null'
          description: "The payload data.\n            "
          items:
            $ref: '#/components/schemas/PersonPhoneNumber'
        errors:
          type:
          - array
          - 'null'
          description: "The collection of errors being thrown.\n            "
          items:
            $ref: '#/components/schemas/ErrorResponse'
        messages:
          type:
          - array
          - 'null'
          description: "The collection of informational messages.\n            "
          items:
            $ref: '#/components/schemas/Message'
    DeltaMapperOfUserRolePatchRequest:
      type: object
      description: "Map delta changes of a specific type T to another object.\n            "
      additionalProperties: false
      properties:
        effectiveAfter:
          type: string
          description: "The date the role is effective after.\n            "
          format: date-time
          minLength: 1
        effectiveBefore:
          type:
          - string
          - 'null'
          description: "The date the role is effective before.\n            "
          format: date-time
    IJsonResponseOfUser:
      type: object
      description: "Defines the JSON response contract.\n            "
      additionalProperties: false
      properties:
        data:
          description: "The payload data.\n            "
          $ref: '#/components/schemas/User'
        errors:
          type:
          - array
          - 'null'
          description: "The collection of errors being thrown.\n            "
          items:
            $ref: '#/components/schemas/ErrorResponse'
        messages:
          type:
          - array
          - 'null'
          description: "The collection of informational messages.\n            "
          items:
            $ref: '#/components/schemas/Message'
    PaymentMethodType:
      type: integer
      description: "Defines the payment method types.\n            \n\n0 = ExternalAccount\n1 = PrePaid\n2 = AgencyAccount\n3 = CustomerAccount\n4 = Voucher\n5 = Loyalty"
      x-enumNames:
      - ExternalAccount
      - PrePaid
      - AgencyAccount
      - CustomerAccount
      - Voucher
      - Loyalty
      enum:
      - 0
      - 1
      - 2
      - 3
      - 4
      - 5
    IJsonResponseOfPersonAffiliation:
      type: object
      description: "Defines the JSON response contract.\n            "
      additionalProperties: false
      properties:
        data:
          description: "The payload data.\n            "
          $ref: '#/components/schemas/PersonAffiliation'
        errors:
          type:
          - array
          - 'null'
          description: "The collection of errors being thrown.\n            "
          items:
            $ref: '#/components/schemas/ErrorResponse'
        messages:
          type:
          - array
          - 'null'
          description: "The collection of informational messages.\n            "
          items:
            $ref: '#/components/schemas/Message'
    PersonEditRequest:
      type: object
      description: "Defines the person create request.\n            "
      additionalProperties: false
      required:
      - name
      properties:
        type:
          description: "The type of person.\n            "
          $ref: '#/components/schemas/PersonType'
        status:
          description: "The status of the person.\n            "
          $ref: '#/components/schemas/PersonStatus'
        details:
          description: "The person's basic information.\n            "
          $ref: '#/components/schemas/PersonBasicInformation'
        notificationPreference:
          description: "The person's notification preference.\n            "
          $ref: '#/components/schemas/NotificationPreference'
        name:
          description: "The persons true name.\n            "
          $ref: '#/components/schemas/Name'
    IJsonResponseOfNotificationEvent:
      type: object
      description: "Defines the JSON response contract.\n            "
      additionalProperties: false
      properties:
        data:
          description: "The payload data.\n            "
          $ref: '#/components/schemas/NotificationEvent'
        errors:
          type:
          - array
          - 'null'
          description: "The collection of errors being thrown.\n            "
          items:
            $ref: '#/components/schemas/ErrorResponse'
        messages:
          type:
          - array
          - 'null'
          description: "The collection of informational messages.\n            "
          items:
            $ref: '#/components/schemas/Message'
    IJsonResponseOfIListOfPersonComment:
      type: object
      description: "Defines the JSON response contract.\n            "
      additionalProperties: false
      properties:
        data:
          type:
          - array
          - 'null'
          description: "The payload data.\n            "
          items:
            $ref: '#/components/schemas/PersonComment'
        errors:
          type:
          - array
          - 'null'
          description: "The collection of errors being thrown.\n            "
          items:
            $ref: '#/components/schemas/ErrorResponse'
        messages:
          type:
          - array
          - 'null'
          description: "The collection of informational messages.\n            "
          items:
            $ref: '#/components/schemas/Message'
    UserStatus:
      type: integer
      description: "Defines the status of a user.\n            \n\n0 = Default\n1 = Active\n2 = Pending\n3 = Suspended\n4 = Terminated"
      x-enumNames:
      - Default
      - Active
      - Pending
      - Suspended
      - Terminated
      enum:
      - 0
      - 1
      - 2
      - 3
      - 4
    PersonAddressEditRequest:
      type: object
      description: "Defines the person address edit request.\n            "
      additionalProperties: false
      properties:
        lineOne:
          type:
          - string
          - 'null'
          description: "The address line one.\n            "
          maxLength: 128
          minLength: 0
        lineTwo:
          type:
          - string
          - 'null'
          description: "The address line two.\n            "
          maxLength: 128
          minLength: 0
        lineThree:
          type:
          - string
          - 'null'
          description: "The address line 3.\n            "
          maxLength: 128
          minLength: 0
        countryCode:
          type:
          - string
          - 'null'
          description: "The country code.\n            "
          maxLength: 2
          minLength: 0
        provinceState:
          type:
          - string
          - 'null'
          description: "The province state.\n            "
          maxLength: 3
          minLength: 0
        city:
          type:
          - string
          - 'null'
          description: "The city.\n            "
          maxLength: 32
          minLength: 0
        postalCode:
          type:
          - string
          - 'null'
          description: "The postal code.\n            "
          maxLength: 10
          minLength: 0
        default:
          type: boolean
          description: "Flag indicating if the address is the persons default.\n            "
    NotificationTimedEventType:
      type: integer
      description: "Represents the type of timed notification event type for a travel notification event.\nThese are events that have an associated property minutes to event.\n            \n\n0 = Departure\n1 = Arrival"
      x-enumNames:
      - Departure
      - Arrival
      enum:
      - 0
      - 1
    DayOfWeek:
      type: integer
      description: "Defines the day of the week with none as an option.\n            \n\n0 = None\n1 = Monday\n2 = Tuesday\n3 = Wednesday\n4 = Thursday\n5 = Friday\n6 = Saturday\n7 = Sunday"
      x-enumNames:
      - None
      - Monday
      - Tuesday
      - Wednesday
      - Thursday
      - Friday
      - Saturday
      - Sunday
      enum:
      - 0
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
      - 7
    PersonPhoneNumber:
      type: object
      description: "Defines a unique person phone number.\n            "
      additionalProperties: false
      required:
      - type
      - number
      properties:
        default:
          type: boolean
          description: "Flag indicating if this phone number is the default.\n            "
        type:
          description: "The phone number type.\n            "
          $ref: '#/components/schemas/PhoneNumberType'
        number:
          type: string
          description: "The phone number without any formatting characters.\n            "
          maxLength: 20
          minLength: 0
        personPhoneNumberKey:
          type:
          - string
          - 'null'
          description: "The unique key for the phone number.\n            "
    PaidStatus:
      type: integer
      description: "Paid status enumeration.\n            \n\n0 = UnderPaid\n1 = PaidInFull\n2 = OverPaid"
      x-enumNames:
      - UnderPaid
      - PaidInFull
      - OverPaid
      enum:
      - 0
      - 1
      - 2
    PersonInformationEditRequest:
      type: object
      description: "Defines a person information edit request.\n            "
      additionalProperties: false
      properties:
        data:
          type:
          - string
          - 'null'
          description: "The information data.\n            "
    TransportationIdentifier:
      type: object
      description: "Represents the transportation identifier model data.\n            "
      additionalProperties: false
      required:
      - identifier
      - carrierCode
      properties:
        identifier:
          type: string
          description: "The unique transportation identifier.\n            "
          maxLength: 4
          minLength: 0
        carrierCode:
          type: string
          description: "The carrier code.\n            "
          maxLength: 3
          minLength: 2
        opSuffix:
          type:
          - string
          - 'null'
          description: "The op suffix.\nPlease note that this should be a char and not a string.\n            "
          maxLength: 1
    PersonPhoneNumberRequest:
      type: object
      description: "Defines the the person phone number.\n            "
      additionalProperties: false
      required:
      - type
      - number
      properties:
        type:
          description: "The phone number type.\n            "
          $ref: '#/components/schemas/PhoneNumberType'
        number:
          type: string
          description: "The phone number without any formatting characters.\n            "
          maxLength: 20
          minLength: 0
        default:
          type: boolean
          description: "Flag indicating if this phone number is the default.\n            "
    DeltaMapperOfTravelDocumentEditRequestv2:
      type: object
      description: "Map delta changes of a specific type T to another object.\n            "
      additionalProperties: false
      properties:
        birthCountry:
          type:
          - string
          - 'null'
          description: "The BirthCountry property.\n            "
        name:
          description: "The Name property.\n            "
          properties:
            first:
              type:
              - string
              - 'null'
              description: "The given first name.\n            "
              maxLength: 32
              minLength: 0
            middle:
              type:
              - string
              - 'null'
              description: "The given middle name.\n            "
              maxLength: 32
              minLength: 0
            last:
              type:
              - string
              - 'null'
              description: "The given last name.\n            "
              maxLength: 32
              minLength: 0
            title:
              type:
              - string
              - 'null'
              description: "The title.\n            "
              maxLength: 6
              minLength: 0
            suffix:
              type:
              - string
              - 'null'
              description: "The suffix.\n            "
              maxLength: 6
              minLength: 0
        nationality:
          type:
          - string
          - 'null'
          description: "The Nationality property.\n            "
          maxLength: 2
          minLength: 0
        expirationDate:
          type:
          - string
          - 'null'
          description: "The date when this travel document expires.\n            "
          format: date-time
        number:
          type: string
          description: "The travel document number.\n            "
          maxLength: 35
          minLength: 0
        issuedDate:
          type:
          - string
          - 'null'
          description: "The date this travel document was issued.\n            "
          format: date-time
        default:
          type: boolean
          description: "Flag indicating if the travel document is the default.\n            "
        gender:
          description: "The travel document holder's gender.\n            "
          $ref: '#/components/schemas/Gender'
        dateOfBirth:
          type:
          - string
          - 'null'
          description: "The person's date of birth.\n            "
          format: date-time
        declaredGender:
          type:
          - string
          - 'null'
          description: "The travel document holder's declared gender.\nThis will override the gender field on passenger or person POST, PUT, and PATCH requests.\nNote: Any value other than \"F\" will cause gender to be updated to Male by default to support compatibility with\nother systems.\nAdditionally you cannot change the declared gender and gender fields at the same time as declared gender\nwill override any gender field value regardless of the value passed in.\n            "
          maxLength: 2
          minLength: 0
        placeOfBirth:
          type:
          - string
          - 'null'
          description: "Represents the place of birth. Only used on the following document type groups: TravelVisa (9), RedressNumber (20),\nand KnownTravelerId (21).\nOnly allows alpha characters, please do not use spaces, hyphens, or special characters.\nNote: If unsure which travel document types fall into these groups please use `/api/nsk/v1/resources/DocumentTypes`\nor `/api/nsk/v1/resources/DocumentTypes/{documentTypeCode}`\n            "
          maxLength: 35
          minLength: 0
          pattern: ^[A-Za-z\s]*$
        placeOfIssue:
          type:
          - string
          - 'null'
          description: "Represents the place of issue. Only used on the following document type groups: TravelVisa (9), RedressNumber (20),\nand KnownTravelerId (21).\nOnly allows alpha characters, please do not use spaces, hyphens, or special characters.\nNote: If unsure which travel document types fall into these groups please use `/api/nsk/v1/resources/DocumentTypes`\nor `/api/nsk/v1/resources/DocumentTypes/{documentTypeCode}`\n            "
          maxLength: 35
          minLength: 0
          pattern: ^[A-Za-z\s]*$
    PersonAffiliationRequest:
      type: object
      description: "Defines the person affiliation.\n            "
      additionalProperties: false
      required:
      - name
      properties:
        name:
          type: string
          description: "The name of the affiliated person.\n            "
          minLength: 1
    PersonEmail:
      type: object
      description: "Defines a specific person email.\n            "
      additionalProperties: false
      required:
      - type
      - email
      properties:
        type:
          type: string
          description: "The type code of the email address.\nPlease note that this should be a char and not a string.\n            "
          maxLength: 1
          minLength: 1
        email:
          type: string
          description: "The email address value.\n            "
          maxLength: 266
          minLength: 0
        default:
          type: boolean
          description: "Flag indicating if the email is the default.\n            "
        personEmailKey:
          type:
          - string
          - 'null'
          description: "The unique email key.\n            "
    UserSetting:
      type: object
      description: "Defines the agent setting configuration.\n            "
      additionalProperties: false
      properties:
        agentSettingTypeCode:
          type:
          - string
          - 'null'
          description: "The setting type code.\n            "
          maxLength: 20
          minLength: 0
        name:
          type:
          - string
          - 'null'
          description: "The setting type name.\n            "
          maxLength: 64
          minLength: 0
        inActive:
          type: boolean
          description: "The in active.\n            "
        schema:
          type:
          - string
          - 'null'
          description: "The data schema.\n            "
          maxLength: 2147483647
          minLength: 0
        data:
          type:
          - string
          - 'null'
          description: "The setting data.\n            "
        version:
          type: integer
          description: "The settings version.\n            "
    PersonPreferenceCreateRequest:
      type: object
      description: "Defines a person preference create request.\n            "
      additionalProperties: false
      properties:
        value:
          type:
          - string
          - 'null'
          description: "The value of the preference.\n            "
        code:
          type:
          - string
          - 'null'
          description: "The preference code.\n            "
    IJsonResponseOfPerson:
      type: object
      description: "Defines the JSON response contract.\n            "
      additionalProperties: false
      properties:
        data:
          description: "The payload data.\n            "
          $ref: '#/components/schemas/Person'
        errors:
          type:
          - array
          - 'null'
          description: "The collection of errors being thrown.\n            "
          items:
            $ref: '#/components/schemas/ErrorResponse'
        messages:
          type:
          - array
          - 'null'
          description: "The collection of informational messages.\n            "
          items:
            $ref: '#/components/schemas/Message'
    IJsonResponseOfPersonStoredPayment:
      type: object
      description: "Defines the JSON response contract.\n            "
      additionalProperties: false
      properties:
        data:
          description: "The payload data.\n            "
          $ref: '#/components/schemas/PersonStoredPayment'
        errors:
          type:
          - array
          - 'null'
          description: "The collection of errors being thrown.\n            "
          items:
            $ref: '#/components/schemas/ErrorResponse'
        messages:
          type:
          - array
          - 'null'
          description: "The collection of informational messages.\n            "
          items:
            $ref: '#/components/schemas/Message'
    TravelNotificationCreateRequest:
      type: object
      description: "Create request for travel notifications.\n            "
      additionalProperties: false
      properties:
        cultureCode:
          type:
          - string
          - 'null'
          description: "The culture code.\n            "
        notificationDestination:
          description: "The notification destination.\n            "
          $ref: '#/components/schemas/NotificationDestination'
        deviceName:
          type:
          - string
          - 'null'
          description: "The name of the device for the push notification.\n            "
        events:
          type:
          - array
          - 'null'
          description: "The list of travel notification event.\n            "
          items:
            $ref: '#/components/schemas/NotificationEventCreateRequest'
        timedEvents:
          type:
          - array
          - 'null'
          description: "The list of travel notification event.\n            "
          items:
            $ref: '#/components/schemas/NotificationTimedEventCreateRequest'
    PersonTravelNotification:
      type: object
      description: "A person travel notification.\n            "
      additionalProperties: false
      properties:
        travelNotificationKey:
          type:
          - string
          - 'null'
          description: "The travel notification key.\n            "
        events:
          type:
          - array
          - 'null'
          description: "The list of travel notification event.\n            "
          items:
            $ref: '#/components/schemas/NotificationEvent'
        timedEvents:
          type:
          - array
          - 'null'
          description: "The list of travel notification event.\n            "
          items:
            $ref: '#/components/schemas/NotificationTimedEvent'
        cultureCode:
          type:
          - string
          - 'null'
          description: "The culture code.\n            "
        notificationDestination:
          description: "The notification destination.\n            "
          $ref: '#/components/schemas/NotificationDestination'
        deviceName:
          type:
          - string
          - 'null'
          description: "The name of the device for the push notification.\n            "
        createdDate:
          type:
          - string
          - 'null'
          description: "The created date of the travel notification.\n            "
          format: date-time
    IJsonResponseOfIListOfNotificationEvent:
      type: object
      description: "Defines the JSON response contract.\n            "
      additionalProperties: false
      properties:
        data:
          type:
          - array
          - 'null'
          description: "The payload data.\n            "
          items:
            $ref: '#/components/schemas/NotificationEvent'
        errors:
          type:
          - array
          - 'null'
          description: "The collection of errors being thrown.\n            "
          items:
            $ref: '#/components/schemas/ErrorResponse'
        messages:
          type:
          - array
          - 'null'
          description: "The collection of informational messages.\n            "
          items:
            $ref: '#/components/schemas/Message'
    IJsonResponseOfIListOfUserRole:
      type: object
      description: "Defines the JSON response contract.\n            "
      additionalProperties: false
      properties:
        data:
          type:
          - array
          - 'null'
          description: "The payload data.\n            "
          items:
            $ref: '#/components/schemas/UserRole'
        errors:
          type:
          - array
          - 'null'
          description: "The collection of errors being thrown.\n            "
          items:
            $ref: '#/components/schemas/ErrorResponse'
        messages:
          type:
          - array
          - 'null'
          description: "The collection of informational messages.\n            "
          items:
            $ref: '#/components/schemas/Message'
    DeltaMapperOfPersonStoredPaymentUpdateRequest:
      type: object
      description: "Map delta changes of a specific type T to another object.\n            "
      additionalProperties: false
      properties:
        paymentMethodType:
          description: "The type of payment being added.\n            "
          $ref: '#/components/schemas/PaymentMethodType'
        accountName:
          type:
          - string
          - 'null'
          description: "The name of the account.\n            "
          maxLength: 64
          minLength: 0
        expiration:
          type:
          - string
          - 'null'
          description: "The expiration.\n            "
          format: date-time
        paymentMethodCode:
          type: string
          description: "The payment method code.\n            "
          maxLength: 2
          minLength: 1
        default:
          type: boolean
          description: "Indicates if the stored payment is the default.\n            "
    IJsonResponseOfIListOfPersonInformation:
      type: object
      description: "Defines the JSON response contract.\n            "
      additionalProperties: false
      properties:
        data:
          type:
          - array
          - 'null'
          description: "The payload data.\n            "
          items:
            $ref: '#/components/schemas/PersonInformation'
        errors:
          type:
          - array
          - 'null'
          description: "The collection of errors being thrown.\n            "
          items:
            $ref: '#/components/schemas/ErrorResponse'
        messages:
          type:
          - array
          - 'null'
          description: "The collection of informational messages.\n            "
          items:
            $ref: '#/components/schemas/Message'
    DeltaMapperOfPersonAddressEditRequest:
      type: object
      description: "Map delta changes of a specific type T to another object.\n            "
      additionalProperties: false
      properties:
        lineOne:
          type:
          - string
          - 'null'
          description: "The address line one.\n            "
          maxLength: 128
          minLength: 0
        lineTwo:
          type:
          - string
          - 'null'
          description: "The address line two.\n            "
          maxLength: 128
          minLength: 0
        lineThree:
          type:
          - string
          - 'null'
          description: "The address line 3.\n            "
          maxLength: 128
          minLength: 0
        countryCode:
          type:
          - string
          - 'null'
          description: "The country code.\n            "
          maxLength: 2
          minLength: 0
        provinceState:
          type:
          - string
          - 'null'
          description: "The province state.\n            "
          maxLength: 3
          minLength: 0
        city:
          type:
          - string
          - 'null'
          description: "The city.\n            "
          maxLength: 32
          minLength: 0
        postalCode:
          type:
          - string
          - 'null'
          description: "The postal code.\n            "
          maxLength: 10
          minLength: 0
        default:
          type: boolean
          description: "Flag indicating if the address is the persons default.\n            "
    PersonCommentRequest:
      type: object
      description: "Defines a person comment request.\n            "
      additionalProperties: false
      properties:
        text:
          type:
          - string
          - 'null'
          description: "The comments text.\n            "
        type:
          description: "The comment type.\n            "
          $ref: '#/components/schemas/PersonCommentType'
    PersonStoredPaymentUpdateRequest:
      type: object
      description: "Defines the person's stored payment create request.\n            "
      additionalProperties: false
      required:
      - paymentMethodType
      - paymentMethodCode
      properties:
        paymentMethodType:
          description: "The type of payment being added.\n            "
          $ref: '#/components/schemas/PaymentMethodType'
        accountName:
          type:
          - string
          - 'null'
          description: "The name of the account.\n            "
          maxLength: 64
          minLength: 0
        expiration:
          type:
          - string
          - 'null'
          description: "The expiration.\n            "
          format: date-time
        paymentMethodCode:
          type: string
          description: "The payment method code.\n            "
          maxLength: 2
          minLength: 1
        default:
          type: boolean
          description: "Indicates if the stored payment is the default.\n            "
    PersonTravelDocument:
      type: object
      description: "Defines a specific person travel document.\n            "
      additionalProperties: false
      required:
      - documentTypeCode
      properties:
        default:
          type: boolean
          description: "Flag indicating if the travel document is the default.\n            "
        documentTypeCode:
          type: string
          description: "The unique travel document type code.\n            "
          maxLength: 4
          minLength: 0
        issuedByCode:
          type:
          - string
          - 'null'
          description: "The issuer code for the travel document (country code).\n            "
          maxLength: 3
          minLength: 0
        birthCountry:
          type:
          - string
          - 'null'
          description: "The BirthCountry property.\n            "
        name:
          description: "The Name property.\n            "
          $ref: '#/components/schemas/Name'
        nationality:
          type:
          - string
          - 'null'
          description: "The Nationality property.\n            "
          maxLength: 2
          minLength: 0
        expirationDate:
          type:
          - string
          - 'null'
          description: "The date when this travel document expires.\n            "
          format: date-time
        number:
          type:
          - string
          - 'null'
          description: "The travel document number.\n            "
          maxLength: 35
          minLength: 0
        issuedDate:
          type:
          - string
          - 'null'
          description: "The date this travel document was issued.\n            "
          format: date-time
        gender:
          description: "The travel document holder's gender.\n            "
          $ref: '#/components/schemas/Gender'
        dateOfBirth:
          type:
          - string
          - 'null'
          description: "The person's date of birth.\n            "
          format: date-time
        declaredGender:
          type:
          - string
          - 'null'
          description: "The travel document holder's declared gender.\nThis will override the gender field on passenger or person POST, PUT, and PATCH requests.\nNote: Any value other than \"F\" will cause gender to be updated to Male by default to support compatibility with\nother systems.\nAdditionally you cannot change the declared gender and gender fields at the same time as declared gender\nwill override any gender field value regardless of the value passed in.\n            "
          maxLength: 2
          minLength: 0
        placeOfBirth:
          type:
          - string
          - 'null'
          description: "Represents the place of birth. Only used on the following document type groups: TravelVisa (9), RedressNumber (20),\nand KnownTravelerId (21).\nOnly allows alpha characters, please do not use spaces, numbers, or special characters.\nNote: If unsure which travel document types fall into these groups please use `/api/nsk/v1/resources/DocumentTypes`\nor `/api/nsk/v1/resources/DocumentTypes/{documentTypeCode}`\n            "
          maxLength: 35
          minLength: 0
          pattern: ^[A-Za-z\s]*$
        placeOfIssue:
          type:
          - string
          - 'null'
          description: "Represents the place of issue. Only used on the following document type groups: TravelVisa (9), RedressNumber (20),\nand KnownTravelerId (21).\nOnly allows alpha characters, please do not use spaces, hyphens, or special characters.\nNote: If unsure which travel document types fall into these groups please use `/api/nsk/v1/resources/DocumentTypes`\nor `/api/nsk/v1/resources/DocumentTypes/{documentTypeCode}`\n            "
          maxLength: 35
          minLength: 0
          pattern: ^[A-Za-z\s]*$
        personTravelDocumentKey:
          type:
          - string
          - 'null'
          description: "The unique person travel document key.\n            "
    CollectionCurrencySetting:
      type: integer
      description: "Defines to which the collection currency will be applied.\n            \n\n0 = None\n1 = Payments\n2 = Fees\n3 = Both"
      x-enumNames:
      - None
      - Payments
      - Fees
      - Both
      enum:
      - 0
      - 1
      - 2
      - 3
    DeltaMapperOfPersonCustomerProgramEditRequest:
      type: object
      description: "Map delta changes of a specific type T to another object.\n            "
      additionalProperties: false
      properties:
        programNumber:
          type: string
          description: "The unique program number for the person.\n            "
          maxLength: 32
          minLength: 0
        effectiveDate:
          type:
          - string
          - 'null'
          description: "The effective date.\n            "
          format: date-time
        expirationDate:
          type:
          - string
          - 'null'
          description: "The expiration date.\n            "
          format: date-time
        default:
          type: boolean
          description: "True if this is set as the default program.\n            "
        programLevelCode:
          type:
          - string
          - 'null'
          description: "The program level.\n            "
          maxLength: 3
          minLength: 0
    TravelNotificationEditRequest:
      type: object
      description: "Request base for travel notifications.\n            "
      additionalProperties: false
      properties:
        cultureCode:
          type:
          - string
          - 'null'
          description: "The culture code.\n            "
        notificationDestination:
          description: "The notification destination.\n            "
          $ref: '#/components/schemas/NotificationDestination'
        deviceName:
          type:
          - string
          - 'null'
          description: "The name of the device for the push notification.\n            "
    Gender:
      type: integer
      description: "Defines the different binary gender types.\n            \n\n0 = XX\n1 = Male\n2 = Female"
      x-enumNames:
      - XX
      - Male
      - Female
      enum:
      - 0
      - 1
      - 2
    IJsonResponseOfIListOfPersonEmail:
      type: object
      description: "Defines the JSON response contract.\n            "
      additionalProperties: false
      properties:
        data:
          type:
          - array
          - 'null'
          description: "The payload data.\n            "
          items:
            $ref: '#/components/schemas/PersonEmail'
        errors:
          type:
          - array
          - 'null'
          description: "The collection of errors being thrown.\n            "
          items:
            $ref: '#/components/schemas/ErrorResponse'
        messages:
          type:
          - array
          - 'null'
          description: "The collection of informational messages.\n            "
          items:
            $ref: '#/components/schemas/Message'
    PersonTravelDocumentRequest:
      type: object
      description: "Defines the person travel document.\n            "
      additionalProperties: false
      required:
      - documentTypeCode
      properties:
        documentTypeCode:
          type: string
          description: "The unique travel document type code.\n            "
          maxLength: 4
          minLength: 0
        issuedByCode:
          type:
          - string
          - 'null'
          description: "The issuer code for the travel document (country code).\n            "
          maxLength: 3
          minLength: 0
        birthCountry:
          type:
          - string
          - 'null'
          description: "The BirthCountry property.\n            "
        name:
          description: "The Name property.\n            "
          $ref: '#/components/schemas/Name'
        nationality:
          type:
          - string
          - 'null'
          description: "The Nationality property.\n            "
          maxLength: 2
          minLength: 0
        expirationDate:
          type:
          - string
          - 'null'
          description: "The date when this travel document expires.\n            "
          format: date-time
        number:
          type:
          - string
          - 'null'
          description: "The travel document number.\n            "
          maxLength: 35
          minLength: 0
        issuedDate:
          type:
          - string
          - 'null'
          description: "The date this travel document was issued.\n            "
          format: date-time
        gender:
          description: "The travel document holder's gender.\n            "
          $ref: '#/components/schemas/Gender'
        dateOfBirth:
          type:
          - string
          - 'null'
          description: "The person's date of birth.\n            "
          format: date-time
        declaredGender:
          type:
          - string
          - 'null'
          description: "The travel document holder's declared gender.\nThis will override the gender field on passenger or person POST, PUT, and PATCH requests.\nNote: Any value other than \"F\" will cause gender to be updated to Male by default to support compatibility with\nother systems.\nAdditionally you cannot change the declared gender and gender fields at the same time as declared gender\nwill override any gender field value regardless of the value passed in.\n            "
          maxLength: 2
          minLength: 0
        placeOfBirth:
          type:
          - string
          - 'null'
          description: "Represents the place of birth. Only used on the following document type groups: TravelVisa (9), RedressNumber (20),\nand KnownTravelerId (21).\nOnly allows alpha characters, please do not use spaces, numbers, or special characters.\nNote: If unsure which travel document types fall into these groups please use `/api/nsk/v1/resources/DocumentTypes`\nor `/api/nsk/v1/resources/DocumentTypes/{documentTypeCode}`\n            "
          maxLength: 35
          minLength: 0
          pattern: ^[A-Za-z\s]*$
        placeOfIssue:
          type:
          - string
          - 'null'
          description: "Represents the place of issue. Only used on the following document type groups: TravelVisa (9), RedressNumber (20),\nand KnownTravelerId (21).\nOnly allows alpha characters, please do not use spaces, hyphens, or special characters.\nNote: If unsure which travel document types fall into these groups please use `/api/nsk/v1/resources/DocumentTypes`\nor `/api/nsk/v1/resources/DocumentTypes/{documentTypeCode}`\n            "
          maxLength: 35
          minLength: 0
          pattern: ^[A-Za-z\s]*$
        default:
          type: boolean
          description: "Flag indicating if the travel document is the default.\n            "
    IJsonResponseOfPersonEmail:
      type: object
      description: "Defines the JSON response contract.\n            "
      additionalProperties: false
      properties:
        data:
          description: "The payload data.\n            "
          $ref: '#/components/schemas/PersonEmail'
        errors:
          type:
          - array
          - 'null'
          description: "The collection of errors being thrown.\n            "
          items:
            $ref: '#/components/schemas/ErrorResponse'
        messages:
          type:
          - array
          - 'null'
          description: "The collection of informational messages.\n            "
          items:
            $ref: '#/components/schemas/Message'
    EmailEditRequest:
      type: object
      description: "Defines the person email edit address.\n            "
      additionalProperties: false
      required:
      - email
      properties:
        email:
          type: string
          description: "The email address value.\n            "
          maxLength: 266
          minLength: 0
        default:
          type: boolean
          description: "Flag indicating if the email is the default.\n            "
    DeltaMapperOfPersonEditRequest:
      type: object
      description: "Map delta changes of a specific type T to another object.\n            "
      additionalProperties: false
      properties:
        type:
          description: "The type of person.\n            "
          $ref: '#/components/schemas/PersonType'
        status:
          description: "The status of the person.\n            "
          $ref: '#/components/schemas/PersonStatus'
        details:
          description: "The person's basic information.\n            "
          properties:
            gender:
              description: "The person's gender.\n            "
              $ref: '#/components/schemas/Gender'
            dateOfBirth:
              type:
              - string
              - 'null'
              description: "The person's date of birth.\n            "
              format: date-time
            nationality:
              type:
              - string
              - 'null'
              description: "The person's nationality.\n            "
            residentCountry:
              type:
              - string
              - 'null'
              description: "The person's resident country.\n            "
            passengerType:
              type:
              - string
              - 'null'
              description: "The type of passenger the person is.\n            "
            preferredCultureCode:
              type:
              - string
              - 'null'
              description: "The person's preferred culture code.\n            "
            preferredCurrencyCode:
              type:
              - string
              - 'null'
              description: "The person's preferred currency code.\n            "
            nationalIdNumber:
              type:
              - string
              - 'null'
              description: "The person's national ID number.\n            "
            declaredGender:
              type:
              - string
              - 'null'
              description: "The person's declared gender. A value of \"F\" is mapped to a female binary gender. All other values will be\nmapped to a male binary gender.\n            "
              maxLength: 2
              minLength: 0
        notificationPreference:
          description: "The person's notification preference.\n            "
          $ref: '#/components/schemas/NotificationPreference'
        name:
          description: "The persons true name.\n            "
          properties:
            first:
              type:
              - string
              - 'null'
              description: "The given first name.\n            "
              maxLength: 32
              minLength: 0
            middle:
              type:
              - string
              - 'null'
              description: "The given middle name.\n            "
              maxLength: 32
              minLength: 0
            last:
              type:
              - string
              - 'null'
              description: "The given last name.\n            "
              maxLength: 32
              minLength: 0
            title:
              type:
              - string
              - 'null'
              description: "The title.\n            "
              maxLength: 6
              minLength: 0
            suffix:
              type:
              - string
              - 'null'
              description: "The suffix.\n            "
              maxLength: 6
              minLength: 0
    PersonAffiliation:
      type: object
      description: "Defines the person affiliation.\n            "
      additionalProperties: false
      required:
      - name
      properties:
        name:
          type: string
          description: "The name of the affiliated person.\n            "
          minLength: 1
        personAffiliationKey:
          type:
          - string
          - 'null'
          description: "The unique person affiliation key.\n            "
    EmailCreateRequest:
      type: object
      description: "Defines the person email create address.\n            "
      additionalProperties: false
      required:
      - email
      - type
      properties:
        email:
          type: string
          description: "The email address value.\n            "
          maxLength: 266
          minLength: 0
        default:
          type: boolean
          description: "Flag indicating if the email is the default.\n            "
        type:
          type: string
          description: "The type code of the email address.\nPlease note that this should be a char and not a string.\n            "
          maxLength: 1
          minLength: 1
    IJsonResponseOfIListOfPersonAffiliation:
      type: object
      description: "Defines the JSON response contract.\n            "
      additionalProperties: false
      properties:
        data:
          type:
          - array
          - 'null'
          description: "The payload data.\n            "
          items:
            $ref: '#/components/schemas/PersonAffiliation'
        errors:
          type:
          - array
          - 'null'
          description: "The collection of errors being thrown.\n            "
          items:
            $ref: '#/components/schemas/ErrorResponse'
        messages:
          type:
          - array
          - 'null'
          description: "The collection of informational messages.\n            "
          items:
            $ref: '#/components/schemas/Message'
    LegStatus:
      type: integer
      description: "Leg status enumeration.\n            \n\n0 = Normal\n1 = Closed\n2 = Canceled\n3 = Suspended\n5 = ClosedPending\n6 = BlockAllActivities\n7 = Mishap"
      x-enumNames:
      - Normal
      - Closed
      - Canceled
      - Suspended
      - ClosedPending
      - BlockAllActivities
      - Mishap
      enum:
      - 0
      - 1
      - 2
      - 3
      - 5
      - 6
      - 7
    PersonComment:
      type: object
      description: "Defines a person comment.\n            "
      additionalProperties: false
      properties:
        text:
          type:
          - string
          - 'null'
          description: "The comments text.\n            "
        type:
          description: "The comment type.\n            "
          $ref: '#/components/schemas/PersonCommentType'
        personCommentKey:
          type:
          - string
          - 'null'
          description: "The unique person comment key.\n            "
        createdUserKey:
          type:
          - string
          - 'null'
          description: "The unique user key of the agent that created the comment.\n            "
        createdDate:
          type: string
          description: "The date the comment was created.\n            "
          format: date-time
        modifiedUserKey:
          type:
          - string
          - 'null'
          description: "The unique user key of the agent that last modified the comment.\n            "
        modifiedDate:
          type: string
          description: "The date the comment was last modified.\n            "
          format: date-time
    NotificationEventCreateRequest:
      type: object
      description: "A travel notification event create request.\n            "
      additionalProperties: false
      required:
      - type
      properties:
        type:
          description: "The travel notification event type.\n            "
          $ref: '#/components/schemas/NotificationEventType'
    PersonCustomerProgram:
      type: object
      description: "Defines a person's customer program.\n            "
      additionalProperties: false
      required:
      - programCode
      - programNumber
      properties:
        pointBalance:
          type: integer
          description: "The current point balance.\n            "
          format: int32
        currentYearQualifyingPoints:
          type: integer
          description: "The current years qualifying points.\n            "
          format: int32
        currentYearRedeemablePoints:
          type: integer
          description: "The current years redeemable points.\n            "
          format: int32
        lifetimeAccumulatedQualifyingPoints:
          type: integer
          description: "The lifetime accumulated qualifying points.\n            "
          format: int32
        lifetimeAccumulatedRedeemablePoints:
          type: integer
          description: "The lifetime accumulated redeemable points.\n            "
          format: int32
        qualifyingPoints:
          type: integer
          description: "The qualifying points.\n            "
          format: int32
        qualifyingSegments:
          type: integer
          description: "The qualifying segments.\n            "
        createdDate:
          type:
          - string
          - 'null'
          description: "The created date.\n            "
          format: date-time
        modifiedDate:
          type:
          - string
          - 'null'
          description: "The modified date.\n            "
          format: date-time
        programCode:
          type: string
          description: "The program code.\n            "
          maxLength: 3
          minLength: 0
        programNumber:
          type: string
          description: "The unique program number for the person.\n            "
          maxLength: 32
          minLength: 0
        effectiveDate:
          type:
          - string
          - 'null'
          description: "The effective date.\n            "
          format: date-time
        expirationDate:
          type:
          - string
          - 'null'
          description: "The expiration date.\n            "
          format: date-time
        default:
          type: boolean
          description: "True if this is set as the default program.\n            "
        programLevelCode:
          type:
          - string
          - 'null'
          description: "The program level.\n            "
          maxLength: 3
          minLength: 0
        personCustomerProgramKey:
          type:
          - string
          - 'null'
          description: "The unique person customer program key.\n            "
    PhoneNumberType:
      type: integer
      description: "Defines the types of phone numbers. Note: New Skies does not support Mobile for booking contacts.\n            \n\n0 = Other\n1 = Home\n2 = Work\n3 = Mobile\n4 = Fax"
      x-enumNames:
      - Other
      - Home
      - Work
      - Mobile
      - Fax
      enum:
      - 0
      - 1
      - 2
      - 3
      - 4
    PriceStatus:
      type: integer
      description: "Describes the fare pricing status\n            \n\n0 = Invalid\n1 = Override\n2 = Valid"
      x-enumNames:
      - Invalid
      - Override
      - Valid
      enum:
      - 0
      - 1
      - 2
    PersonStoredPaymentRequest:
      type: object
      description: "Defines the person's stored payment create request.\n            "
      additionalProperties: false
      required:
      - paymentMethodType
      - paymentMethodCode
      - accountNumber
      properties:
        paymentMethodType:
          description: "The type of payment being added.\n            "
          $ref: '#/components/schemas/PaymentMethodType'
        accountName:
          type:
          - string
          - 'null'
          description: "The name of the account.\n            "
          maxLength: 64
          minLength: 0
        expiration:
          type:
          - string
          - 'null'
          description: "The expiration.\n            "
          format: date-time
        paymentMethodCode:
          type: string
          description: "The payment method code.\n            "
          maxLength: 2
          minLength: 1
        default:
          type: boolean
          description: "Indicates if the stored payment is the default.\n            "
        accountNumber:
          type: string
          description: "The account number.\n            "
          maxLength: 34
          minLength: 0
    SegmentTripResult:
      type: object
      description: "Model data.\n            "
      additionalProperties: false
      properties:
        designator:
          description: "This is a summary of all the legs on the segment. It will contain the details\nof the transportation from the first and last leg.\n            "
          $ref: '#/components/schemas/TransportationDesignator'
        classOfService:
          type:
          - string
          - 'null'
          description: "The class of service.\n            "
          maxLength: 8
          minLength: 0
        activityDate:
          type:
          - string
          - 'null'
          description: "The activity date.\n            "
          format: date-time
        identifier:
          description: "The transportation identifier.\n            "
          $ref: '#/components/schemas/TransportationIdentifier'
        externalIdentifier:
          description: "The external transportation identifier.\n            "
          $ref: '#/components/schemas/TransportationIdentifier'
        legs:
          type:
          - array
          - 'null'
          description: "The associated leg information.\n            "
          items:
            $ref: '#/components/schemas/LegTripResult'
        journeyIndex:
          type: integer
          description: "The journey index the segment is related to relative to the booking.\n            "
        segmentIndex:
          type: integer
          description: "The segment index the segment is related to relative to the booking.\n            "
    Message:
      type: object
      description: "Defines a unique informational message.\n            "
      additionalProperties: false
      properties:
        code:
          type:
          - string
          - 'null'
          description: "The unique message code.\n            "
        type:
          type:
          - string
          - 'null'
          description: "The message type.\n            "
        value:
          type:
          - string
          - 'null'
          description: "The message's value.\n            "
        status:
          description: "The message's status.\n            "
          $ref: '#/components/schemas/MessageStatus'
        details:
          type:
          - object
          - 'null'
          description: "Dynamic detailed information about the message.\n            "
          additionalProperties:
            type: string
    IJsonResponseOfIListOfBookingSearchResult:
      type: object
      description: "Defines the JSON response contract.\n            "
      additionalProperties: false
      properties:
        data:
          type:
          - array
          - 'null'
          description: "The payload data.\n            "
          items:
            $ref: '#/components/schemas/BookingSearchResult'
        errors:
          type:
          - array
          - 'null'
          description: "The collection of errors being thrown.\n            "
          items:
            $ref: '#/components/schemas/ErrorResponse'
        messages:
          type:
          - array
          - 'null'
          description: "The collection of informational messages.\n            "
          items:
            $ref: '#/components/schemas/Message'
    PersonCreateRequest:
      type: object
      description: "Defines the person create request.\n            "
      additionalProperties: false
      required:
      - name
      properties:
        customerNumber:
          type:
          - string
          - 'null'
          description: "The unique person customer number.\n            "
          maxLength: 20
          minLength: 0
        type:
          description: "The type of person.\n            "
          $ref: '#/components/schemas/PersonType'
        status:
          description: "The status of the person.\n            "
          $ref: '#/components/schemas/PersonStatus'
        details:
          description: "The person's basic information.\n            "
          $ref: '#/components/schemas/PersonBasicInformation'
        notificationPreference:
          description: "The person's notification preference.\n            "
          $ref: '#/components/schemas/NotificationPreference'
        name:
          description: "The persons true name.\n            "
          $ref: '#/components/schemas/Name'
        emailAddresses:
          type:
          - array
          - 'null'
          description: "The collection of registered email address.\n            "
          items:
            $ref: '#/components/schemas/EmailCreateRequest'
        phoneNumbers:
          type:
          - array
          - 'null'
          description: "The collection of registered phone numbers.\n            "
          items:
            $ref: '#/components/schemas/PersonPhoneNumberRequest'
        addresses:
          type:
          - array
          - 'null'
          description: "The collection of known addresses.\n            "
          items:
            $ref: '#/components/schemas/PersonAddressCreateRequest'
        storedPayments:
          type:
          - array
          - 'null'
          description: "The collection of registered stored payments.\n            "
          items:
            $ref: '#/components/schemas/PersonStoredPaymentRequest'
        travelDocuments:
          type:
          - array
          - 'null'
          description: "The collection of registered travel documents.\n            "
          items:
            $ref: '#/components/schemas/PersonTravelDocumentRequest'
        programs:
          type:
          - array
          - 'null'
          description: "The collection of enrolled customer programs.\n            "
          items:
            $ref: '#/components/schemas/PersonCustomerProgramCreateRequest'
        comments:
          type:
          - array
          - 'null'
          description: "The collection of comments.\n            "
          items:
            $ref: '#/components/schemas/PersonCommentRequest'
        preferences:
          type:
          - array
          - 'null'
          description: "The collection of preferences.\n            "
          items:
            $ref: '#/components/schemas/PersonPreferenceCreateRequest'
        aliases:
          type:
          - array
          - 'null'
          description: "The collection of alternate names for the person.\n            "
          items:
            $ref: '#/components/schemas/PersonAliasRequest'
        affiliates:
          type:
          - array
          - 'null'
          description: "The collection of affiliates for the person.\n            "
          items:
            $ref: '#/components/schemas/PersonAffiliation'
    UserCodes:
      type: object
      description: "Defines all the different user codes.\n            "
      additionalProperties: false
      required:
      - departmentCode
      - locationCode
      - organizationCode
      - domainCode
      properties:
        departmentCode:
          type: string
          description: "The user's department code.\n            "
          maxLength: 4
          minLength: 1
        locationCode:
          type: string
          description: "The user's location code.\n            "
          maxLength: 5
          minLength: 1
        locationGroupCode:
          type:
          - string
          - 'null'
          description: "The user's location group code.\n            "
        organizationCode:
          type: string
          description: "The user's organization code.\n            "
          maxLength: 10
          minLength: 0
        organizationGroupCode:
          type:
          - string
          - 'null'
          description: "The user's organization group code.\n            "
        domainCode:
          type: string
          description: "The user's domain code.\n            "
          maxLength: 3
          minLength: 0
    IJsonResponseOfPersonAlias:
      type: object
      description: "Defines the JSON response contract.\n            "
      additionalProperties: false
      properties:
        data:
          description: "The payload data.\n            "
          $ref: '#/components/schemas/PersonAlias'
        errors:
          type:
          - array
          - 'null'
          description: "The collection of errors being thrown.\n            "
          items:
            $ref: '#/components/schemas/ErrorResponse'
        messages:
          type:
          - array
          - 'null'
          description: "The collection of informational messages.\n            "
          items:
            $ref: '#/components/schemas/Message'
    ChannelType:
      type: integer
      description: "Defines the available channel types doing invoking the communication with the server.\n            \n\n0 = Default\n1 = Direct\n2 = Web\n3 = Gds\n4 = Api\n5 = DigitalApi\n6 = DigitalWeb\n7 = Ndc"
      x-enumNames:
      - Default
      - Direct
      - Web
      - Gds
      - Api
      - DigitalApi
      - DigitalWeb
      - Ndc
      enum:
      - 0
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
      - 7
    BookingTripResult:
      type: object
      description: "Booking flight result data.\n            "
      additionalProperties: false
      properties:
        recordLocator:
          type:
          - string
          - 'null'
          description: "The record locator.\n            "
        bookingStatus:
          description: "The booking status.\n            "
          $ref: '#/components/schemas/BookingStatus'
        priceStatus:
          description: "The price status.\n            "
          $ref: '#/components/schemas/PriceStatus'
        paidStatus:
          description: "The paid status.\n            "
          $ref: '#/components/schemas/PaidStatus'
        createdDate:
          type:
          - string
          - 'null'
          description: "The UTC date and time of when the booking was created.\n            "
          format: date-time
        firstName:
          type:
          - string
          - 'null'
          description: "The first name on the booking.\n            "
        lastName:
          type:
          - string
          - 'null'
          description: "The last name on the booking.\n            "
        customerNumber:
          type:
          - string
          - 'null'
          description: "The customer number on the booking.\n            "
        segments:
          type:
          - array
          - 'null'
          description: "The applicable segments.\n            "
          items:
            $ref: '#/components/schemas/SegmentTripResult'
    UserRoleEditRequest:
      type: object
      description: "Defines the user role edit request.\n            "
      additionalProperties: false
      required:
      - effectiveAfter
      properties:
        effectiveAfter:
          type: string
          description: "The date the role is effective after.\n            "
          format: date-time
          minLength: 1
        effectiveBefore:
          type:
          - string
          - 'null'
          description: "The date the role is effective before.\n            "
          format: date-time
        effectiveDays:
          type:
          - array
          - 'null'
          description: "The days the role is effective.\n            "
          items:
            $ref: '#/components/schemas/DayOfWeek'
    IJsonResponse:
      type: object
      description: "Defines the JSON response contract for a not content type response.\n            "
      additionalProperties: false
      properties:
        data:
          description: "The payload data, this will always be null for errors responses and no content responses.\n            "
        errors:
          type:
          - array
          - 'null'
          description: "The collection of errors being thrown.\n            "
          items:
            $ref: '#/components/schemas/ErrorResponse'
        messages:
          type:
          - array
          - 'null'
          description: "The collection of informational messages.\n            "
          items:
            $ref: '#/components/schemas/Message'
    DeliveryMethodCode:
      type: integer
      description: "Represents the delivery method codes.\n            \n\n0 = Email\n1 = Sms\n2 = Push"
      x-enumNames:
      - Email
      - Sms
      - Push
      enum:
      - 0
      - 1
      - 2
    IJsonResponseOfNotificationTimedEvent:
      type: object
      description: "Defines the JSON response contract.\n            "
      additionalProperties: false
      properties:
        data:
          description: "The payload data.\n            "
          $ref: '#/components/schemas/NotificationTimedEvent'
        errors:
          type:
          - array
          - 'null'
          description: "The collection of errors being thrown.\n            "
          items:
            $ref: '#/components/schemas/ErrorResponse'
        messages:
          type:
          - array
          - 'null'
          description: "The collection of informational messages.\n            "
          items:
            $ref: '#/components/schemas/Message'
    IJsonResponseOfPersonComment:
      type: object
      description: "Defines the JSON response contract.\n            "
      additionalProperties: false
      properties:
        data:
          description: "The payload data.\n            "
          $ref: '#/components/schemas/PersonComment'
        errors:
          type:
          - array
          - 'null'
          description: "The collection of errors being thrown.\n            "
          items:
            $ref: '#/components/schemas/ErrorResponse'
        messages:
          type:
          - array
          - 'null'
          description: "The collection of informational messages.\n            "
          items:
            $ref: '#/components/schemas/Message'
    PersonAddressCreateRequest:
      type: object
      description: "Defines a person address request.\n            "
      additionalProperties: false
      required:
      - addressTypeCode
      properties:
        default:
          type: boolean
          description: "Flag indicating if the address is the persons default.\n            "
        lineOne:
          type:
          - string
          - 'null'
          description: "The address line one.\n            "
          maxLength: 128
          minLength: 0
        lineTwo:
          type:
          - string
          - 'null'
          description: "The address line two.\n            "
          maxLength: 128
          minLength: 0
        lineThree:
          type:
          - string
          - 'null'
          description: "The address line 3.\n            "
          maxLength: 128
          minLength: 0
        countryCode:
          type:
          - string
          - 'null'
          description: "The country code.\n            "
          maxLength: 2
          minLength: 0
        provinceState:
          type:
          - string
          - 'null'
          description: "The province state.\n            "
          maxLength: 3
          minLength: 0
        city:
          type:
          - string
          - 'null'
          description: "The city.\n            "
          maxLength: 32
          minLength: 0
        postalCode:
          type:
          - string
          - 'null'
          description: "The postal code.\n            "
          maxLength: 10
          minLength: 0
        addressTypeCode:
          type: string
          description: "The type of address.\nPlease note that this should be a char and not a string.\n            "
          maxLength: 1
          minLength: 1
    PersonAliasType:
      type: integer
      description: "Defines the type of alternate name.\n            \n\n0 = Alias\n1 = Variant"
      x-enumNames:
      - Alias
      - Variant
      enum:
      - 0
      - 1
    IJsonResponseOfIListOfPersonAlias:
      type: object
      description: "Defines the JSON response contract.\n            "
      additionalProperties: false
      properties:
        data:
          type:
          - array
          - 'null'
          description: "The payload data.\n            "
          items:
            $ref: '#/components/schemas/PersonAlias'
        errors:
          type:
          - array
          - 'null'
          description: "The collection of errors being thrown.\n            "
          items:
            $ref: '#/components/schemas/ErrorResponse'
        messages:
          type:
          - array
          - 'null'
          description: "The collection of informational messages.\n            "
          items:
            $ref: '#/components/schemas/Message'
    LegTripResult:
      type: object
      description: "Model data.\n            "
      additionalProperties: false
      properties:
        designator:
          description: "Transportation information.\n            "
          $ref: '#/components/schemas/TransportationDesignator'
        boardingSequence:
          type: integer
          description: "The boarding sequence number.\n            "
        compartmentDesignator:
          type:
          - string
          - 'null'
          description: "The passenger seat compartment designator.\n            "
          maxLength: 2
          minLength: 0
        unitDesignator:
          type:
          - string
          - 'null'
          description: "The passenger seat compartment designator.\n            "
          maxLength: 2
          minLength: 0
        status:
          description: "The leg's status.\n            "
          $ref: '#/components/schemas/LegStatus'
        liftStatus:
          description: "The lift status.\n            "
          $ref: '#/components/schemas/LiftStatus'
        departureTimeUtc:
          type:
          - string
          - 'null'
          description: "The departure time using the time variant in universal time.\n            "
          format: date-time
        arrivalTimeUtc:
          type:
          - string
          - 'null'
          description: "The arrival time using the time variant in universal time.\n            "
          format: date-time
    LiftStatus:
      type: integer
      description: "Lift status enumeration.\n            \n\n0 = Default\n1 = CheckedIn\n2 = Boarded\n3 = NoShow"
      x-enumNames:
      - Default
      - CheckedIn
      - Boarded
      - NoShow
      enum:
      - 0
      - 1
      - 2
      - 3
    IJsonResponseOfPersonTravelDocument:
      type: object
      description: "Defines the JSON response contract.\n            "
      additionalProperties: false
      properties:
        data:
          description: "The payload data.\n            "
          $ref: '#/components/schemas/PersonTravelDocument'
        errors:
          type:
          - array
          - 'null'
          description: "The collection of errors being thrown.\n            "
          items:
            $ref: '#/components/schemas/ErrorResponse'
        messages:
          type:
          - array
          - 'null'
          description: "The collection of informational messages.\n            "
          items:
            $ref: '#/components/schemas/Message'
    PersonName:
      type: object
      description: "Defines a person name.\n            "
      additionalProperties: false
      properties:
        first:
          type:
          - string
          - 'null'
          description: "The given first name.\n            "
          maxLength: 32
          minLength: 0
        middle:
          type:
          - string
          - 'null'
          description: "The given middle name.\n            "
          maxLength: 32
          minLength: 0
        last:
          type:
          - string
          - 'null'
          description: "The given last name.\n            "
          maxLength: 32
          minLength: 0
        title:
          type:
          - string
          - 'null'
          description: "The title.\n            "
          maxLength: 6
          minLength: 0
        suffix:
          type:
          - string
          - 'null'
          description: "The suffix.\n            "
          maxLength: 6
          minLength: 0
        personNameKey:
          type:
          - string
          - 'null'
          description: "The unique person name key.\n            "
    TransportationDesignator:
      type: object
      description: "Model information about the traveling arrival and destination details.\n            "
      additionalProperties: false
      properties:
        destination:
          type:
          - string
          - 'null'
          description: "Gets or sets the leg arrival station.\n            "
          maxLength: 3
          minLength: 0
        origin:
          type:
          - string
          - 'null'
          description: "Gets or sets the leg departure station.\n            "
          maxLength: 3
          minLength: 0
        arrival:
          type: string
          description: "The arrival date and time local to the arrival station.\n            "
          format: date-time
        departure:
          type: string
          description: "The departure date and time local to the departure station.\n            "
          format: date-time
    MatchCriteria:
      type: integer
      description: "Defines the matching criteria for strings.\n            \n\n0 = StartsWith\n1 = EndsWith\n2 = Contains\n3 = ExactMatch"
      x-enumNames:
      - StartsWith
      - EndsWith
      - Contains
      - ExactMatch
      enum:
      - 0
      - 1
      - 2
      - 3
    Exception:
      type: object
      additionalProperties: false
      properties:
        Message:
          type: string
        InnerException:
          $ref: '#/components/schemas/Exception'
        Source:
          type:
          - string
          - 'null'
        StackTrace:
          type:
          - string
          - 'null'
    BookingStatus:
      type: integer
      description: "Booking Status Enumeration\n            \n\n0 = Default\n1 = Hold\n2 = Confirmed\n3 = Closed\n4 = HoldCanceled\n5 = PendingArchive\n6 = Archived\n7 = ArchivedPrivate\n777 = ProcessedForArchive"
      x-enumNames:
      - Default
      - Hold
      - Confirmed
      - Closed
      - HoldCanceled
      - PendingArchive
      - Archived
      - ArchivedPrivate
      - ProcessedForArchive
      enum:
      - 0
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
      - 7
      - 777
    TravelDocumentEditRequestv2:
      type: object
      description: "Defines the edit travel document request.\n            "
      additionalProperties: false
      required:
      - number
      properties:
        birthCountry:
          type:
          - string
          - 'null'
          description: "The BirthCountry property.\n            "
        name:
          description: "The Name property.\n            "
          $ref: '#/components/schemas/Name'
        nationality:
          type:
          - string
          - 'null'
          description: "The Nationality property.\n            "
          maxLength: 2
          minLength: 0
        expirationDate:
          type:
          - string
          - 'null'
          description: "The date when this travel document expires.\n            "
          format: date-time
        number:
          type: string
          description: "The travel document number.\n            "
          maxLength: 35
          minLength: 0
        issuedDate:
          type:
          - string
          - 'null'
          description: "The date this travel document was issued.\n            "
          format: date-time
        default:
          type: boolean
          description: "Flag indicating if the travel document is the default.\n            "
        gender:
          description: "The travel document holder's gender.\n            "
          $ref: '#/components/schemas/Gender'
        dateOfBirth:
          type:
          - string
          - 'null'
          description: "The person's date of birth.\n            "
          format: date-time
        declaredGender:
          type:
          - string
          - 'null'
          description: "The travel document holder's declared gender.\nThis will override the gender field on passenger or person POST, PUT, and PATCH requests.\nNote: Any value other than \"F\" will cause gender to be updated to Male by default to support compatibility with\nother systems.\nAdditionally you cannot change the declared gender and gender fields at the same time as declared gender\nwill override any gender field value regardless of the value passed in.\n            "
          maxLength: 2
          minLength: 0
        placeOfBirth:
          type:
          - string
          - 'null'
          description: "Represents the place of birth. Only used on the following document type groups: TravelVisa (9), RedressNumber (20),\nand KnownTravelerId (21).\nOnly allows alpha characters, please do not use spaces, hyphens, or special characters.\nNote: If unsure which travel document types fall into these groups please use `/api/nsk/v1/resources/DocumentTypes`\nor `/api/nsk/v1/resources/DocumentTypes/{documentTypeCode}`\n            "
          maxLength: 35
          minLength: 0
          pattern: ^[A-Za-z\s]*$
        placeOfIssue:
          type:
          - string
          - 'null'
          description: "Represents the place of issue. Only used on the following document type groups: TravelVisa (9), RedressNumber (20),\nand KnownTravelerId (21).\nOnly allows alpha characters, please do not use spaces, hyphens, or special characters.\nNote: If unsure which travel document types fall into these groups please use `/api/nsk/v1/resources/DocumentTypes`\nor `/api/nsk/v1/resources/DocumentTypes/{documentTypeCode}`\n            "
          maxLength: 35
          minLength: 0
          pattern: ^[A-Za-z\s]*$
    UserRole:
      type: object
      description: "Defines a user role.\n            "
      additionalProperties: false
      required:
      - roleCode
      - effectiveAfter
      properties:
        roleName:
          type:
          - string
          - 'null'
          description: "The role's name.\n            "
        parentRoleCode:
          type:
          - string
          - 'null'
          description: "The parents role code.\n            "
        roleCode:
          type: string
          description: "The unique role code.\n            "
          minLength: 1
        effectiveDays:
          type:
          - array
          - 'null'
          description: "The days the role is effective.\n            "
          items:
            $ref: '#/components/schemas/DayOfWeek'
        effectiveAfter:
          type: string
          description: "The date the role is effective after.\n            "
          format: date-time
          minLength: 1
        effectiveBefore:
          type:
          - string
          - 'null'
          description: "The date the role is effective before.\n            "
          format: date-time
        userRoleKey:
          type:
          - string
          - 'null'
          description: "The user role key.\n            "
    DeltaMapperOfPersonAliasRequest:
      type: object
      description: "Map delta changes of a specific type T to another object.\n            "
      additionalProperties: false
      properties:
        first:
          type:
          - string
          - 'null'
          description: "The given first name.\n            "
          maxLength: 32
          minLength: 0
        middle:
          type:
          - string
          - 'null'
          description: "The given middle name.\n            "
          maxLength: 32
          minLength: 0
        last:
          type:
          - string
          - 'null'
          description: "The given last name.\n            "
          maxLength: 32
          minLength: 0
        title:
          type:
          - string
          - 'null'
          description: "The title.\n            "
          maxLength: 6
          minLength: 0
        suffix:
          type:
          - string
          - 'null'
          description: "The suffix.\n            "
          maxLength: 6
          minLength: 0
        type:
          description: "The type of alias.\n            "
          $ref: '#/components/schemas/PersonAliasType'
    IJsonResponseOfPersonCustomerProgram:
      type: object
      description: "Defines the JSON response contract.\n            "
      additionalProperties: false
      properties:
        data:
          description: "The payload data.\n            "
          $ref: '#/components/schemas/PersonCustomerProgram'
        errors:
          type:
          - array
          - 'null'
          description: "The collection of errors being thrown.\n            "
          items:
            $ref: '#/components/schemas/ErrorResponse'
        messages:
          type:
          - array
          - 'null'
          description: "The collection of informational messages.\n            "
          items:
            $ref: '#/components/schemas/Message'
    DeltaMapperOfPersonCommentRequest:
      type: object
      description: "Map delta changes of a specific type T to another object.\n            "
      additionalProperties: false
      properties:
        text:
          type:
          - string
          - 'null'
          description: "The comments text.\n            "
        type:
          description: "The comment type.\n            "
          $ref: '#/components/schemas/PersonCommentType'
    DeltaMapperOfTravelNotificationEditRequest:
      type: object
      description: "Map delta changes of a specific type T to another object.\n            "
      additionalProperties: false
      properties:
        cultureCode:
          type:
          - string
          - 'null'
          description: "The culture code.\n            "
        notificationDestination:
          description: "The notification destination.\n            "
          properties:
            deliveryMethodCode:
              description: "The delivery method code.\n            "
              $ref: '#/components/schemas/DeliveryMethodCode'
            destination:
              type:
              - string
              - 'null'
              description: "The notification destination, an email or phone number.\n            "
        deviceName:
          type:
          - string
          - 'null'
          description: "The name of the device for the push notification.\n            "
    Name:
      type: object
      description: "Defines a common name.\n            "
      additionalProperties: false
      properties:
        first:
          type:
          - string
          - 'null'
          description: "The given first name.\n            "
          maxLength: 32
          minLength: 0
        middle:
          type:
          - string
          - 'null'
          description: "The given middle name.\n            "
          maxLength: 32
          minLength: 0
        last:
          type:
          - string
          - 'null'
          description: "The given last name.\n            "
          maxLength: 32
          minLength: 0
        title:
          type:
          - string
          - 'null'
          description: "The title.\n            "
          maxLength: 6
          minLength: 0
        suffix:
          type:
          - string
          - 'null'
          description: "The suffix.\n            "
          maxLength: 6
          minLength: 0
    UserRequest:
      type: object
      description: "Defines the user request.\n            "
      additionalProperties: false
      required:
      - username
      - codes
      properties:
        status:
          description: "The status of the account.\n            "
          $ref: '#/components/schemas/UserStatus'
        username:
          type: string
          description: "The unique username.\n            "
          maxLength: 64
          minLength: 0
        codes:
          description: "The identifying agent codes.\n            "
          $ref: '#/components/schemas/UserCodes'
        hireDate:
          type:
          - string
          - 'null'
          description: "The date the agent was hired.\n            "
          format: date-time
        terminationDate:
          type:
          - string
          - 'null'
          description: "The date the agent was terminated.\n            "
          format: date-time
        note:
          type:
          - string
          - 'null'
          description: "The agent's note.\n            "
        traceQueueCode:
          type:
          - string
          - 'null'
          description: "The trace logging queue code.\n            "
        locked:
          type: boolean
          description: "Flag indicating if the account is locked.\n            "
        forcePasswordReset:
          type:
          - boolean
          - 'null'
          description: "Flag indicating if the password needs to be reset.\n            "
    DeltaMapperOfUserRequest:
      type: object
      description: "Map delta changes of a specific type T to another object.\n            "
      additionalProperties: false
      properties:
        status:
          description: "The status of the account.\n            "
          $ref: '#/components/schemas/UserStatus'
        username:
          type: string
          description: "The unique username.\n            "
          maxLength: 64
          minLength: 0
        codes:
          description: "The identifying agent codes.\n            "
          properties:
            departmentCode:
              type: string
              description: "The user's department code.\n            "
              maxLength: 4
              minLength: 1
            locationCode:
              type: string
              description: "The user's location code.\n            "
              maxLength: 5
              minLength: 1
            locationGroupCode:
              type:
              - string
              - 'null'
              description: "The user's location group code.\n            "
            organizationCode:
              type: string
              description: "The user's organization code.\n            "
              maxLength: 10
              minLength: 0
            organizationGroupCode:
              type:
              - string
              - 'null'
              description: "The user's organization group code.\n            "
            domainCode:
              type: string
              description: "The user's domain code.\n            "
              maxLength: 3
              minLength: 0
        hireDate:
          type:
          - string
          - 'null'
          description: "The date the agent was hired.\n            "
          format: date-time
        terminationDate:
          type:
          - string
          - 'null'
          description: "The date the agent was terminated.\n            "
          format: date-time
        note:
          type:
          - string
          - 'null'
          description: "The agent's note.\n            "
        traceQueueCode:
          type:
          - string
          - 'null'
          description: "The trace logging queue code.\n            "
        locked:
          type: boolean
          description: "Flag indicating if the account is locked.\n            "
        forcePasswordReset:
          type:
          - boolean
          - 'null'
          description: "Flag indicating if the password needs to be reset.\n            "
    IJsonResponseOfUserRole:
      type: object
      description: "Defines the JSON response contract.\n            "
      additionalProperties: false
      properties:
        data:
          description: "The payload data.\n            "
          $ref: '#/components/schemas/UserRole'
        errors:
          type:
          - array
          - 'null'
          description: "The collection of errors being thrown.\n            "
          items:
            $ref: '#/components/schemas/ErrorResponse'
        messages:
          type:
          - array
          - 'null'
          description: "The collection of informational messages.\n            "
          items:
            $ref: '#/components/schemas/Message'
    DeltaMapperOfPersonPhoneNumberRequest:
      type: object
      description: "Map delta changes of a specific type T to another object.\n            "
      additionalProperties: false
      properties:
        type:
          description: "The phone number type.\n            "
          $ref: '#/components/schemas/PhoneNumberType'
        number:
          type: string
          description: "The phone number without any formatting characters.\n            "
          maxLength: 20
          minLength: 0
        default:
          type: boolean
          description: "Flag indicating if this phone number is the default.\n            "
    UserRoleCreateRequest:
      type: object
      description: "Defines the user role create request.\n            "
      additionalProperties: false
      required:
      - effectiveAfter
      - roleCode
      properties:
        effectiveDays:
          type:
          - array
          - 'null'
          description: "The days the role is effective.\n            "
          items:
            $ref: '#/components/schemas/DayOfWeek'
        effectiveAfter:
          type: string
          description: "The date the role is effective after.\n            "
          format: date-time
          minLength: 1
        effectiveBefore:
          type:
          - string
          - 'null'
          description: "The date the role is effective before.\n            "
          format: date-time
        roleCode:
          type: string
          description: "The unique role code.\n            "
          minLength: 1
    NotificationPreference:
      type: integer
      description: "Describes types of notifications the user would prefer.\n            \n\n0 = None\n1 = Promotional"
      x-enumNames:
      - None
      - Promotional
      enum:
      - 0
      - 1
    IJsonResponseOfIListOfPersonTravelDocument:
      type: object
      description: "Defines the JSON response contract.\n            "
      additionalProperties: false
      properties:
        data:
          type:
          - array
          - 'null'
          description: "The payload data.\n            "
          items:
            $ref: '#/components/schemas/PersonTravelDocument'
        errors:
          type:
          - array
          - 'null'
          description: "The collection of errors being thrown.\n            "
          items:
            $ref: '#/components/schemas/ErrorResponse'
        messages:
          type:
          - array
          - 'null'
          description: "The collection of informational messages.\n            "
          items:
            $ref: '#/components/schemas/Message'
    BookingSearchResult:
      type: object
      description: "Booking model data.\n            "
      additionalProperties: false
      properties:
        bookingKey:
          type:
          - string
          - 'null'
          description: "The booking key.\n            "
        allowedToModifyGdsBooking:
          type: boolean
          description: "Indicates whether it is allowed to modify GDS booking.\n            "
        bookingStatus:
          description: "The booking status.\n            "
          $ref: '#/components/schemas/BookingStatus'
        channelType:
          description: "The type of the channel.\n            "
          $ref: '#/components/schemas/ChannelType'
        editable:
          type: boolean
          description: "Indicates whether this is editable.\n            "
        expiredDate:
          type:
          - string
          - 'null'
          description: "The expired date.\n            "
          format: date-time
        flightDate:
          type:
          - string
          - 'null'
          description: "Flight date.\n            "
          format: date-time
        flightNumber:
          type:
          - string
          - 'null'
          description: "The flight number.\n            "
        origin:
          type:
          - string
          - 'null'
          description: "Origin.\n            "
        passengerId:
          type:
          - integer
          - 'null'
          description: "The passenger id.\n            "
          format: int64
        recordLocator:
          type:
          - string
          - 'null'
          description: "The record locator.\n            "
        sourceAgentCode:
          type:
          - string
          - 'null'
          description: "The source agent code.\n            "
        sourceDomainCode:
          type:
          - string
          - 'null'
          description: "The source domain code.\n            "
        sourceOrganizationCode:
          type:
          - string
          - 'null'
          description: "The source organization code.\n            "
        systemCode:
          type:
          - string
          - 'null'
          description: "The system code.\n            "
        destination:
          type:
          - string
          - 'null'
          description: "Destination.\n            "
        name:
          description: "The name on the booking.\n            "
          $ref: '#/components/schemas/Name'
    DeltaMapperOfPersonInformationEditRequest:
      type: object
      description: "Map delta changes of a specific type T to another object.\n            "
      additionalProperties: false
      properties:
        data:
          type:
          - string
          - 'null'
          description: "The information data.\n            "
    PersonPreference:
      type: object
      description: "Defines the person preferences.\n            "
      additionalProperties: false
      properties:
        code:
          type:
          - string
          - 'null'
          description: "The preference code.\n            "
        value:
          type:
          - string
          - 'null'
          description: "The value of the preference.\n            "
        personPreferenceKey:
          type:
          - string
          - 'null'
          description: "The unique preference key.\n            "
    IJsonResponseOfIListOfBookingTripResult:
      type: object
      description: "Defines the JSON response contract.\n            "
      additionalProperties: false
      properties:
        data:
          type:
          - array
          - 'null'
          description: "The payload data.\n            "
          items:
            $ref: '#/components/schemas/BookingTripResult'
        errors:
          type:
          - array
          - 'null'
          description: "The collection of errors being thrown.\n            "
          items:
            $ref: '#/components/schemas/ErrorResponse'
        messages:
          type:
          - array
          - 'null'
          description: "The collection of informational messages.\n            "
          items:
            $ref: '#/components/schemas/Message'
    IJsonResponseOfPersonPhoneNumber:
      type: object
      description: "Defines the JSON response contract.\n            "
      additionalProperties: false
      properties:
        data:
          description: "The payload data.\n            "
          $ref: '#/components/schemas/PersonPhoneNumber'
        errors:
          type:
          - array
          - 'null'
          description: "The collection of errors being thrown.\n            "
          items:
            $ref: '#/components/schemas/ErrorResponse'
        messages:
          type:
          - array
          - 'null'
          description: "The collection of informational messages.\n            "
          items:
            $ref: '#/components/schemas/Message'
    IJsonResponseOfPersonInformation:
      type: object
      description: "Defines the JSON response contract.\n            "
      additionalProperties: false
      properties:
        data:
          description: "The payload data.\n            "
          $ref: '#/components/schemas/PersonInformation'
        errors:
          type:
          - array
          - 'null'
          description: "The collection of errors being thrown.\n            "
          items:
            $ref: '#/components/schemas/ErrorResponse'
        messages:
          type:
          - array
          - 'null'
          description: "The collection of informational messages.\n            "
          items:
            $ref: '#/components/schemas/Message'
    PersonCustomerProgramCreateRequest:
      type: object
      description: "Defines a person's customer program create request.\n            "
      additionalProperties: false
      required:
      - programNumber
      - programCode
      properties:
        programNumber:
          type: string
          description: "The unique program number for the person.\n            "
          maxLength: 32
          minLength: 0
        effectiveDate:
          type:
          - string
          - 'null'
          description: "The effective date.\n            "
          format: date-time
        expirationDate:
          type:
          - string
          - 'null'
          description: "The expiration date.\n            "
          format: date-time
        default:
          type: boolean
          description: "True if this is set as the default program.\n            "
        programLevelCode:
          type:
          - string
          - 'null'
          description: "The program level.\n            "
          maxLength: 3
          minLength: 0
        programCode:
          type: string
          description: "The program code.\n            "
          maxLength: 3
          minLength: 0
    PersonAlias:
      type: object
      description: "Defines a person's alternate name that they go by.\n            "
      additionalProperties: false
      properties:
        type:
          description: "The type of alias.\n            "
          $ref: '#/components/schemas/PersonAliasType'
        first:
          type:
          - string
          - 'null'
          description: "The given first name.\n            "
          maxLength: 32
          minLength: 0
        middle:
          type:
          - string
          - 'null'
          description: "The given middle name.\n            "
          maxLength: 32
          minLength: 0
        last:
          type:
          - string
          - 'null'
          description: "The given last name.\n            "
          maxLength: 32
          minLength: 0
        title:
          type:
          - string
          - 'null'
          description: "The title.\n            "
          maxLength: 6
          minLength: 0
        suffix:
          type:
          - string
          - 'null'
          description: "The suffix.\n            "
          maxLength: 6
          minLength: 0
        personAliasKey:
          type:
          - string
          - 'null'
          description: "The unique person alias key.\n            "
    PersonAliasRequest:
      type: object
      description: "Defines the person alias request.\n            "
      additionalProperties: false
      properties:
        first:
          type:
          - string
          - 'null'
          description: "The given first name.\n            "
          maxLength: 32
          minLength: 0
        middle:
          type:
          - string
          - 'null'
          description: "The given middle name.\n            "
          maxLength: 32
          minLength: 0
        last:
          type:
          - string
          - 'null'
          description: "The given last name.\n            "
          maxLength: 32
          minLength: 0
        title:
          type:
          - string
          - 'null'
          description: "The title.\n            "
          maxLength: 6
          minLength: 0
        suffix:
          type:
          - string
          - 'null'
          description: "The suffix.\n            "
          maxLength: 6
          minLength: 0
        type:
          description: "The type of alias.\n            "
          $ref: '#/components/schemas/PersonAliasType'
    DeltaMapperOfEmailEditRequest:
      type: object
      description: "Map delta changes of a specific type T to another object.\n            "
      additionalProperties: false
      properties:
        email:
          type: string
          description: "The email address value.\n            "
          maxLength: 266
          minLength: 0
        default:
          type: boolean
          description: "Flag indicating if the email is the default.\n            "
    MessageStatus:
      type: integer
      description: "Defines the message status.\n            \n\n0 = General\n1 = Warning\n2 = Critical"
      x-enumNames:
      - General
      - Warning
      - Critical
      enum:
      - 0
      - 1
      - 2
    PersonCommentType:
      type: integer
      description: "Defines the different types of person comments.\n            \n\n0 = Default\n1 = Itinerary\n2 = Manifest\n3 = Alert\n4 = Archive\n5 = Voucher"
      x-enumNames:
      - Default
      - Itinerary
      - Manifest
      - Alert
      - Archive
      - Voucher
      enum:
      - 0
      - 1
      - 2
      - 3
      - 4
      - 5
    User:
      type: object
      description: "Defines a unique user.\n            "
      additionalProperties: false
      required:
      - roles
      - username
      - codes
      properties:
        lastAlertReadDate:
          type:
          - string
          - 'null'
          description: "The date the alerts were last read.\n            "
          format: date-time
        lastNewsReadDate:
          type:
          - string
          - 'null'
          description: "The date the news was last read.\n            "
          format: date-time
        allowed:
          type: boolean
          description: "Flag indicating if status is allowed.\n            "
        lastLogon:
          type:
          - string
          - 'null'
          description: "The data and time of last login.\n            "
          format: date-time
        passwordLastChanged:
          type:
          - string
          - 'null'
          description: "The date and time the password was last changed.\n            "
          format: date-time
        roles:
          type: array
          description: "The collection of authorized roles.\n            "
          items:
            $ref: '#/components/schemas/UserRole'
        settings:
          type:
          - array
          - 'null'
          description: "The collection of agent settings.\n            "
          items:
            $ref: '#/components/schemas/UserSetting'
        status:
          description: "The status of the account.\n            "
          $ref: '#/components/schemas/UserStatus'
        username:
          type: string
          description: "The unique username.\n            "
          maxLength: 64
          minLength: 0
        codes:
          description: "The identifying agent codes.\n            "
          $ref: '#/components/schemas/UserCodes'
        hireDate:
          type:
          - string
          - 'null'
          description: "The date the agent was hired.\n            "
          format: date-time
        terminationDate:
          type:
          - string
          - 'null'
          description: "The date the agent was terminated.\n            "
          format: date-time
        note:
          type:
          - string
          - 'null'
          description: "The agent's note.\n            "
        traceQueueCode:
          type:
          - string
          - 'null'
          description: "The trace logging queue code.\n            "
        locked:
          type: boolean
          description: "Flag indicating if the account is locked.\n            "
        forcePasswordReset:
          type:
          - boolean
          - 'null'
          description: "Flag indicating if the password needs to be reset.\n            "
        userKey:
          type:
          - string
          - 'null'
          description: "The unique user key.\n            "
        personKey:
          type:
          - string
          - 'null'
          description: "The unique person key associated to the user.\n            "
    NotificationDestination:
      type: object
      description: "A travel notification destination.\n            "
      additionalProperties: false
      required:
      - deliveryMethodCode
      properties:
        deliveryMethodCode:
          description: "The delivery method code.\n            "
          $ref: '#/components/schemas/DeliveryMethodCode'
        destination:
          type:
          - string
          - 'null'
          description: "The notification destination, an email or phone number.\n            "
    PersonStoredPayment:
      type: object
      description: "Defines a specific person's stored payment.\n            "
      additionalProperties: false
      required:
      - accountNumber
      - paymentMethodType
      - paymentMethodCode
      properties:
        accountNumber:
          type: string
          description: "The account number.\n            "
          maxLength: 34
          minLength: 0
        paymentMethodType:
          description: "The type of payment being added.\n            "
          $ref: '#/components/schemas/PaymentMethodType'
        accountName:
          type:
          - string
          - 'null'
          description: "The name of the account.\n            "
          maxLength: 64
          minLength: 0
        expiration:
          type:
          - string
          - 'null'
          description: "The expiration.\n            "
          format: date-time
        paymentMethodCode:
          type: string
          description: "The payment method code.\n            "
          maxLength: 2
          minLength: 1
        default:
          type: boolean
          description: "Indicates if the stored payment is the default.\n            "
        storedPaymentKey:
          type:
          - string
          - 'null'
          description: "The unique stored payment key.\n            "
    UserRecord:
      type: object
      description: "Defines a user record.\n            "
      additionalProperties: false
      properties:
        userKey:
          type:
          - string
          - 'null'
          description: "The unique user key.\n            "
        username:
          type:
          - string
          - 'null'
          description: "The unique username.\n            "
        name:
          description: "The user's name.\n            "
          $ref: '#/components/schemas/Name'
        roles:
          type:
          - array
          - 'null'
          description: "The collection of user roles.\n            "
          items:
            $ref: '#/components/schemas/UserRole'
        status:
          description: "The status of the user.\n            "
          $ref: '#/components/schemas/UserStatus'
        allowed:
          type: boolean
          description: "Flag indicating if the user is allowed.\n            "
        domainCode:
          type:
          - string
          - 'null'
          description: "The domain the user exists in.\n            "
        organizationCode:
          type:
          - string
          - 'null'
          description: "The organization the user exists in.\n            "
    NotificationEvent:
      type: object
      description: "A travel notification event.\n            "
      additionalProperties: false
      required:
      - type
      properties:
        type:
          description: "The travel notification event type.\n            "
          $ref: '#/components/schemas/NotificationEventType'
        createdDate:
          type:
          - string
          - 'null'
          description: "The created date of the travel notification.\n            "
          format: date-time
    NotificationEventType:
      type: integer
      description: "Represents the type of notification event type for a travel notification event.\n            \n\n0 = DepartureDelay\n1 = ArrivalDelay\n2 = ScheduleChange\n3 = CheckIn\n4 = GateInformation"
      x-enumNames:
      - DepartureDelay
      - ArrivalDelay
      - ScheduleChange
      - CheckIn
      - GateInformation
      enum:
      - 0
      - 1
      - 2
      - 3
      - 4
    PersonInformationCreateRequest:
      type: object
      description: "Defines a person information create request.\n            "
      additionalProperties: false
      required:
      - personInformationTypeCode
      properties:
        data:
          type:
          - string
          - 'null'
          description: "The information data.\n            "
        personInformationTypeCode:
          type: string
          description: "The person information type code.\nPlease note that this should be a char and not a string.\n            "
          maxLength: 1
          minLength: 1
    PersonType:
      type: integer
      description: "Defines the type of person.\n            \n\n0 = None\n1 = Customer\n2 = Agent"
      x-enumNames:
      - None
      - Customer
      - Agent
      enum:
      - 0
      - 1
      - 2
    UserCreateRequestv2:
      type: object
      description: "Defines the v2 user create request.\n            "
      additionalProperties: false
      required:
      - password
      - roles
      - username
      - codes
      - personKey
      properties:
        password:
          type: string
          description: "The unique password.\n            "
          maxLength: 256
          minLength: 0
        roles:
          type: array
          description: "The collection of user roles.\n            "
          items:
            $ref: '#/components/schemas/UserRoleCreateRequest'
        settings:
          type:
          - array
          - 'null'
          description: "The collection of agent settings.\n            "
          items:
            $ref: '#/components/schemas/UserSetting'
        sendRegistrationConfirmation:
          type: boolean
          description: "Send registration confirmation.\n            "
        status:
          description: "The status of the account.\n            "
          $ref: '#/components/schemas/UserStatus'
        username:
          type: string
          description: "The unique username.\n            "
          maxLength: 64
          minLength: 0
        codes:
          description: "The identifying agent codes.\n            "
          $ref: '#/components/schemas/UserCodes'
        hireDate:
          type:
          - string
          - 'null'
          description: "The date the agent was hired.\n            "
          format: date-time
        terminationDate:
          type:
          - string
          - 'null'
          description: "The date the agent was terminated.\n            "
          format: date-time
        note:
          type:
          - string
          - 'null'
          description: "The agent's note.\n            "
        traceQueueCode:
          type:
          - string
          - 'null'
          description: "The trace logging queue code.\n            "
        locked:
          type: boolean
          description: "Flag indicating if the account is locked.\n            "
        forcePasswordReset:
          type:
          - boolean
          - 'null'
          description: "Flag indicating if the password needs to be reset.\n            "
        personKey:
          type: string
          description: "The unique person key associated with the user.\n            "
          minLength: 1
    SkySpeedSettingsUserPreferences:
      type: object
      description: "Defines the SkySpeed default settings for the currently logged in user.\n            "
      additionalProperties: false
      properties:
        currencyCode:
          type:
          - string
          - 'null'
          description: "The default currency.\n            "
          maxLength: 3
          minLength: 0
        cultureCode:
          type:
          - string
          - 'null'
          description: "The default culture code.\n            "
          maxLength: 17
          minLength: 0
        countryCode:
          type:
          - string
          - 'null'
          description: "The default country.\n            "
          maxLength: 2
          minLength: 0
        nationality:
          type:
          - string
          - 'null'
          description: "The default nationality.\n            "
          maxLength: 2
          minLength: 0
        collectionCurrencyCode:
          type:
          - string
          - 'null'
          description: "The currency that is used for fees and SSRs other than the default currency.\n            "
          maxLength: 3
          minLength: 0
        collectionCurrencySetting:
          description: "Indicates to which the collection currency will be applied to.\n            "
          $ref: '#/components/schemas/CollectionCurrencySetting'
        flightResultFareType:
          description: "Indicates whether to display flights with monetary, loyalty or both fares in the flight results.\n            "
          $ref: '#/components/schemas/FlightResultFareType'
    IJsonResponseOfSkySpeedSettingsUserPreferences:
      type: object
      description: "Defines the JSON response contract.\n            "
      additionalProperties: false
      properties:
        data:
          description: "The payload data.\n            "
          $ref: '#/components/schemas/SkySpeedSettingsUserPreferences'
        errors:
          type:
          - array
          - 'null'
          description: "The collection of errors being thrown.\n            "
          items:
            $ref: '#/components/schemas/ErrorResponse'
        messages:
          type:
          - array
          - 'null'
          description: "The collection of informational messages.\n            "
          items:
            $ref: '#/components/schemas/Message'
    NotificationTimedEvent:
      type: object
      description: "A travel notification timed event.\n            "
      additionalProperties: false
      required:
      - type
      properties:
        type:
          description: "The travel notification timed event type.\n            "
          $ref: '#/components/schemas/NotificationTimedEventType'
        minutesToEvent:
          type: integer
          description: "The minutes to the event.\n            "
          format: int32
        createdDate:
          type:
          - string
          - 'null'
          description: "The created date of the travel notification.\n            "
          format: date-time
    PersonBasicInformation:
      type: object
      description: "Defines the person's basic information.\n            "
      additionalProperties: false
      properties:
        gender:
          description: "The person's gender.\n            "
          $ref: '#/components/schemas/Gender'
        dateOfBirth:
          type:
          - string
          - 'null'
          description: "The person's date of birth.\n            "
          format: date-time
        nationality:
          type:
          - string
          - 'null'
          description: "The person's nationality.\n            "
        residentCountry:
          type:
          - string
          - 'null'
          description: "The person's resident country.\n            "
        passengerType:
          type:
          - string
          - 'null'
          description: "The type of passenger the person is.\n            "
        preferredCultureCode:
          type:
          - string
          - 'null'
          description: "The person's preferred culture code.\n            "
        preferredCurrencyCode:
          type:
          - string
          - 'null'
          description: "The person's preferred currency code.\n            "
        nationalIdNumber:
          type:
          - string
          - 'null'
          description: "The person's national ID number.\n            "
        declaredGender:
          type:
          - string
          - 'null'
          description: "The person's declared gender. A value of \"F\" is mapped to a female binary gender. All other values will be\nmapped to a male binary gender.\n            "
          maxLength: 2
          minLength: 0
    ErrorResponse:
      type: object
      description: "Defines a unique error response.\n            "
      additionalProperties: false
      properties:
        exception:
          description: "The original exception that was thrown and all the exception details.\n            "
          $ref: '#/components/schemas/Exception'
        rawMessage:
          type:
          - string
          - 'null'
          description: "The original raw message set (non-localized).\n            "
        code:
          type:
          - string
          - 'null'
          description: "The unique error code. The primary value used to match against a unique message localized for the end user in the\nchosen language.\n            "
        message:
          type:
          - string
          - 'null'
          description: "The error message. Deprecated: Please use the Code instead.\n            "
        type:
          type:
          - string
          - 'null'
          description: "The error type showing severity. Values: Critical, Error, Validation, Information.\n            "
        number:
          type:
          - integer
          - 'null'
          description: "A unique identifier in numeric form. This is required for Splunk logging. If none is provided a number will be\ngenerated based on code and type.\n            "
          format: int32
          maximum: 99999.0
          minimum: 0.0
        details:
          type:
          - object
          - 'null'
          description: "Dynamic detailed information about the error.\n            "
          additionalProperties:
            type: string
        ActivityId:
          type:
          - string
          - 'null'
          description: "The activity ID unique to the request. Useful for debugging purposes to uniquely look up what happened for this\nspecific request.\n            "
    IJsonResponseOfIListOfNotificationTimedEvent:
      type: object
      description: "Defines the JSON response contract.\n            "
      additionalProperties: false
      properties:
        data:
          type:
          - array
          - 'null'
          description: "The payload data.\n            "
          items:
            $ref: '#/components/schemas/NotificationTimedEvent'
        errors:
          type:
          - array
          - 'null'
          description: "The collection of errors being thrown.\n            "
          items:
            $ref: '#/components/schemas/ErrorResponse'
        messages:
          type:
          - array
          - 'null'
          description: "The collection of informational messages.\n            "
          items:
            $ref: '#/components/schemas/Message'
    UserCreateRequest:
      type: object
      description: "Defines the user create request.\n            "
      additionalProperties: false
      required:
      - password
      - roles
      - username
      - codes
      - person
      properties:
        password:
          type: string
          description: "The unique password.\n            "
          maxLength: 256
          minLength: 0
        roles:
          type: array
          description: "The collection of user roles.\n            "
          items:
            $ref: '#/components/schemas/UserRoleCreateRequest'
        settings:
          type:
          - array
          - 'null'
          description: "The collection of agent settings.\n            "
          items:
            $ref: '#/components/schemas/UserSetting'
        sendRegistrationConfirmation:
          type: boolean
          description: "Send registration confirmation.\n            "
        status:
          description: "The status of the account.\n            "
          $ref: '#/components/schemas/UserStatus'
        username:
          type: string
          description: "The unique username.\n            "
          maxLength: 64
          minLength: 0
        codes:
          description: "The identifying agent codes.\n            "
          $ref: '#/components/schemas/UserCodes'
        hireDate:
          type:
          - string
          - 'null'
          description: "The date the agent was hired.\n            "
          format: date-time
        terminationDate:
          type:
          - string
          - 'null'
          description: "The date the agent was terminated.\n            "
          format: date-time
        note:
          type:
          - string
          - 'null'
          description: "The agent's note.\n            "
        traceQueueCode:
          type:
          - string
          - 'null'
          description: "The trace logging queue code.\n            "
        locked:
          type: boolean
          description: "Flag indicating if the account is locked.\n            "
        forcePasswordReset:
          type:
          - boolean
          - 'null'
          description: "Flag indicating if the password needs to be reset.\n            "
        person:
          description: "The person to create for the user.\n            "
          $ref: '#/components/schemas/PersonCreateRequest'
    IJsonResponseOfIListOfPersonAddress:
      type: object
      description: "Defines the JSON response contract.\n            "
      additionalProperties: false
      properties:
        data:
          type:
          - array
          - 'null'
          description: "The payload data.\n            "
          items:
            $ref: '#/components/schemas/PersonAddress'
        errors:
          type:
          - array
          - 'null'
          description: "The collection of errors being thrown.\n            "
          items:
            $ref: '#/components/schemas/ErrorResponse'
        messages:
          type:
          - array
          - 'null'
          description: "The collection of informational messages.\n            "
          items:
            $ref: '#/components/schemas/Message'
    IJsonResponseOfPersonTravelNotification:
      type: object
      description: "Defines the JSON response contract.\n            "
      additionalProperties: false
      properties:
        data:
          description: "The payload data.\n            "
          $ref: '#/components/schemas/PersonTravelNotification'
        errors:
          type:
          - array
          - 'null'
          description: "The collection of errors being thrown.\n            "
          items:
            $ref: '#/components/schemas/ErrorResponse'
        messages:
          type:
          - array
          - 'null'
          description: "The collection of informational messages.\n            "
          items:
            $ref: '#/components/schemas/Message'
    IJsonResponseOfIListOfPersonPreference:
      type: object
      description: "Defines the JSON response contract.\n            "
      additionalProperties: false
      properties:
        data:
          type:
          - array
          - 'null'
          description: "The payload data.\n            "
          items:
            $ref: '#/components/schemas/PersonPreference'
        errors:
          type:
          - array
          - 'null'
          description: "The collection of errors being thrown.\n            "
          items:
            $ref: '#/components/schemas/ErrorResponse'
        messages:
          type:
          - array
          - 'null'
          description: "The collection of informational messages.\n            "
          items:
            $ref: '#/components/schemas/Message'
    PersonInformation:
      type: object
      description: "Defines the a person information.\n            "
      additionalProperties: false
      required:
      - personInformationTypeCode
      properties:
        size:
          type: integer
          description: "The size of the information data.\n            "
          format: int32
        personInformationTypeCode:
          type: string
          description: "The person information type code.\nPlease note that this should be a char and not a string.\n            "
          maxLength: 1
          minLength: 1
        data:
          type:
          - string
          - 'null'
          description: "The information data.\n            "
        personInformationKey:
          type:
          - string
          - 'null'
          description: "The unique person information key.\n            "
  securitySchemes:
    JWT:
      type: http
      description: Paste your JWT token from the token endpoint.
      scheme: bearer
      bearerFormat: jwt
x-generator: NSwag v14.6.3.0 (NJsonSchema v11.5.2.0 (Newtonsoft.Json v13.0.0.0))