nexmo_api_specification 0.1.5 → 0.2.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (4) hide show
  1. checksums.yaml +4 -4
  2. data/lib/nexmo_api_specification/version.rb +1 -1
  3. data/sms.yml +110 -106
  4. metadata +2 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: e2f2e40b3942179e5143cb15d38357e8ee448063
4
- data.tar.gz: 351937bd360bcd43ea01110e819c243bca73dacb
3
+ metadata.gz: f944ad7a9d6c8b1f23a2ef2bb9e6f98780fdfa47
4
+ data.tar.gz: 71bff88302943b8e45d8ddb2b41b1ca1a1120abb
5
5
  SHA512:
6
- metadata.gz: f78756e0f5f33312dcce9e611b755a4b5f17d13654f7df62bd2f2df966ab19108c2d7b58b8f4e07fe4ebae9d736e95442fc0de5522a234538e2392c1ffb388a0
7
- data.tar.gz: 0f58340096aa44de472dcfa20dbb53471140c0d40e3c42b01237797f9342e86f352ef47f83fb59ddda31d0875bec00a2fb549389c60c96f7ef1f3bab5f2a95ca
6
+ metadata.gz: '0497fdf70ba9cefad08034b5b1a3fe40e1e66b0325ef98fd7b79cd915303ae792877f75ea2c11771d6281a7d63ad9cbfe8cc8a2022ac635f999daddbde9c6380'
7
+ data.tar.gz: 8f6320ae09e298073181d6a1c30f45e37d005490a553db58bb42ab49b2ddcdda834bc15f644b335fafbedb0d6cfc5cf076f1498d378f9ce5603fc520ecd34d6e
data/lib/nexmo_api_specification/version.rb CHANGED
@@ -1,3 +1,3 @@
1
1
  module NexmoApiSpecification
2
- VERSION = '0.1.5'.freeze
2
+ VERSION = '0.2.0'.freeze
3
3
  end
data/sms.yml CHANGED
@@ -1,13 +1,12 @@
1
- openapi: 3.0.0
2
- servers:
3
- - url: 'https://rest.nexmo.com'
1
+ openapi: "3.0.0"
4
2
  info:
3
+ version: 1.0.0
5
4
  title: SMS API
6
- version: v1.0.0
7
- description:
8
- With the Nexmo SMS API you can send SMS from your account and lookup messages both messages that you've sent as well as messages sent to your virtual numbers.
5
+ description: With the Nexmo SMS API you can send SMS from your account and lookup messages both messages that you've sent as well as messages sent to your virtual numbers.
6
+ servers:
7
+ - url: https://rest.nexmo.com
9
8
  paths:
10
- '/sms/{format}':
9
+ /sms/{format}:
11
10
  post:
12
11
  x-group: sms
13
12
  summary: Send an SMS
@@ -16,14 +15,15 @@ paths:
16
15
  parameters:
17
16
  - name: format
18
17
  description: The format of the response
19
- required: true
20
18
  in: path
21
- example: json
22
- type: string
23
- enum:
24
- - json
25
- - xml
26
- default: json
19
+ required: true
20
+ schema:
21
+ example: json
22
+ type: string
23
+ enum:
24
+ - json
25
+ - xml
26
+ default: json
27
27
  - name: api_key
28
28
  description: Your API key
29
29
  required: true
@@ -50,105 +50,109 @@ paths:
50
50
  type: string
51
51
  minLength: 16
52
52
  maxLength: 16
53
+ requestBody:
54
+ required: true
55
+ content:
56
+ application/x-www-form-urlencoded:
57
+ schema:
58
+ $ref: '#/components/schemas/NewMessage'
53
59
  responses:
54
60
  '200':
55
61
  description: Success
56
62
  content:
57
- '*/*':
63
+ application/json:
58
64
  schema:
59
- $ref: '#/components/schemas/SMS'
60
- requestBody:
61
- content:
62
- application/x-www-form-urlencoded:
63
- schema:
64
- type: object
65
- properties:
66
- from:
67
- description: The name or number the message should be sent from. Alphanumeric senderID's are not supported in all countries, see [Global Messaging](/messaging/sms/guides/global-messaging#country-specific-features) for more details.
68
- type: string
69
- example: 'Acme Inc'
70
- required: true
71
- to:
72
- description: The number that the message should be sent to
73
- type: string
74
- minLength: 11
75
- maxLength: 12
76
- pattern: '\d{11,12}'
77
- example: 447700900000
78
- required: true
79
- text:
80
- description: The body of the message being sent
81
- type: string
82
- example: Hello World!
83
- ttl:
84
- description: '**Advanced**: The duration in milliseconds the delivery of an SMS will be attempted.§§ By default Nexmo attempt delivery for 72 hours, however the maximum effective value depends on the operator and is typically 24 - 48 hours. We recommend this value should be kept at its default or at least 30 minutes.'
85
- type: integer
86
- example: 900000
87
- default: 259200000
88
- minimum: 20000
89
- maximum: 604800000
90
- status-report-req:
91
- description: '**Advanced**: Boolean indicating if you like to receive a [Delivery Receipt](/messaging/sms/building-blocks/receive-a-delivery-receipt).'
92
- type: boolean
93
- example: 'false'
94
- default: 'true'
95
- callback:
96
- description: '**Advanced**: The webhook endpoint the delivery receipt for this sms is sent to. This parameter overrides the webhook endpoint you set in Dashboard.'
97
- type: string
98
- example: 'https://example.com/sms-dlr'
99
- message-class:
100
- description: '**Advanced**: The Data Coding Scheme value of the message'
101
- type: integer
102
- enum:
103
- - 0
104
- - 1
105
- - 2
106
- - 3
107
- type:
108
- description: '**Advanced**: The format of the message body'
109
- type: string
110
- enum:
111
- - text
112
- - binary
113
- - wappush
114
- - unicode
115
- - vcal
116
- - vard
117
- example: text
118
- default: text
119
- vcard:
120
- description: '**Advanced**: A business card in [vCard format](https://en.wikipedia.org/wiki/VCard). Depends on `type` parameter having the value `vcard`.'
121
- type: vcard
122
- vcal:
123
- description: '**Advanced**: A calendar event in [vCal format](https://en.wikipedia.org/wiki/VCal). Depends on `type` parameter having the value `vcal`.'
124
- type: vcal
125
- body:
126
- description: '**Advanced**: Hex encoded binary data. Depends on `type` parameter having the value `binary`.'
127
- type: string
128
- example: 0011223344556677
129
- udh:
130
- description: '**Advanced**: Your custom Hex encoded [User Data Header](https://en.wikipedia.org/wiki/User_Data_Header). Depends on `type` parameter having the value `binary`.'
131
- type: string
132
- example: 06050415811581
133
- protocol-id:
134
- description: '**Advanced**: The value of the [protocol identifier](https://en.wikipedia.org/wiki/GSM_03.40#Protocol_Identifier) to use. Ensure that the value is aligned with `udh`.'
135
- type: integer
136
- example: 127
137
- title:
138
- description: '**Advanced**: The title for a wappush SMS. Depends on `type` parameter having the value `wappush`.'
139
- type: string
140
- example: Welcome
141
- url:
142
- description: '**Advanced**: The URL of your website. Depends on `type` parameter having the value `wappush`.'
143
- type: string
144
- example: https://example.com
145
- validity:
146
- description: '**Advanced**: The availability for an SMS in milliseconds. Depends on `type` parameter having the value `wappush`.'
147
- type: string
148
- example: https://example.com
149
-
65
+ $ref: '#/components/schemas/Message'
150
66
  components:
151
67
  schemas:
68
+ NewMessage:
69
+ required:
70
+ - from
71
+ - to
72
+ properties:
73
+ from:
74
+ description: The name or number the message should be sent from. Alphanumeric senderID's are not supported in all countries, see [Global Messaging](/messaging/sms/guides/global-messaging#country-specific-features) for more details.
75
+ type: string
76
+ example: 'Acme Inc'
77
+ to:
78
+ description: The number that the message should be sent to
79
+ type: string
80
+ minLength: 11
81
+ maxLength: 12
82
+ pattern: '\d{11,12}'
83
+ example: 447700900000
84
+ text:
85
+ description: The body of the message being sent
86
+ type: string
87
+ example: Hello World!
88
+ ttl:
89
+ description: '**Advanced**: The duration in milliseconds the delivery of an SMS will be attempted.§§ By default Nexmo attempt delivery for 72 hours, however the maximum effective value depends on the operator and is typically 24 - 48 hours. We recommend this value should be kept at its default or at least 30 minutes.'
90
+ type: integer
91
+ example: 900000
92
+ default: 259200000
93
+ minimum: 20000
94
+ maximum: 604800000
95
+ status-report-req:
96
+ description: '**Advanced**: Boolean indicating if you like to receive a [Delivery Receipt](/messaging/sms/building-blocks/receive-a-delivery-receipt).'
97
+ type: boolean
98
+ example: 'false'
99
+ default: 'true'
100
+ callback:
101
+ description: '**Advanced**: The webhook endpoint the delivery receipt for this sms is sent to. This parameter overrides the webhook endpoint you set in Dashboard.'
102
+ type: string
103
+ example: 'https://example.com/sms-dlr'
104
+ message-class:
105
+ description: '**Advanced**: The Data Coding Scheme value of the message'
106
+ type: integer
107
+ enum:
108
+ - 0
109
+ - 1
110
+ - 2
111
+ - 3
112
+ type:
113
+ description: '**Advanced**: The format of the message body'
114
+ type: string
115
+ enum:
116
+ - text
117
+ - binary
118
+ - wappush
119
+ - unicode
120
+ - vcal
121
+ - vard
122
+ example: text
123
+ default: text
124
+ vcard:
125
+ description: '**Advanced**: A business card in [vCard format](https://en.wikipedia.org/wiki/VCard). Depends on `type` parameter having the value `vcard`.'
126
+ type: string
127
+ format: vcard
128
+ vcal:
129
+ description: '**Advanced**: A calendar event in [vCal format](https://en.wikipedia.org/wiki/VCal). Depends on `type` parameter having the value `vcal`.'
130
+ type: string
131
+ format: vcal
132
+ body:
133
+ description: '**Advanced**: Hex encoded binary data. Depends on `type` parameter having the value `binary`.'
134
+ type: string
135
+ example: 0011223344556677
136
+ udh:
137
+ description: '**Advanced**: Your custom Hex encoded [User Data Header](https://en.wikipedia.org/wiki/User_Data_Header). Depends on `type` parameter having the value `binary`.'
138
+ type: string
139
+ example: 06050415811581
140
+ protocol-id:
141
+ description: '**Advanced**: The value of the [protocol identifier](https://en.wikipedia.org/wiki/GSM_03.40#Protocol_Identifier) to use. Ensure that the value is aligned with `udh`.'
142
+ type: integer
143
+ example: 127
144
+ title:
145
+ description: '**Advanced**: The title for a wappush SMS. Depends on `type` parameter having the value `wappush`.'
146
+ type: string
147
+ example: Welcome
148
+ url:
149
+ description: '**Advanced**: The URL of your website. Depends on `type` parameter having the value `wappush`.'
150
+ type: string
151
+ example: https://example.com
152
+ validity:
153
+ description: '**Advanced**: The availability for an SMS in milliseconds. Depends on `type` parameter having the value `wappush`.'
154
+ type: string
155
+ example: https://example.com
152
156
  Error:
153
157
  type: object
154
158
  properties:
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: nexmo_api_specification
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.5
4
+ version: 0.2.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Adam Butler
8
8
  autorequire:
9
9
  bindir: exe
10
10
  cert_chain: []
11
- date: 2017-11-07 00:00:00.000000000 Z
11
+ date: 2017-11-16 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: bundler