nexmo_api_specification 0.10.0 → 0.11.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nexmo_api_specification
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Adam Butler
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-20 00:00:00.000000000 Z
+date: 2018-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -65,15 +65,16 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- definitions/conversation.yml
 - definitions/number-insight.yml
 - definitions/sms.yml
+- definitions/stitch.yml
 - definitions/verify.yml
 - guidelines/GUIDELINES.md
 - guidelines/README.md
 - lib/nexmo_api_specification.rb
 - lib/nexmo_api_specification/definition.rb
 - lib/nexmo_api_specification/version.rb
+- ncco-schema.json
 - nexmo_api_specification.gemspec
 homepage: https://github.com/nexmo/api-specification
 licenses:

data/definitions/conversation.yml

@@ -1,370 +0,0 @@
-openapi: 3.0.0
-servers:
-  - url: 'https://api.nexmo.com/beta'
-info:
-  version: 1.0.0
-  title: Conversation API
-  description: >-
-    The Nexmo Conversation API enables you to build conversation features where communication can take place across multiple mediums including IP Messaging, PSTN Voice, SMS and WebRTC Audio and Video. The context of the conversations is maintained though each communication event taking place within a conversation, no matter the medium.
-security:
-  - bearerAuth: []
-paths:
-  /conversations:
-    post:
-      security:
-        - bearerAuth: []
-      x-group: conversation
-      summary: Create a conversation
-      parameters:
-        - name: name
-          in: query
-          description: Conversation name, must be unique but will auto-generated if you do not provide it.
-          required: false
-          schema:
-            type: string
-        - name: display_name
-          in: query
-          description: A personal name of your choosing.
-          required: false
-          schema:
-            type: string
-      responses:
-        '200':
-          description: conversations response
-          content:
-            application/json:
-              schema:
-                type: object
-                $ref: '#/components/schemas/Conversation'
-        '401':
-          $ref: '#/components/responses/UnauthorizedError'
-  /conversations/{id}:
-    get:
-      x-group: conversation
-      summary: Retrieve a conversation
-      parameters:
-        - name: id
-          in: path
-          description: ID of the conversation
-          required: true
-          schema:
-            type: string
-      responses:
-        '200':
-          description: conversations response
-          content:
-            application/json:
-              schema:
-                type: array
-                items:
-                  $ref: '#/components/schemas/ConversationFull'
-  /conversations/{id}/members:
-    get:
-      x-group: member
-      summary: Retrieve members of a conversation
-      parameters:
-        - name: id
-          in: path
-          description: ID of the conversation
-          required: true
-          schema:
-            type: string
-      responses:
-        '200':
-          description: members response
-          content:
-            application/json:
-              schema:
-                type: array
-                items:
-                  $ref: '#/components/schemas/Member'
-    post:
-      x-group: member
-      summary: Add a user to a conversation
-      parameters:
-        - name: id
-          in: path
-          description: tags to filter by
-          required: true
-          schema:
-            type: string
-      responses:
-        '200':
-          description: members response
-          content:
-            application/json:
-              schema:
-                type: object
-                $ref: '#/components/schemas/MemberFull'
-  /users:
-    get:
-      x-group: user
-      summary: Retrieve all users
-      responses:
-        '200':
-          description: users response
-          content:
-            application/json:
-              schema:
-                type: array
-                items:
-                  $ref: '#/components/schemas/UserFull'
-    post:
-      x-group: user
-      summary: Create a user
-      parameters:
-        - name: name
-          in: query
-          description: The users name
-          example: Dillon
-          required: false
-          schema:
-            type: string
-      responses:
-        '200':
-          description: users response
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/User'
-  /users/{id}:
-    get:
-      x-group: user
-      summary: Retrive a user
-      parameters:
-        - name: id
-          in: path
-          description: The users ID
-          required: true
-          schema:
-            type: string
-      responses:
-        '200':
-          description: user response
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/UserShow'
-components:
-  securitySchemes:
-    bearerAuth:
-      type: http
-      scheme: bearer
-      bearerFormat: JWT
-  responses:
-    UnauthorizedError:
-      description: Access token is missing or invalid
-      content:
-        application/json:
-          schema:
-            type: object
-            required:
-              - code
-              - description
-            properties:
-              code:
-                type: 'string'
-                example: 'system:error:invalid-token'
-              description:
-                type: string
-                example: 'the token was rejected'
-  schemas:
-    CreatedTimestamp:
-      properties:
-        created:
-          example: "2020-01-01T12:00:00.000Z"
-          type: string
-          description: The time the conversation was created
-    JoinedTimestamp:
-      properties:
-        joined:
-          example: "2020-01-01T12:00:00.000Z"
-          type: string
-    Link:
-      properties:
-        self:
-          type: object
-          allOf:
-            - $ref: '#/components/schemas/Self'
-    Self:
-      properties:
-        href:
-          example: "http://conversation.local/v1/conversations/CON-aaaaaaaa-bbbb-cccc-dddd-0123456789ab"
-          type: string
-    Embedded:
-      properties:
-        legs:
-          type: object
-          allOf:
-            - $ref: '#/components/schemas/Leg'
-    Leg:
-      properties:
-        _links:
-          type: array
-          example: []
-    Channel:
-      properties:
-        type:
-          type: string
-          example: app
-    MemberFull:
-      properties:
-        id:
-          example: "MEM-aaaaaaaa-bbbb-cccc-dddd-0123456789ab"
-          type: string
-        user_id:
-          example: "USR-aaaaaaaa-bbbb-cccc-dddd-0123456789ab"
-          type: string
-        state:
-          example: "JOINED"
-          type: string
-        timestamp:
-          type: object
-          allOf:
-            - $ref: '#/components/schemas/JoinedTimestamp'
-        channel:
-          type: object
-          allOf:
-            - $ref: '#/components/schemas/Channel'
-        href:
-          example: 'http://conversation.local/v1/conversations/CON-aaaaaaaa-bbbb-cccc-dddd-0123456789ab/MEM-aaaaaaaa-bbbb-cccc-dddd-0123456789ab'
-          type: string
-    Member:
-      properties:
-        user_id:
-          example: "USR-aaaaaaaa-bbbb-cccc-dddd-0123456789ab"
-          type: string
-        name:
-          example: "MEM-aaaaaaaa-bbbb-cccc-dddd-0123456789ab"
-          type: string
-        user_name:
-          example: "Dillon"
-          type: string
-        state:
-          example: "JOINED"
-          type: string
-    ConversationFull:
-      properties:
-        uuid:
-          example: "CON-aaaaaaaa-bbbb-cccc-dddd-0123456789ab"
-          type: string
-          description: >-
-            Unique identifier for the conversation
-        name:
-          example: "nexmo-chat"
-          type: string
-          description: >-
-            The name of the conversation
-        display_name:
-          example: "Nexmo Chat"
-          type: string
-          description: >-
-            The display name of the conversation
-        timestamp:
-          type: object
-          items:
-            $ref: '#/components/schemas/CreatedTimestamp'
-        sequence_number:
-          example: 0
-          type: integer
-        numbers:
-          example: {}
-          type: string
-        properties:
-          example: {}
-          type: string
-        members:
-          example: []
-          type: array
-        api_key:
-          example: "abcd1234"
-          type: string
-          description: The API Key of the owner of the conversation
-        _links:
-          example:
-          type: object
-          allOf:
-            - $ref: '#/components/schemas/Link'
-        _embedded:
-          type: object
-          allOf:
-            - $ref: '#/components/schemas/Embedded'
-    Conversation:
-      type: object
-      required:
-        - id
-        - href
-      properties:
-        id:
-          type: string
-          example: 'CON-aaaaaaaa-bbbb-cccc-dddd-0123456789ab'
-        href:
-          type: string
-          example: 'http://conversation.local/v1/conversations/CON-aaaaaaaa-bbbb-cccc-dddd-0123456789ab'
-    UserShow:
-      type: object
-      required:
-        - name
-        - id
-        - href
-      properties:
-        id:
-          type: string
-          example: 'USR-aaaaaaaa-bbbb-cccc-dddd-0123456789ab'
-        href:
-          type: string
-          example: 'http://conversation.local/v1/users/USR-aaaaaaaa-bbbb-cccc-dddd-0123456789ab'
-        name:
-          type: string
-          example: 'Dillon'
-        channels:
-          type: object
-          example: {}
-    User:
-      type: object
-      required:
-        - name
-        - id
-        - href
-      properties:
-        id:
-          type: string
-          example: 'USR-aaaaaaaa-bbbb-cccc-dddd-0123456789ab'
-        href:
-          type: string
-          example: 'http://conversation.local/v1/users/USR-aaaaaaaa-bbbb-cccc-dddd-0123456789ab'
-    UserFull:
-      type: object
-      required:
-        - name
-        - id
-        - href
-      properties:
-        name:
-          type: string
-          example: 'Dillon'
-        id:
-          type: string
-          example: 'USR-aaaaaaaa-bbbb-cccc-dddd-0123456789ab'
-        href:
-          type: string
-          example: 'http://conversation.local/v1/users/USR-aaaaaaaa-bbbb-cccc-dddd-0123456789ab'
-x-groups:
-  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/ConversationFull'
-  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.
-  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.