Interface RequestInspectionACFP.Builder

All Superinterfaces:
Buildable, CopyableBuilder<RequestInspectionACFP.Builder,RequestInspectionACFP>, SdkBuilder<RequestInspectionACFP.Builder,RequestInspectionACFP>, SdkPojo
Enclosing class:
RequestInspectionACFP
public static interface RequestInspectionACFP.Builder extends SdkPojo, CopyableBuilder<RequestInspectionACFP.Builder,RequestInspectionACFP>

  • Method Details

    • payloadType

      RequestInspectionACFP.Builder payloadType(String payloadType)

      The payload type for your account creation endpoint, either JSON or form encoded.

      Parameters:
      payloadType - The payload type for your account creation endpoint, either JSON or form encoded.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • payloadType

      RequestInspectionACFP.Builder payloadType(PayloadType payloadType)

      The payload type for your account creation endpoint, either JSON or form encoded.

      Parameters:
      payloadType - The payload type for your account creation endpoint, either JSON or form encoded.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • usernameField

      RequestInspectionACFP.Builder usernameField(UsernameField usernameField)

      The name of the field in the request payload that contains your customer's username.

      How you specify this depends on the request inspection payload type.

      • For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer.

        For example, for the JSON payload { "form": { "username": "THE_USERNAME" } }, the username field specification is /form/username.

      • For form encoded payload types, use the HTML form names.

        For example, for an HTML form with the input element named username1, the username field specification is username1

      Parameters:
      usernameField - The name of the field in the request payload that contains your customer's username.

      How you specify this depends on the request inspection payload type.

      • For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer.

        For example, for the JSON payload { "form": { "username": "THE_USERNAME" } }, the username field specification is /form/username.

      • For form encoded payload types, use the HTML form names.

        For example, for an HTML form with the input element named username1, the username field specification is username1

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • usernameField

      default RequestInspectionACFP.Builder usernameField(Consumer<UsernameField.Builder> usernameField)

      The name of the field in the request payload that contains your customer's username.

      How you specify this depends on the request inspection payload type.

      • For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer.

        For example, for the JSON payload { "form": { "username": "THE_USERNAME" } }, the username field specification is /form/username.

      • For form encoded payload types, use the HTML form names.

        For example, for an HTML form with the input element named username1, the username field specification is username1

      This is a convenience method that creates an instance of the UsernameField.Builder avoiding the need to create one manually via UsernameField.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to usernameField(UsernameField).

      Parameters:
      usernameField - a consumer that will call methods on UsernameField.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • passwordField

      RequestInspectionACFP.Builder passwordField(PasswordField passwordField)

      The name of the field in the request payload that contains your customer's password.

      How you specify this depends on the request inspection payload type.

      • For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer.

        For example, for the JSON payload { "form": { "password": "THE_PASSWORD" } }, the password field specification is /form/password.

      • For form encoded payload types, use the HTML form names.

        For example, for an HTML form with the input element named password1, the password field specification is password1.

      Parameters:
      passwordField - The name of the field in the request payload that contains your customer's password.

      How you specify this depends on the request inspection payload type.

      • For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer.

        For example, for the JSON payload { "form": { "password": "THE_PASSWORD" } }, the password field specification is /form/password.

      • For form encoded payload types, use the HTML form names.

        For example, for an HTML form with the input element named password1, the password field specification is password1.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • passwordField

      default RequestInspectionACFP.Builder passwordField(Consumer<PasswordField.Builder> passwordField)

      The name of the field in the request payload that contains your customer's password.

      How you specify this depends on the request inspection payload type.

      • For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer.

        For example, for the JSON payload { "form": { "password": "THE_PASSWORD" } }, the password field specification is /form/password.

      • For form encoded payload types, use the HTML form names.

        For example, for an HTML form with the input element named password1, the password field specification is password1.

      This is a convenience method that creates an instance of the PasswordField.Builder avoiding the need to create one manually via PasswordField.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to passwordField(PasswordField).

      Parameters:
      passwordField - a consumer that will call methods on PasswordField.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • emailField

      RequestInspectionACFP.Builder emailField(EmailField emailField)

      The name of the field in the request payload that contains your customer's email.

      How you specify this depends on the request inspection payload type.

      • For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer.

        For example, for the JSON payload { "form": { "email": "THE_EMAIL" } }, the email field specification is /form/email.

      • For form encoded payload types, use the HTML form names.

        For example, for an HTML form with the input element named email1, the email field specification is email1.

      Parameters:
      emailField - The name of the field in the request payload that contains your customer's email.

      How you specify this depends on the request inspection payload type.

      • For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer.

        For example, for the JSON payload { "form": { "email": "THE_EMAIL" } }, the email field specification is /form/email.

      • For form encoded payload types, use the HTML form names.

        For example, for an HTML form with the input element named email1, the email field specification is email1.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • emailField

      default RequestInspectionACFP.Builder emailField(Consumer<EmailField.Builder> emailField)

      The name of the field in the request payload that contains your customer's email.

      How you specify this depends on the request inspection payload type.

      • For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer.

        For example, for the JSON payload { "form": { "email": "THE_EMAIL" } }, the email field specification is /form/email.

      • For form encoded payload types, use the HTML form names.

        For example, for an HTML form with the input element named email1, the email field specification is email1.

      This is a convenience method that creates an instance of the EmailField.Builder avoiding the need to create one manually via EmailField.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to emailField(EmailField).

      Parameters:
      emailField - a consumer that will call methods on EmailField.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • phoneNumberFields

      RequestInspectionACFP.Builder phoneNumberFields(Collection<PhoneNumberField> phoneNumberFields)

      The names of the fields in the request payload that contain your customer's primary phone number.

      Order the phone number fields in the array exactly as they are ordered in the request payload.

      How you specify the phone number fields depends on the request inspection payload type.

      • For JSON payloads, specify the field identifiers in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer.

        For example, for the JSON payload { "form": { "primaryphoneline1": "THE_PHONE1", "primaryphoneline2": "THE_PHONE2", "primaryphoneline3": "THE_PHONE3" } } , the phone number field identifiers are /form/primaryphoneline1, /form/primaryphoneline2, and /form/primaryphoneline3.

      • For form encoded payload types, use the HTML form names.

        For example, for an HTML form with input elements named primaryphoneline1, primaryphoneline2, and primaryphoneline3, the phone number field identifiers are primaryphoneline1, primaryphoneline2, and primaryphoneline3.

      Parameters:
      phoneNumberFields - The names of the fields in the request payload that contain your customer's primary phone number.

      Order the phone number fields in the array exactly as they are ordered in the request payload.

      How you specify the phone number fields depends on the request inspection payload type.

      • For JSON payloads, specify the field identifiers in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer.

        For example, for the JSON payload { "form": { "primaryphoneline1": "THE_PHONE1", "primaryphoneline2": "THE_PHONE2", "primaryphoneline3": "THE_PHONE3" } } , the phone number field identifiers are /form/primaryphoneline1, /form/primaryphoneline2, and /form/primaryphoneline3.

      • For form encoded payload types, use the HTML form names.

        For example, for an HTML form with input elements named primaryphoneline1, primaryphoneline2, and primaryphoneline3, the phone number field identifiers are primaryphoneline1, primaryphoneline2, and primaryphoneline3 .

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • phoneNumberFields

      RequestInspectionACFP.Builder phoneNumberFields(PhoneNumberField... phoneNumberFields)

      The names of the fields in the request payload that contain your customer's primary phone number.

      Order the phone number fields in the array exactly as they are ordered in the request payload.

      How you specify the phone number fields depends on the request inspection payload type.

      • For JSON payloads, specify the field identifiers in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer.

        For example, for the JSON payload { "form": { "primaryphoneline1": "THE_PHONE1", "primaryphoneline2": "THE_PHONE2", "primaryphoneline3": "THE_PHONE3" } } , the phone number field identifiers are /form/primaryphoneline1, /form/primaryphoneline2, and /form/primaryphoneline3.

      • For form encoded payload types, use the HTML form names.

        For example, for an HTML form with input elements named primaryphoneline1, primaryphoneline2, and primaryphoneline3, the phone number field identifiers are primaryphoneline1, primaryphoneline2, and primaryphoneline3.

      Parameters:
      phoneNumberFields - The names of the fields in the request payload that contain your customer's primary phone number.

      Order the phone number fields in the array exactly as they are ordered in the request payload.

      How you specify the phone number fields depends on the request inspection payload type.

      • For JSON payloads, specify the field identifiers in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer.

        For example, for the JSON payload { "form": { "primaryphoneline1": "THE_PHONE1", "primaryphoneline2": "THE_PHONE2", "primaryphoneline3": "THE_PHONE3" } } , the phone number field identifiers are /form/primaryphoneline1, /form/primaryphoneline2, and /form/primaryphoneline3.

      • For form encoded payload types, use the HTML form names.

        For example, for an HTML form with input elements named primaryphoneline1, primaryphoneline2, and primaryphoneline3, the phone number field identifiers are primaryphoneline1, primaryphoneline2, and primaryphoneline3 .

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • phoneNumberFields

      RequestInspectionACFP.Builder phoneNumberFields(Consumer<PhoneNumberField.Builder>... phoneNumberFields)

      The names of the fields in the request payload that contain your customer's primary phone number.

      Order the phone number fields in the array exactly as they are ordered in the request payload.

      How you specify the phone number fields depends on the request inspection payload type.

      • For JSON payloads, specify the field identifiers in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer.

        For example, for the JSON payload { "form": { "primaryphoneline1": "THE_PHONE1", "primaryphoneline2": "THE_PHONE2", "primaryphoneline3": "THE_PHONE3" } } , the phone number field identifiers are /form/primaryphoneline1, /form/primaryphoneline2, and /form/primaryphoneline3.

      • For form encoded payload types, use the HTML form names.

        For example, for an HTML form with input elements named primaryphoneline1, primaryphoneline2, and primaryphoneline3, the phone number field identifiers are primaryphoneline1, primaryphoneline2, and primaryphoneline3.

      This is a convenience method that creates an instance of the PhoneNumberField.Builder avoiding the need to create one manually via PhoneNumberField.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to phoneNumberFields(List<PhoneNumberField>).

      Parameters:
      phoneNumberFields - a consumer that will call methods on PhoneNumberField.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • addressFields

      RequestInspectionACFP.Builder addressFields(Collection<AddressField> addressFields)

      The names of the fields in the request payload that contain your customer's primary physical address.

      Order the address fields in the array exactly as they are ordered in the request payload.

      How you specify the address fields depends on the request inspection payload type.

      • For JSON payloads, specify the field identifiers in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer.

        For example, for the JSON payload { "form": { "primaryaddressline1": "THE_ADDRESS1", "primaryaddressline2": "THE_ADDRESS2", "primaryaddressline3": "THE_ADDRESS3" } } , the address field idenfiers are /form/primaryaddressline1, /form/primaryaddressline2, and /form/primaryaddressline3.

      • For form encoded payload types, use the HTML form names.

        For example, for an HTML form with input elements named primaryaddressline1, primaryaddressline2, and primaryaddressline3, the address fields identifiers are primaryaddressline1, primaryaddressline2, and primaryaddressline3.

      Parameters:
      addressFields - The names of the fields in the request payload that contain your customer's primary physical address.

      Order the address fields in the array exactly as they are ordered in the request payload.

      How you specify the address fields depends on the request inspection payload type.

      • For JSON payloads, specify the field identifiers in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer.

        For example, for the JSON payload { "form": { "primaryaddressline1": "THE_ADDRESS1", "primaryaddressline2": "THE_ADDRESS2", "primaryaddressline3": "THE_ADDRESS3" } } , the address field idenfiers are /form/primaryaddressline1, /form/primaryaddressline2, and /form/primaryaddressline3.

      • For form encoded payload types, use the HTML form names.

        For example, for an HTML form with input elements named primaryaddressline1, primaryaddressline2, and primaryaddressline3, the address fields identifiers are primaryaddressline1, primaryaddressline2, and primaryaddressline3.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • addressFields

      RequestInspectionACFP.Builder addressFields(AddressField... addressFields)

      The names of the fields in the request payload that contain your customer's primary physical address.

      Order the address fields in the array exactly as they are ordered in the request payload.

      How you specify the address fields depends on the request inspection payload type.

      • For JSON payloads, specify the field identifiers in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer.

        For example, for the JSON payload { "form": { "primaryaddressline1": "THE_ADDRESS1", "primaryaddressline2": "THE_ADDRESS2", "primaryaddressline3": "THE_ADDRESS3" } } , the address field idenfiers are /form/primaryaddressline1, /form/primaryaddressline2, and /form/primaryaddressline3.

      • For form encoded payload types, use the HTML form names.

        For example, for an HTML form with input elements named primaryaddressline1, primaryaddressline2, and primaryaddressline3, the address fields identifiers are primaryaddressline1, primaryaddressline2, and primaryaddressline3.

      Parameters:
      addressFields - The names of the fields in the request payload that contain your customer's primary physical address.

      Order the address fields in the array exactly as they are ordered in the request payload.

      How you specify the address fields depends on the request inspection payload type.

      • For JSON payloads, specify the field identifiers in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer.

        For example, for the JSON payload { "form": { "primaryaddressline1": "THE_ADDRESS1", "primaryaddressline2": "THE_ADDRESS2", "primaryaddressline3": "THE_ADDRESS3" } } , the address field idenfiers are /form/primaryaddressline1, /form/primaryaddressline2, and /form/primaryaddressline3.

      • For form encoded payload types, use the HTML form names.

        For example, for an HTML form with input elements named primaryaddressline1, primaryaddressline2, and primaryaddressline3, the address fields identifiers are primaryaddressline1, primaryaddressline2, and primaryaddressline3.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • addressFields

      RequestInspectionACFP.Builder addressFields(Consumer<AddressField.Builder>... addressFields)

      The names of the fields in the request payload that contain your customer's primary physical address.

      Order the address fields in the array exactly as they are ordered in the request payload.

      How you specify the address fields depends on the request inspection payload type.

      • For JSON payloads, specify the field identifiers in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer.

        For example, for the JSON payload { "form": { "primaryaddressline1": "THE_ADDRESS1", "primaryaddressline2": "THE_ADDRESS2", "primaryaddressline3": "THE_ADDRESS3" } } , the address field idenfiers are /form/primaryaddressline1, /form/primaryaddressline2, and /form/primaryaddressline3.

      • For form encoded payload types, use the HTML form names.

        For example, for an HTML form with input elements named primaryaddressline1, primaryaddressline2, and primaryaddressline3, the address fields identifiers are primaryaddressline1, primaryaddressline2, and primaryaddressline3.

      This is a convenience method that creates an instance of the AddressField.Builder avoiding the need to create one manually via AddressField.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to addressFields(List<AddressField>).

      Parameters:
      addressFields - a consumer that will call methods on AddressField.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: