{
  "components": {
    "schemas": {
      "customer": {
        "description": "Customer",
        "properties": {
          "financialAccountNumber": {
            "type": "string",
            "format": "uuid",
            "description": "financialAccountNumber"
          },
          "customerName": {
            "type": "string",
            "description": "customerName"
          },
          "branchNumber": {
            "type": "string",
            "description": "branchNumber"
          },
          "address1": {
            "type": "string",
            "description": "address1"
          },
          "address2": {
            "type": "string",
            "description": "address2"
          },
          "city": {
            "type": "string",
            "description": "city"
          },
          "state": {
            "type": "string",
            "description": "state"
          },
          "zip": {
            "type": "string",
            "description": "zip"
          }
        },
        "required": [
          "financialAccountNumber",
          "customerName",
          "branchNumber"
        ],
        "type": "object"
      },
      "customer_create_form": {
        "description": "customer Creation Form",
        "properties": {
          "branchNumber": {
            "type": "string",
            "description": "Branch Number"
          },
          "customerName": {
            "type": "string",
            "description": "customer Name"
          },
          "email": {
            "type": "string",
            "description": "Email"
          },
          "address1": {
            "type": "string",
            "description": "Address1"
          },
          "address2": {
            "type": "string",
            "description": "Address2"
          },
          "city": {
            "type": "string",
            "description": "City"
          },
          "state": {
            "type": "string",
            "description": "State"
          },
          "zip": {
            "type": "string",
            "description": "Zip"
          }
        },
        "required": [
          "branchNumber",
          "customerName",
          "email",
          "address1",
          "city",
          "state",
          "zip"
        ],
        "type": "object"
      },
      "customer_summary": {
        "description": "Customer Summery",
        "properties": {
          "financialAccountNumber": {
            "type": "string",
            "format": "uuid",
            "description": "Financial Account Number"
          },
          "customerName": {
            "type": "string",
            "description": "Customer Name"
          }
        },
        "required": [
          "financialAccountNumber",
          "customerName"
        ],
        "type": "object"
      },
      "customer_update_form": {
        "description": "customer Update Form",
        "properties": {
          "financialAccountNumber": {
            "type": "string",
            "description": "Financial Account Number"
          },
          "customerName": {
            "type": "string",
            "description": "Customer Name"
          },
          "email": {
            "type": "string",
            "description": "Email"
          },
          "address1": {
            "type": "string",
            "description": "Address1"
          },
          "address2": {
            "type": "string",
            "description": "Address2"
          },
          "city": {
            "type": "string",
            "description": "City"
          },
          "state": {
            "type": "string",
            "description": "State"
          },
          "zip": {
            "type": "string",
            "description": "Zip"
          }
        },
        "required": [
          "financialAccountNumber",
          "customerName",
          "email",
          "address1",
          "address2",
          "city",
          "state",
          "zip"
        ],
        "type": "object"
      },
      "error": {
        "properties": {
          "code": {
            "type": "string",
            "description": "Machine readable code for this specific error message"
          },
          "description": {
            "type": "string",
            "description": "Description of the error"
          }
        },
        "required": [
          "code",
          "description"
        ],
        "type": "object"
      }
    }
  },
  "info": {
    "contact": {
      "name": "IBM"
    },
    "description": "Customer API documentation providing details for REST APIs",
    "license": {
      "name": "MIT",
      "url": "http://opensource.org/licenses/MIT"
    },
    "termsOfService": "",
    "title": "Customer api",
    "version": "0.0.1-dev"
  },
  "openapi": "3.0.2",
  "paths": {
    "/customers/customers": {
      "get": {
        "description": "Search for a specific customer. You must specify at least 1 parameter - either a guid, email or token - and will receive back either 0 or 1 users.",
        "operationId": "get--customers-customers",
        "parameters": [
          {
            "deprecated": false,
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "format": "uuid"
            },
            "description": "Find customer with this financialAccountNumber. Exact match",
            "name": "financialAccountNumber"
          },
          {
            "deprecated": false,
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            },
            "description": "Find user with this email address. Case in-sensitive. Exact match",
            "name": "email"
          },
          {
            "deprecated": false,
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            },
            "description": "Find user with the specified nickname. For users that register via GitHub, this will be their GitHub username. Case in-sensitive. Exact match",
            "name": "customerName"
          }
        ],
        "responses": {
          "200": {
            "description": "[platform.ibm.com.customer.api.v0.models.customer]",
            "content": {
              "application/json": {
                "schema": {
                  "items": {
                    "$ref": "#/components/schemas/customer"
                  },
                  "type": "array"
                }
              }
            },
            "headers": {}
          },
          "404": {
            "description": "[platform.ibm.com.customer.api.v0.models.error]",
            "content": {
              "application/json": {
                "schema": {
                  "items": {
                    "$ref": "#/components/schemas/error"
                  },
                  "type": "array"
                }
              }
            },
            "headers": {}
          },
          "500": {
            "description": "[platform.ibm.com.customer.api.v0.models.error]",
            "content": {
              "application/json": {
                "schema": {
                  "items": {
                    "$ref": "#/components/schemas/error"
                  },
                  "type": "array"
                }
              }
            },
            "headers": {}
          }
        },
        "tags": [
          "customer"
        ]
      },
      "post": {
        "description": "Create a new customer.",
        "operationId": "post--customers-customers",
        "parameters": [],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/customer_create_form"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "platform.ibm.com.customer.api.v0.models.customer",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/customer"
                }
              }
            },
            "headers": {}
          },
          "500": {
            "description": "[platform.ibm.com.customer.api.v0.models.error]",
            "content": {
              "application/json": {
                "schema": {
                  "items": {
                    "$ref": "#/components/schemas/error"
                  },
                  "type": "array"
                }
              }
            },
            "headers": {}
          }
        },
        "tags": [
          "customer"
        ]
      }
    },
    "/customers/:customerName": {
      "get": {
        "description": "Returns information about the user with this financialAccountNumber.",
        "operationId": "get--customers-customerName",
        "parameters": [
          {
            "deprecated": false,
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            },
            "name": "customerName"
          }
        ],
        "responses": {
          "200": {
            "description": "platform.ibm.com.customer.api.v0.models.customer",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/customer"
                }
              }
            },
            "headers": {}
          },
          "404": {
            "description": "[platform.ibm.com.customer.api.v0.models.error]",
            "content": {
              "application/json": {
                "schema": {
                  "items": {
                    "$ref": "#/components/schemas/error"
                  },
                  "type": "array"
                }
              }
            },
            "headers": {}
          },
          "500": {
            "description": "[platform.ibm.com.customer.api.v0.models.error]",
            "content": {
              "application/json": {
                "schema": {
                  "items": {
                    "$ref": "#/components/schemas/error"
                  },
                  "type": "array"
                }
              }
            },
            "headers": {}
          }
        },
        "tags": [
          "customer"
        ]
      },
      "put": {
        "description": "Updates information about the customer with the specified financialAccountNumber.",
        "operationId": "put--customers-customerName",
        "parameters": [
          {
            "deprecated": false,
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            },
            "name": "customerName"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/customer_update_form"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "platform.ibm.com.customer.api.v0.models.customer",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/customer"
                }
              }
            },
            "headers": {}
          },
          "404": {
            "description": "[platform.ibm.com.customer.api.v0.models.error]",
            "content": {
              "application/json": {
                "schema": {
                  "items": {
                    "$ref": "#/components/schemas/error"
                  },
                  "type": "array"
                }
              }
            },
            "headers": {}
          },
          "500": {
            "description": "[platform.ibm.com.customer.api.v0.models.error]",
            "content": {
              "application/json": {
                "schema": {
                  "items": {
                    "$ref": "#/components/schemas/error"
                  },
                  "type": "array"
                }
              }
            },
            "headers": {}
          }
        },
        "tags": [
          "customer"
        ]
      }
    }
  },
  "servers": [
    {
      "url": "https://api.apibuilder.io"
    }
  ]
}