Skip to content

Commit a0fefe9

Browse files
authored
Merge branch 'main' into Devon/Call-Flow-resource
2 parents 4016574 + 4f1fba8 commit a0fefe9

File tree

465 files changed

+20395
-17588
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

465 files changed

+20395
-17588
lines changed

.cursor/rules/docs.mdc

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ description: "Brief page description" # for SEO
6161
- **Titles**: Avoid gerunds in titles when practical ('Install package' rather than 'Installing the package')
6262
- **Sentence case**: Apply sentence case to card titles, tab titles, and pseudo-headers
6363
- **Pseudo-headers**: Titles made with simple bolded text (either on their own line or in lists with colons) should use sentence case
64-
- **Semantic line breaks**: Follow the SemBr specification by putting line breaks
64+
- **Semantic line breaks**: Follow the SemBr specification by putting line breaks before and after major clauses. Links should occupy their own complete line.
6565

6666
### Header formatting
6767
- Use sentence case for all headers (capitalize only the first word and proper nouns)
@@ -159,6 +159,15 @@ export const products = [
159159
- Provide alt text for custom images
160160
- Ensure proper focus management for interactive elements
161161

162+
## Development and build commands
163+
164+
### Package manager
165+
**This project uses Yarn, not npm.** Always use `yarn` for all package management commands.
166+
- Build: `yarn --cwd website build`
167+
- Develop: `yarn --cwd website start` (for local preview)
168+
- Install: `yarn install`
169+
- Do NOT use: `npm install`, `npm run`, `npx` - use `yarn` equivalents instead
170+
162171
## Quality assurance
163172

164173
### Content review checklist

.github/PULL_REQUEST_TEMPLATE/other.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Why is this change required? What problem does it solve?
3838

3939
## Checklist:
4040

41-
- [ ] My changes follow the [style guidelines](https://github.com/signalwire/signalwire-docs/wiki/Style-Guidelines) of this project
41+
- [ ] My changes follow the [style guidelines](https://github.com/signalwire/docs/wiki/Written-Style-Guide) of this project
4242
- [ ] I have performed a self-review of my changes
4343
- [ ] My changes generate no new warnings
4444
- [ ] Builds successfully locally

.github/PULL_REQUEST_TEMPLATE/rest_api_update.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ Why is this change required? What problem does it solve?
1919

2020
## Checklist:
2121

22-
- [ ] I have read and fully understand the [process for updating the REST API](https://github.com/signalwire/signalwire-docs/wiki/REST-API-Specs-&-Docs)
23-
- [ ] [Mandatory fields](https://github.com/signalwire/signalwire-docs/wiki/REST-API-Specs-&-Docs#documentation-required-decorators) are present in the TypeSpec files.
22+
- [ ] I have read and fully understand the [process for updating the REST API](https://github.com/signalwire/docs/wiki/REST-API-Specs-&-Docs)
23+
- [ ] [Mandatory fields](https://github.com/signalwire/docs/wiki/REST-API-Specs-&-Docs#documentation-required-decorators) are present in the TypeSpec files.
2424
- [ ] TypeSpec files successfully compiled OpenAPI spec files.
2525
- [ ] No new warnings were generated during the compilation process.
2626
- [ ] OpenAPI spec files were validated with a SWAGGER UI tool to ensure they are correct.

.github/PULL_REQUEST_TEMPLATE/updating_docs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Why is this change required? What problem does it solve?
2323

2424
## Checklist:
2525

26-
- [ ] My documentation follows the [style guidelines](https://github.com/signalwire/signalwire-docs/wiki/Style-Guidelines) of this project
26+
- [ ] My documentation follows the [style guidelines](https://github.com/signalwire/docs/wiki/Written-Style-Guide) of this project
2727
- [ ] I have performed a self-review of my documentation
2828
- [ ] My changes generate no new warnings
2929
- [ ] Builds successfully locally

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ specs/tsp-output
2323
.cursorignore
2424
temp
2525
.env
26+
.vscode
2627

2728
npm-debug.log*
2829
yarn-debug.log*

Dockerfile

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ COPY website ./website
1919
COPY specs ./specs
2020
COPY tools ./tools
2121

22-
# Install dependencies and run postinstall (builds specs and website)
22+
# Install dependencies and run postinstall (builds specs)
2323
RUN yarn install --frozen-lockfile
2424

2525
# Build the website
@@ -34,4 +34,7 @@ COPY --from=builder /app/website/provisioning/nginx/nginx.conf /etc/nginx/nginx.
3434
COPY --from=builder /app/website/provisioning/nginx/redirects.map /etc/nginx/redirects.map
3535
COPY --from=builder /app/website/build/ /usr/share/nginx/html
3636

37+
# Test nginx configuration
38+
RUN nginx -t
39+
3740
EXPOSE 80

specs/compatibility-api/_spec_.yaml

Lines changed: 298 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6559,6 +6559,304 @@ paths:
65596559
responses:
65606560
'204':
65616561
$ref: '#/components/responses/204'
6562+
/Accounts/{AccountSid}/ImportedPhoneNumbers:
6563+
post:
6564+
parameters:
6565+
- name: AccountSid
6566+
in: path
6567+
description: >-
6568+
The unique identifier for the account that is associated with this
6569+
phone number.
6570+
required: true
6571+
schema:
6572+
type: string
6573+
format: uuid
6574+
operationId: create_imported_phone_number
6575+
summary: Import a Phone Number
6576+
description: >
6577+
Import a phone number hosted elsewhere into your SignalWire Space.
6578+
6579+
**Note:** This is a **Partner API**. To enable it on your SignalWire Space, contact
6580+
[Sales](https://signalwire.com/company/contact?utm_campaign=devex_sent_em).
6581+
6582+
#### Permissions
6583+
6584+
The API token must include the following scopes: _Numbers_.
6585+
tags:
6586+
- Imported Phone Numbers
6587+
requestBody:
6588+
content:
6589+
application/x-www-form-urlencoded:
6590+
schema:
6591+
type: object
6592+
required:
6593+
- number
6594+
- number_type
6595+
properties:
6596+
number:
6597+
type: string
6598+
description: >-
6599+
The phone number to import in E.164 format. Number must be
6600+
between 5 and 30 characters with no special characters
6601+
besides a leading `+`.
6602+
example: '+49152234333323'
6603+
minLength: 5
6604+
maxLength: 30
6605+
number_type:
6606+
type: string
6607+
description: The type of phone number being imported.
6608+
enum:
6609+
- longcode
6610+
- tollfree
6611+
example: longcode
6612+
capabilities:
6613+
type: array
6614+
description: >-
6615+
The capabilities to enable for this phone number. Can
6616+
include any combination of SMS, Voice, Fax, and MMS. If not
6617+
provided, defaults to all capabilities (SMS, Voice, Fax,
6618+
and MMS). Cannot be an empty array.
6619+
items:
6620+
type: string
6621+
enum:
6622+
- sms
6623+
- voice
6624+
- fax
6625+
- mms
6626+
example: ['sms', 'fax']
6627+
responses:
6628+
'201':
6629+
description: Created
6630+
content:
6631+
application/json:
6632+
schema:
6633+
type: object
6634+
properties:
6635+
sid:
6636+
type: string
6637+
description: The unique identifier for this phone number.
6638+
example: b3877c40-da60-4998-90ad-b792e98472pn
6639+
account_id:
6640+
type: string
6641+
format: uuid
6642+
description: >-
6643+
The unique identifier for the account that is associated
6644+
with this phone number.
6645+
example: b3877c40-da60-4998-90ad-b792e98472ac
6646+
account_sid:
6647+
type: string
6648+
format: uuid
6649+
description: >-
6650+
The unique identifier for the account that is associated
6651+
with this phone number.
6652+
example: b3877c40-da60-4998-90ad-b792e98472ac
6653+
friendly_name:
6654+
type: string
6655+
nullable: true
6656+
description: A formatted version of the number.
6657+
example: null
6658+
phone_number:
6659+
type: string
6660+
description: The phone number in E.164 format.
6661+
example: '+49152234333323'
6662+
voice_url:
6663+
type: string
6664+
nullable: true
6665+
description: The URL to request when an incoming call is received.
6666+
example: null
6667+
voice_method:
6668+
type: string
6669+
nullable: true
6670+
description: >-
6671+
Whether the request to voice_url is a GET or a POST.
6672+
example: null
6673+
voice_fallback_url:
6674+
type: string
6675+
nullable: true
6676+
description: The URL to request if errors occur when fetching voice_url.
6677+
example: null
6678+
voice_fallback_method:
6679+
type: string
6680+
nullable: true
6681+
description: >-
6682+
Whether the request to voice_fallback_url is a GET or a POST.
6683+
example: null
6684+
status_callback:
6685+
type: string
6686+
nullable: true
6687+
description: The URL to request to pass status updates to.
6688+
example: null
6689+
status_callback_method:
6690+
type: string
6691+
nullable: true
6692+
description: >-
6693+
Whether the request to status_callback is a GET or a POST.
6694+
example: null
6695+
voice_application_sid:
6696+
type: string
6697+
nullable: true
6698+
description: >-
6699+
The unique identifier for the application associated with
6700+
call handling on this phone number.
6701+
example: null
6702+
voice_caller_id_lookup:
6703+
type: boolean
6704+
nullable: true
6705+
description: Whether or not to look up a caller's name in the database.
6706+
example: null
6707+
sms_url:
6708+
type: string
6709+
nullable: true
6710+
description: The URL to request when an incoming SMS is received.
6711+
example: null
6712+
sms_method:
6713+
type: string
6714+
nullable: true
6715+
description: >-
6716+
Whether the request to sms_url is a GET or a POST.
6717+
example: null
6718+
sms_fallback_url:
6719+
type: string
6720+
nullable: true
6721+
description: The URL to request if errors occur when fetching sms_url.
6722+
example: null
6723+
sms_fallback_method:
6724+
type: string
6725+
nullable: true
6726+
description: >-
6727+
Whether the request to sms_fallback_url is a GET or a POST.
6728+
example: null
6729+
sms_application_sid:
6730+
type: string
6731+
nullable: true
6732+
description: >-
6733+
The unique identifier for the application associated with
6734+
SMS handling on this phone number.
6735+
example: null
6736+
date_created:
6737+
type: string
6738+
description: >-
6739+
The date, in RFC 2822 format, this phone number was
6740+
created.
6741+
example: 'Thu, 28 Sep 2023 17:58:29 +0000'
6742+
date_updated:
6743+
type: string
6744+
description: >-
6745+
The date, in RFC 2822 format, this phone number was
6746+
updated.
6747+
example: 'Thu, 28 Sep 2023 17:58:29 +0000'
6748+
capabilities:
6749+
type: object
6750+
description: Whether or not a number can receive calls and messages.
6751+
properties:
6752+
voice:
6753+
type: boolean
6754+
example: false
6755+
sms:
6756+
type: boolean
6757+
example: true
6758+
mms:
6759+
type: boolean
6760+
example: false
6761+
fax:
6762+
type: boolean
6763+
example: true
6764+
beta:
6765+
type: boolean
6766+
description: New numbers on SignalWire are marked as beta.
6767+
example: false
6768+
api_version:
6769+
type: string
6770+
description: The version of the SignalWire API.
6771+
example: '2010-04-01'
6772+
uri:
6773+
type: string
6774+
description: The URI for this number.
6775+
example: >-
6776+
/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472ac/IncomingPhoneNumbers/16db4a36-8a97-4e10-98c5-58daafac95f9
6777+
address_requirements:
6778+
type: string
6779+
description: >-
6780+
Whether or not a registered address with SignalWire is
6781+
required.
6782+
enum:
6783+
- none
6784+
- any
6785+
- local
6786+
- foreign
6787+
example: none
6788+
address_sid:
6789+
type: string
6790+
nullable: true
6791+
description: >-
6792+
The unique identifier for the address associated with this
6793+
phone number.
6794+
example: null
6795+
identity_sid:
6796+
type: string
6797+
nullable: true
6798+
description: >-
6799+
The unique identifier for the identity associated with
6800+
this phone number.
6801+
example: null
6802+
trunk_sid:
6803+
type: string
6804+
nullable: true
6805+
description: >-
6806+
The unique identifier for the Trunk associated with this
6807+
phone number.
6808+
example: null
6809+
origin:
6810+
type: string
6811+
description: >-
6812+
The origin of the phone number. SignalWire numbers are
6813+
denoted as signalwire while hosted numbers are denoted
6814+
as hosted.
6815+
example: signalwire
6816+
emergency_address_sid:
6817+
type: string
6818+
nullable: true
6819+
description: >-
6820+
The unique identifier of the address associated with E911
6821+
for this phone number.
6822+
example: null
6823+
emergency_status:
6824+
type: string
6825+
description: >-
6826+
Whether the phone route has an active E911 address
6827+
associated.
6828+
enum:
6829+
- Active
6830+
- Inactive
6831+
example: Inactive
6832+
country_code:
6833+
type: string
6834+
nullable: true
6835+
description: The country code for this phone number.
6836+
example: null
6837+
'422':
6838+
description: Unprocessable Entity
6839+
content:
6840+
application/json:
6841+
schema:
6842+
type: object
6843+
properties:
6844+
code:
6845+
type: string
6846+
description: The error code.
6847+
example: '10000'
6848+
message:
6849+
type: string
6850+
description: A human-readable error message.
6851+
example: "Number type can't be blank"
6852+
more_info:
6853+
type: string
6854+
description: A URL to more information about the error.
6855+
example: 'https://developer.signalwire.com/compatibility-api/reference/error-codes'
6856+
status:
6857+
type: integer
6858+
description: The HTTP status code.
6859+
example: 400
65626860
/Accounts/{AccountSid}/LamlBins:
65636861
get:
65646862
parameters:
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
import "../../_globally_shared/const.tsp";

0 commit comments

Comments
 (0)