nexmo_api_specification 0.11.4 → 0.11.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b5c8c40ce265d614d8a602e3cf2652dddb5c3fbb
-  data.tar.gz: e2545074caadbf429c03c1c319b656a7967c587a
+  metadata.gz: 59797b79fc2bdf352abb7962f716b3db01d06111
+  data.tar.gz: 77b69d6178834b5ae12910073fa81542f088b352
 SHA512:
-  metadata.gz: 01c84df8c3f285993f87ae39816bf4879c69f7506b686a7807beb39c6d0ff1b871264f5faac25b9d3d6f4660be46df0582065afbd824aa39853503aad6fde986
-  data.tar.gz: 55e0bab7af7b6136b79bae403c592c2e6356928f6b80c47e742eed1e1dae4650b8d18fc4f81f71d3aba08ecbf97b14802d9cec9f4f6fc470f3214c1afb33fe7f
+  metadata.gz: 8a463096efb183165f0b44d8192a2ace7f7abb6c12669bd961bec3f49458a477eed21a1b8393fa3a0595264809be732408b752dfbbf7280528ac90ee4304953f
+  data.tar.gz: 2a318919dd2eb3f355cff0381d2459a4f6079399f3d70297b60d51f98e3ebdee3b0af4c147b9b6998999d83a684fe61856a2e9eb0a5dbffc9cf00be06e35fe97

data/definitions/sms.yml

@@ -124,7 +124,7 @@ components:
           pattern: '\d{7,15}'
           example: 447700900000
         text:
-          description: The body of the message being sent
+          description: The body of the message being sent. If your message contains characters that can be encoded according to the GSM Standard and Extended tables then you can set the `type` to `text`. If your message contains characters outside this range, then you will need to set the `type` to `unicode`.
           type: string
           example: Hello World!
         ttl:

data/definitions/stitch.yml

@@ -12,35 +12,7 @@ info:
     email: ea-support@nexmo.com
   x-label: Developer Preview
 paths:
-  /legs:
-    get:
-      x-swagger-router-controller: listLegs
-      operationId: listLegs
-      x-group: leg
-      summary: List legs
-      responses:
-        '200':
-          $ref: '#/components/responses/LegsListed'
-        '400':
-          $ref: '#/components/responses/ValidationError'
-  '/legs/{leg_id}':
-    parameters:
-      - name: leg_id
-        in: path
-        required: true
-        description: Leg ID
-        schema:
-          type: string
-    delete:
-      x-swagger-router-controller: deleteLeg
-      operationId: deleteLeg
-      x-group: leg
-      summary: Delete a leg
-      responses:
-        '200':
-          $ref: '#/components/responses/Success'
-        '400':
-          $ref: '#/components/responses/ClientError'
+
   /conversations:
     post:
       x-swagger-router-controller: createConversation
@@ -67,11 +39,7 @@ paths:
           $ref: '#/components/responses/ConversationsListed'
         '400':
           $ref: '#/components/responses/ValidationError'
-      requestBody:
-        content:
-          application/json:
-            schema:
-              $ref: '#/components/schemas/ListConversations'
+
   '/conversations/{conv_id}':
     parameters:
       - name: conv_id
@@ -150,11 +118,7 @@ paths:
           $ref: '#/components/responses/ClientError'
         '404':
           $ref: '#/components/responses/NotFound'
-      requestBody:
-        content:
-          application/json:
-            schema:
-              $ref: '#/components/schemas/GetEventsObject'
+
   '/conversations/{conv_id}/events/{event_id}':
     parameters:
       - name: conv_id
@@ -193,11 +157,7 @@ paths:
           $ref: '#/components/responses/ClientError'
         '404':
           $ref: '#/components/responses/NotFound'
-      requestBody:
-        content:
-          application/json:
-            schema:
-              $ref: '#/components/schemas/deleteEventRequestPayload'
+
   '/conversations/{conv_id}/members':
     parameters:
       - name: conv_id
@@ -359,6 +319,36 @@ paths:
       responses:
         '200':
           $ref: '#/components/responses/FoundList'
+
+  /legs:
+    get:
+      x-swagger-router-controller: listLegs
+      operationId: listLegs
+      x-group: leg
+      summary: List legs
+      responses:
+        '200':
+          $ref: '#/components/responses/LegsListed'
+        '400':
+          $ref: '#/components/responses/ValidationError'
+  '/legs/{leg_id}':
+    parameters:
+      - name: leg_id
+        in: path
+        required: true
+        description: Leg ID
+        schema:
+          type: string
+    delete:
+      x-swagger-router-controller: deleteLeg
+      operationId: deleteLeg
+      x-group: leg
+      summary: Delete a leg
+      responses:
+        '200':
+          $ref: '#/components/responses/Success'
+        '400':
+          $ref: '#/components/responses/ClientError'
 components:
   responses:
     LegsListed:
@@ -642,11 +632,14 @@ components:
       properties:
         name:
           type: string
+          example: 'nexmo-conference-standard'
+          default: '63f61863-4a51-4f6b-86e1-46edebio0391'
           description: >-
             Unique name (within the same application) for the conversation. If
             not provided, one will be automatically generated.
         display_name:
           type: string
+          example: 'My-Conversation'
           description: The display name of the conversation
 
       required:
@@ -660,6 +653,7 @@ components:
       properties:
         id:
           type: string
+          example: '63f61863-4a51-4f6b-86e1-46edebio0391'
           description: Conversation ID
         href:
           type: string
@@ -674,12 +668,16 @@ components:
       description: Replace Conversation Request Payload Object
       properties:
         name:
+          example: 'nexmo-conference-standard'
+          default: '63f61863-4a51-4f6b-86e1-46edebio0391'
           type: string
           description: >-
             Unique name (within the same application) for the conversation. If
             not provided, one will be automatically generated.
         display_name:
           type: string
+          example: 'My-Conversation'
+          description: The display name of the conversation
 
     Conversation:
       discriminator:
@@ -689,18 +687,23 @@ components:
       properties:
         uuid:
           type: string
+          example: '63f61863-4a51-4f6b-86e1-46edebio0391'
           description: Conversation ID
         name:
+          example: 'nexmo-conference-standard'
           type: string
           description: Conversation Name
         display_name:
+          example: 'My-Conversation'
           type: string
           description: The display name of the conversation
         timestamp:
           type: string
+          example: '2020-01-01T14:00:00.00Z'
           description: time when conversation was created
         sequence_number:
           type: string
+          example: '1'
           description: the last event id
 
         members:
@@ -736,13 +739,16 @@ components:
       type: object
       properties:
         name:
+          example: 'nexmo-conference-standard'
           type: string
           description: Unique name (within the same application) for the conversation.
         date_start:
+          example: '2020-01-01 12:00:00'
           type: string
           format: dateTime
           description: Return the records that occurred after this point in time.
         date_end:
+          example: '2020-01-01 12:00:00'
           type: string
           format: dateTime
           description: Return the records that occurred at this point in time.
@@ -755,7 +761,7 @@ components:
           minimum: 0
         order:
           type: string
-          description: Return the records that in ascending or descending order. 
+          description: 'Return the records that in ascending or descending order.'
           enum:
             - asc
             - desc
@@ -765,21 +771,23 @@ components:
       discriminator:
         propertyName: ConversationsListed
       type: object
-      description: List Conversations Response Payload Object.
+      description: 'List Conversations Response Payload Object.'
       properties:
         count:
           type: number
-          description: The total number of records returned by your request.
+          example: '100'
+          description: 'The total number of records returned by your request.'
         page_size:
           type: number
-          description: The amount of records returned in this response.
+          example: '20'
+          description: 'The amount of records returned in this response.'
 
         record_index:
           type: number
-          description: Return page_size calls from this index in the response. That is, if your request returns 300 concersations, set record_index to 5 in order to return calls 50 to 59. The default value is 0. That is, the first page_size calls.
+          description: 'Return page_size calls from this index in the response. That is, if your request returns 300 concersations, set record_index to 5 in order to return calls 50 to 59. The default value is 0. That is, the first page_size calls.'
         _links:
           type: object
-          description: A series of links between resources in this API in the http://stateless.co/hal_specification.html.
+          description: 'A series of links between resources in this API in the http://stateless.co/hal_specification.html.'
           properties:
             self:
               type: object
@@ -866,11 +874,12 @@ components:
         - record_index
         - _links
         - _embedded
+
     CreateDeviceObject:
       discriminator:
         propertyName: CreateDeviceObject
       type: object
-      description: Create New Device Request Payload Object
+      description: 'Create New Device Request Payload Object'
       properties:
         device_token:
           type: string
@@ -885,7 +894,7 @@ components:
       discriminator:
         propertyName: DeviceCreated
       type: object
-      description: Create New Device Response Payload Object
+      description: 'Create New Device Response Payload Object'
       properties:
         id:
           type: string
@@ -896,7 +905,7 @@ components:
       discriminator:
         propertyName: CreateEvent
       type: object
-      description: Create New Event Request Payload Object
+      description: 'Create New Event Request Payload Object'
       properties:
         type:
           type: string
@@ -914,21 +923,21 @@ components:
       discriminator:
         propertyName: EventCreated
       type: object
-      description: Create New Event Response Payload Object
+      description: 'Create New Event Response Payload Object'
       properties:
         id:
           type: string
           description: Event ID
         timestamp:
           type: string
-          description: time when event was created
+          description: 'time when event was created'
         href:
           type: string
     EventRetrieved:
       discriminator:
         propertyName: EventRetrieved
       type: object
-      description: Retrieve Event Response Payload Object
+      description: 'Retrieve Event Response Payload Object'
       properties:
         id:
           type: string
@@ -958,7 +967,7 @@ components:
       discriminator:
         propertyName: GetEventsObject
       type: object
-      description: Get Events Request Payload Object
+      description: 'Get Events Request Payload Object'
       properties:
         start_id:
           type: string
@@ -1400,15 +1409,15 @@ components:
         - $ref: '#/components/schemas/UserDetails'
 x-groups:
   conversation:
-    name: "Conversation"
+    name: 'Conversation'
     order: 1
     description: >-
       A conversation is a shared core component that Nexmo APIs rely on. Conversations happen over multiple mediums and and can have associated Users through Memberships.
     schema:
       application/json:
-        $ref: '#/components/schemas/ConversationUpdated'
+        $ref: '#/components/schemas/Conversation'
   user:
-    name: "User"
+    name: 'User'
     order: 2
     description: >-
       The concept of a user exists in Nexmo APIs, you can associate one with a user in your own application if you choose. A user can have multiple memberships to conversations and can communicate with other users through various different mediums.
@@ -1416,7 +1425,7 @@ x-groups:
       application/json:
         $ref: '#/components/schemas/GenericResource'
   member:
-    name: "Member"
+    name: 'Member'
     order: 3
     description: >-
       Memberships connect users with conversations. Each membership has one conversation and one user however a user can have many memberships to conversations just as conversations can have many members.
@@ -1424,7 +1433,7 @@ x-groups:
       application/json:
         $ref: '#/components/schemas/MemberCreated'
   session:
-    name: "Session"
+    name: 'Session'
     order: 3
     description: >-
       Coming soon
@@ -1432,7 +1441,7 @@ x-groups:
       application/json:
         $ref: '#/components/schemas/SessionCreated'
   event:
-    name: "Event"
+    name: 'Event'
     order: 4
     description: >-
       Coming soon
@@ -1440,10 +1449,10 @@ x-groups:
       application/json:
         $ref: '#/components/schemas/EventCreated'
   leg:
-    name: "Leg"
-    order: 4
-    description: >-
-      A leg can be a video call, IP call, or PSTN call that users participate in using multiple platforms. With this endpoint you can retrieve the details about all of the legs that took place in your application.
-    schema:
-      application/json:
-        $ref: '#/components/schemas/Leg'
+   name: "Leg"
+   order: 4
+   description: >-
+     A leg can be a video call, IP call, or PSTN call that users participate in using multiple platforms. With this endpoint you can retrieve the details about all of the legs that took place in your application.
+   schema:
+     application/json:
+       $ref: '#/components/schemas/Leg'

data/lib/nexmo_api_specification/version.rb

@@ -1,3 +1,3 @@
 module NexmoApiSpecification
-  VERSION = '0.11.4'.freeze
+  VERSION = '0.11.5'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nexmo_api_specification
 version: !ruby/object:Gem::Version
-  version: 0.11.4
+  version: 0.11.5
 platform: ruby
 authors:
 - Adam Butler
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-04 00:00:00.000000000 Z
+date: 2018-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler