action plaid_link_delivery_create {
  label: "Create Link Delivery session"
  description: "Use the `/link_delivery/create` endpoint to create a Link Delivery session."
  provider: plaid
  method: POST
  path: "/link_delivery/create"
  encoding: json
  input: {
    type: "object"
    description: "LinkDeliveryCreateRequest defines the request schema for `/link_delivery/create`"
    required: ["communication_methods", "link_token"]
    properties: {
      client_id: {
        type: "string"
        description: "Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body."
      }
      communication_methods: {
        type: "array"
        description: "The list of communication methods to send the Link Delivery URL to."
        items: {
          type: "object"
          description: "The communication method containing both the type and address to send the URL."
          properties: {
            address: {
              type: "string"
              description: "The address to deliver the Link Delivery URL"
            }
            method: {
              type: "string"
              description: "The delivery method to be used to deliver the Link Delivery URL.\n\n`SMS`: The URL will be delivered through SMS\n\n`EMAIL`: The URL will be delivered through email"
              enum: ["SMS", "EMAIL"]
            }
          }
        }
      }
      link_token: {
        type: "string"
        description: "A `link_token` from a previous invocation of `/link/token/create` with Link Delivery enabled."
      }
      secret: {
        type: "string"
        description: "Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body."
      }
    }
  }
  output: {
    type: "object"
    description: "LinkDeliveryCreateResponse defines the response schema for `/link_delivery/create`"
    required: ["link_delivery_session_id", "link_delivery_url", "request_id"]
    properties: {
      link_delivery_session_id: {
        type: "string"
        description: "The ID for the Link Delivery session. Same as the `link_token` string excluding the \"link-{env}-\" prefix."
      }
      link_delivery_url: {
        type: "string"
        description: "The URL to the Link Delivery session, which will be delivered by the specified delivery method."
      }
      request_id: {
        type: "string"
        description: "A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive."
      }
    }
  }
}