{
  "opencollection": "1.0.0",
  "info": {
    "name": "Telnyx Access Tokens Phone Number Orders API",
    "version": "2.0.0"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Phone Number Orders",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Retrieve all comments",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/comments",
            "params": [
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "Consolidated filter parameter (deepObject style). Originally: filter[comment_record_type], filter[comment_record_id]"
              }
            ]
          },
          "docs": "Retrieve all comments"
        },
        {
          "info": {
            "name": "Create a comment",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telnyx.com/v2/comments",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a comment"
        },
        {
          "info": {
            "name": "Retrieve a comment",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/comments/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The comment ID."
              }
            ]
          },
          "docs": "Retrieve a comment"
        },
        {
          "info": {
            "name": "Mark a comment as read",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.telnyx.com/v2/comments/:id/read",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The comment ID."
              }
            ]
          },
          "docs": "Mark a comment as read"
        },
        {
          "info": {
            "name": "Retrieve a list of phone numbers associated to orders",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/number_order_phone_numbers",
            "params": [
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "Consolidated filter parameter (deepObject style). Originally: filter[country_code]"
              }
            ]
          },
          "docs": "Get a list of phone numbers associated to orders."
        },
        {
          "info": {
            "name": "Retrieve a single phone number within a number order.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/number_order_phone_numbers/:number_order_phone_number_id",
            "params": [
              {
                "name": "number_order_phone_number_id",
                "value": "",
                "type": "path",
                "description": "The number order phone number ID."
              }
            ]
          },
          "docs": "Get an existing phone number in number order."
        },
        {
          "info": {
            "name": "Update requirements for a single phone number within a number order.",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.telnyx.com/v2/number_order_phone_numbers/:number_order_phone_number_id",
            "params": [
              {
                "name": "number_order_phone_number_id",
                "value": "",
                "type": "path",
                "description": "The number order phone number ID."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates requirements for a single phone number within a number order."
        },
        {
          "info": {
            "name": "List number orders",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/number_orders",
            "params": [
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]"
              },
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "Consolidated filter parameter (deepObject style). Originally: filter[status], filter[created_at], filter[phone_numbers_count], filter[customer_reference], filter[requirements_met]"
              }
            ]
          },
          "docs": "Get a paginated list of number orders."
        },
        {
          "info": {
            "name": "Create a number order",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telnyx.com/v2/number_orders",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a phone number order."
        },
        {
          "info": {
            "name": "Retrieve a number order",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/number_orders/:number_order_id",
            "params": [
              {
                "name": "number_order_id",
                "value": "",
                "type": "path",
                "description": "The number order ID."
              }
            ]
          },
          "docs": "Get an existing phone number order."
        },
        {
          "info": {
            "name": "Update a number order",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.telnyx.com/v2/number_orders/:number_order_id",
            "params": [
              {
                "name": "number_order_id",
                "value": "",
                "type": "path",
                "description": "The number order ID."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates a phone number order."
        },
        {
          "info": {
            "name": "List sub number orders",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/sub_number_orders",
            "params": [
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "Consolidated filter parameter (deepObject style). Originally: filter[status], filter[order_request_id], filter[country_code], filter[phone_number_type], filter[phone_numbers_count]"
              }
            ]
          },
          "docs": "Get a paginated list of sub number orders."
        },
        {
          "info": {
            "name": "Retrieve a sub number order",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/sub_number_orders/:sub_number_order_id",
            "params": [
              {
                "name": "sub_number_order_id",
                "value": "",
                "type": "path",
                "description": "The sub number order ID."
              },
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "Consolidated filter parameter (deepObject style). Originally: filter[include_phone_numbers]"
              }
            ]
          },
          "docs": "Get an existing sub number order."
        },
        {
          "info": {
            "name": "Update a sub number order's requirements",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.telnyx.com/v2/sub_number_orders/:sub_number_order_id",
            "params": [
              {
                "name": "sub_number_order_id",
                "value": "",
                "type": "path",
                "description": "The sub number order ID."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates a sub number order."
        },
        {
          "info": {
            "name": "Cancel a sub number order",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.telnyx.com/v2/sub_number_orders/:sub_number_order_id/cancel",
            "params": [
              {
                "name": "sub_number_order_id",
                "value": "",
                "type": "path",
                "description": "The ID of the sub number order."
              }
            ]
          },
          "docs": "Allows you to cancel a sub number order in 'pending' status."
        },
        {
          "info": {
            "name": "Create a sub number orders report",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telnyx.com/v2/sub_number_orders_report",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a CSV report for sub number orders. The report will be generated asynchronously and can be downloaded once complete."
        },
        {
          "info": {
            "name": "Retrieve a sub number orders report",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/sub_number_orders_report/:report_id",
            "params": [
              {
                "name": "report_id",
                "value": "12ade33a-21c0-473b-b055-b3c836e1c293",
                "type": "path",
                "description": "The unique identifier of the sub number orders report"
              }
            ]
          },
          "docs": "Get the status and details of a sub number orders report."
        },
        {
          "info": {
            "name": "Download a sub number orders report",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/sub_number_orders_report/:report_id/download",
            "params": [
              {
                "name": "report_id",
                "value": "12ade33a-21c0-473b-b055-b3c836e1c293",
                "type": "path",
                "description": "The unique identifier of the sub number orders report"
              }
            ]
          },
          "docs": "Download the CSV file for a completed sub number orders report. The report status must be 'success' before the file can be downloaded."
        }
      ]
    }
  ],
  "bundled": true
}