@api-client/core 0.8.0 → 0.8.2

package/data/apis/amf-helper-api/examples/comment-example.json

@@ -0,0 +1,42 @@
+{
+  "kind": "drive#comment",
+  "commentId": "AAAABGvGYkY",
+  "createdDate": "2017-01-26T22:27:04.655Z",
+  "modifiedDate": "2017-01-26T22:27:31.702Z",
+  "author": {
+    "kind": "drive#user",
+    "displayName": "John Doe",
+    "picture": {
+      "url": "//lh6.googleusercontent.com/-veehGFoGpso/AAAAAAAAAAI/AAAAAAACr8Y/YmMhVu8Ol-I/s96-k-no/photo.jpg"
+    },
+    "isAuthenticatedUser": true
+  },
+  "htmlContent": "Test comment",
+  "content": "Test comment",
+  "deleted": false,
+  "status": "open",
+  "context": {
+    "type": "text/html",
+    "value": "Hello"
+  },
+  "anchor": "kix.o11n7hdrivuh",
+  "fileId": "s7ggG6jZv5szIQL8Y5Ug-Iw",
+  "fileTitle": "Dummy file",
+  "replies": [{
+    "kind": "drive#commentReply",
+    "replyId": "AAAABGvGYkc",
+    "createdDate": "2017-01-26T22:27:31.702Z",
+    "modifiedDate": "2017-01-26T22:27:31.702Z",
+    "author": {
+      "kind": "drive#user",
+      "displayName": "John Doe",
+      "picture": {
+        "url": "//lh6.googleusercontent.com/-veehGFoGpso/AAAAAAAAAAI/AAAAAAACr8Y/YmMhVu8Ol-I/s96-k-no/photo.jpg"
+      },
+      "isAuthenticatedUser": true
+    },
+    "htmlContent": "This is the reply",
+    "content": "This is the reply",
+    "deleted": false
+  }]
+}

package/data/apis/amf-helper-api/examples/commentCreateRequest-example.json

@@ -0,0 +1,7 @@
+{
+  "content": "Comment body",
+  "context": {
+    "type": "text/plain",
+    "value": "Comment body"
+  }
+}

package/data/apis/amf-helper-api/examples/commentList-example.json

@@ -0,0 +1,48 @@
+{
+  "kind": "drive#commentList",
+  "selfLink": "https://www.googleapis.com/drive/v2/files/123dK-h456ysbyF_ol3Pc13B789j1qgb4wAbCdIQrNBY/comments",
+  "nextPageToken": "string",
+  "nextLink": "string",
+  "items": [{
+    "kind": "drive#comment",
+    "commentId": "AAAABGvGYkY",
+    "createdDate": "2017-01-26T22:27:04.655Z",
+    "modifiedDate": "2017-01-26T22:27:31.702Z",
+    "author": {
+      "kind": "drive#user",
+      "displayName": "John Doe",
+      "picture": {
+        "url": "//lh6.googleusercontent.com/-veehGFoGpso/AAAAAAAAAAI/AAAAAAACr8Y/YmMhVu8Ol-I/s96-k-no/photo.jpg"
+      },
+      "isAuthenticatedUser": true
+    },
+    "htmlContent": "Test comment",
+    "content": "Test comment",
+    "deleted": false,
+    "status": "open",
+    "context": {
+      "type": "text/html",
+      "value": "Hello"
+    },
+    "anchor": "kix.o11n7hdrivuh",
+    "fileId": "s7ggG6jZv5szIQL8Y5Ug-Iw",
+    "fileTitle": "Dummy file",
+    "replies": [{
+      "kind": "drive#commentReply",
+      "replyId": "AAAABGvGYkc",
+      "createdDate": "2017-01-26T22:27:31.702Z",
+      "modifiedDate": "2017-01-26T22:27:31.702Z",
+      "author": {
+        "kind": "drive#user",
+        "displayName": "John Doe",
+        "picture": {
+          "url": "//lh6.googleusercontent.com/-veehGFoGpso/AAAAAAAAAAI/AAAAAAACr8Y/YmMhVu8Ol-I/s96-k-no/photo.jpg"
+        },
+        "isAuthenticatedUser": true
+      },
+      "htmlContent": "This is the reply",
+      "content": "This is the reply",
+      "deleted": false
+    }]
+  }]
+}

package/data/apis/amf-helper-api/examples/person.json

@@ -0,0 +1,14 @@
+{
+  "id": "R34fg663H9KW9MMSKISI",
+  "name": "Pawel Psztyc",
+  "birthday": "1983-10-20",
+  "gender": "male",
+  "url": "https://domain.com/profile/pawel.psztyc",
+  "image": {
+    "url": "https://domain.com/profile/pawel.psztyc/image",
+    "thumb": "https://domain.com/profile/pawel.psztyc/image/thumb"
+  },
+  "tagline": "Some text about me.",
+  "language": "en_GB",
+  "etag": "W\\244m4n5kj3gbn2nj4k4n4"
+}

package/data/apis/amf-helper-api/examples/person.raml

@@ -0,0 +1,13 @@
+#%RAML 1.0 NamedExample
+
+id: "R34fg663H9KW9MMSKISI"
+name: "Pawel Psztyc"
+birthday: "1983-10-20"
+gender: "male"
+url: "https://domain.com/profile/pawel.psztyc"
+image:
+  url: "https://domain.com/profile/pawel.psztyc/image"
+  thumb: "https://domain.com/profile/pawel.psztyc/image/thumb"
+tagline: "Some text about me."
+language: "en_GB"
+etag: "W\\244m4n5kj3gbn2nj4k4n4"

package/data/apis/amf-helper-api/examples/person.xml

@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<resource error="false" type="AppPerson">
+  <id>Qawer63J73HJ6khjswuqyq62382jG21s</id>
+  <name>John Smith</name>
+  <birthday>1990-10-12</birthday>
+  <gender>male</gender>
+  <url>https://www.domain.com/people/Qawer63J73HJ6khjswuqyq62382jG21s</url>
+  <image>
+    <url>https://www.domain.com/people/Qawer63J73HJ6khjswuqyq62382jG21s/image</url>
+    <thumb>https://www.domain.com/people/Qawer63J73HJ6khjswuqyq62382jG21s/image/thumb</thumb>
+  </image>
+  <tagline>Hi, I'm John!</tagline>
+  <language>en_US</language>
+</resource>

package/data/apis/amf-helper-api/libraries/comment-lib.raml

@@ -0,0 +1,143 @@
+#%RAML 1.0 Library
+
+types:
+  User: !include ../types/user.raml
+  ReplyWritable:
+    properties:
+      content:
+        type: string
+        required: false
+        description: |
+          The plain text content used to create this reply.
+          This is not HTML safe and should only be used as a starting point to make edits to a
+          reply's content. This field is required on inserts if no verb is specified (resolve/reopen).
+      verb:
+        required: false
+        description: |
+          The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are:
+          - **resolve** - To resolve a comment.
+          - **reopen** - To reopen (un-resolve) a comment.
+  Reply:
+    type: ReplyWritable
+    properties:
+      kind:
+        type: string
+        description: This is always drive#commentReply.
+        default: drive#commentReply
+        enum: [drive#commentReply]
+      replyId:
+        description: The ID of the reply.
+      createdDate:
+        type: datetime
+        description: The date when this comment was first created.
+      modifiedDate:
+        type: datetime
+        description: The date when this comment or any of its replies were last modified.
+      author:
+        type: User
+        description: The user who wrote this comment.
+      htmlContent:
+        description: HTML formatted content for this reply.
+      deleted:
+        description: Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.
+        type: boolean
+  CommentWritable:
+    properties:
+      content:
+        description: The plain text content used to create this comment. This is not HTML safe and should only be used as a starting point to make edits to a comment's content.
+      context:
+        description: The context of the file which is being commented on.
+        type: object
+        properties:
+          type:
+            type: string
+            description: The MIME type of the context snippet.
+          value:
+            type: string
+            description: Data representation of the segment of the file being commented on. In the case of a text file for example, this would be the actual text that the comment is about.
+  Comment:
+    type: CommentWritable
+    properties:
+      kind:
+        type: string
+        description: This is always drive#comment.
+        default: drive#comment
+        enum: [drive#comment]
+      selfLink:
+        description: A link back to this comment.
+        required: false
+      commentId:
+        description: The ID of the comment.
+      createdDate:
+        type: datetime
+        description: The date when this comment was first created.
+      modifiedDate:
+        type: datetime
+        description: The date when this comment or any of its replies were last modified.
+      author:
+        type: User
+        description: The user who wrote this comment.
+      htmlContent:
+        description: HTML formatted content for this comment.
+      deleted:
+        description: Whether this comment has been deleted. If a comment has been deleted the content will be cleared and this will only represent a comment that once existed.
+        type: boolean
+      status:
+        description: |
+          The status of this comment. Status can be changed by posting a reply to a comment with the desired status.
+          - **open** - The comment is still open.
+          - **resolved** - The comment has been resolved by one of its replies.
+      anchor:
+        description: A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties.
+      fileId:
+        description: The file which this comment is addressing.
+      fileTitle:
+        description: The title of the file which this comment is addressing.
+      replies:
+        type: Reply[]
+        description: Replies to this post.
+  CommentList:
+    properties:
+      kind:
+        type: string
+        default: drive#commentList
+        enum: [drive#commentList]
+        description: This is always drive#commentList.
+      nextPageToken:
+        type: string
+        required: false
+        description: The token to use to request the next page of results.
+      selfLink:
+        type: string
+        description: A link back to this list.
+      nextLink:
+        type: string
+        required: false
+        description: A link to the next page of comments.
+      items:
+        type: Comment[]
+        required: false
+        description: The actual list of comments.
+  ReplyList:
+    properties:
+      kind:
+        type: string
+        default: drive#commentReplyList
+        enum: [drive#commentReplyList]
+        description: This is always drive#commentReplyList.
+      nextPageToken:
+        type: string
+        description: The token to use to request the next page of results.
+        required: false
+      selfLink:
+        type: string
+        description: A link back to this list.
+      nextLink:
+        type: string
+        description: A link to the next page of comments.
+        required: false
+      items:
+        type: array
+        required: false
+        description: The actual list of reply.
+        items: Reply

package/data/apis/amf-helper-api/library.raml

@@ -0,0 +1,7 @@
+#%RAML 1.0 Library
+usage: This is a Library raml
+
+types:
+  TypeFromLibray:
+    properties:
+      age: number

package/data/apis/amf-helper-api/schemas/person.json

@@ -0,0 +1,104 @@
+{
+  "$id": "http://example.com/example.json",
+  "type": "object",
+  "definitions": {},
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "properties": {
+    "id": {
+      "$id": "/properties/id",
+      "type": "string",
+      "title": "The Id Schema ",
+      "default": "",
+      "examples": [
+        "R34fg663H9KW9MMSKISI"
+      ]
+    },
+    "name": {
+      "$id": "/properties/name",
+      "type": "string",
+      "title": "The Name Schema ",
+      "default": "",
+      "examples": [
+        "Pawel Psztyc"
+      ]
+    },
+    "birthday": {
+      "$id": "/properties/birthday",
+      "type": "string",
+      "title": "The Birthday Schema ",
+      "default": "",
+      "examples": [
+        "1983-10-20"
+      ]
+    },
+    "gender": {
+      "$id": "/properties/gender",
+      "type": "string",
+      "title": "The Gender Schema ",
+      "default": "",
+      "examples": [
+        "male"
+      ]
+    },
+    "url": {
+      "$id": "/properties/url",
+      "type": "string",
+      "title": "The Url Schema ",
+      "default": "",
+      "examples": [
+        "https://domain.com/profile/pawel.psztyc"
+      ]
+    },
+    "image": {
+      "$id": "/properties/image",
+      "type": "object",
+      "properties": {
+        "url": {
+          "$id": "/properties/image/properties/url",
+          "type": "string",
+          "title": "The Url Schema ",
+          "default": "",
+          "examples": [
+            "https://domain.com/profile/pawel.psztyc/image"
+          ]
+        },
+        "thumb": {
+          "$id": "/properties/image/properties/thumb",
+          "type": "string",
+          "title": "The Thumb Schema ",
+          "default": "",
+          "examples": [
+            "https://domain.com/profile/pawel.psztyc/image/thumb"
+          ]
+        }
+      }
+    },
+    "tagline": {
+      "$id": "/properties/tagline",
+      "type": "string",
+      "title": "The Tagline Schema ",
+      "default": "",
+      "examples": [
+        "Some text about me."
+      ]
+    },
+    "language": {
+      "$id": "/properties/language",
+      "type": "string",
+      "title": "The Language Schema ",
+      "default": "",
+      "examples": [
+        "en_GB"
+      ]
+    },
+    "etag": {
+      "$id": "/properties/etag",
+      "type": "string",
+      "title": "The Etag Schema ",
+      "default": "",
+      "examples": [
+        "W\\244m4n5kj3gbn2nj4k4n4"
+      ]
+    }
+  }
+}

package/data/apis/amf-helper-api/schemas/person.xsd

@@ -0,0 +1,26 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified">
+  <xs:element name="resource">
+    <xs:complexType>
+      <xs:sequence>
+        <xs:element name="id" type="xs:string"></xs:element>
+        <xs:element name="name" type="xs:string"></xs:element>
+        <xs:element name="birthday" type="xs:date"></xs:element>
+        <xs:element name="gender" type="xs:string"></xs:element>
+        <xs:element name="url" type="xs:string"></xs:element>
+        <xs:element name="image">
+          <xs:complexType>
+            <xs:sequence>
+              <xs:element name="url" type="xs:string"></xs:element>
+              <xs:element name="thumb" type="xs:string"></xs:element>
+            </xs:sequence>
+          </xs:complexType>
+        </xs:element>
+        <xs:element name="tagline" type="xs:string"></xs:element>
+        <xs:element name="language" type="xs:string"></xs:element>
+      </xs:sequence>
+      <xs:attribute name="error" type="xs:boolean" use="required"></xs:attribute>
+      <xs:attribute name="type" type="xs:string" use="required"></xs:attribute>
+    </xs:complexType>
+  </xs:element>
+</xs:schema>

package/data/apis/amf-helper-api/traits/file.raml

@@ -0,0 +1,33 @@
+#%RAML 1.0 Trait
+
+queryParameters:
+  convert:
+    type: boolean
+    required: false
+    description: |
+      Whether to convert this file to the corresponding Google Docs format. (Default: false)
+    default: false
+  ocr:
+    type: boolean
+    required: false
+    description: |
+      Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads. (Default: false)
+    default: false
+  ocrLanguage:
+    type: string
+    required: false
+    description: If ocr is true, hints at the language to use. Valid values are BCP 47 codes.
+  pinned:
+    type: boolean
+    required: false
+    description: |
+      Whether to pin the head revision of the uploaded file. A file can have a maximum of 200 pinned revisions. (Default: false)
+    default: false
+  timedTextLanguage:
+    type: string
+    required: false
+    description: The language of the timed text.
+  timedTextTrackName:
+      type: string
+      required: false
+      description: The timed text track name.

package/data/apis/amf-helper-api/traits/pagination.raml

@@ -0,0 +1,80 @@
+#%RAML 1.0 Trait
+
+# displayName: Paginated
+description: The collection of <<resourcePathName>>.
+usage: |
+  This trait is to be used when the resource is paginated that is the edpoint producses
+  a list of resources in the response.
+  Every paginated response contains a `nextPageToken` property that should be used in pagination
+  to request for next page of the results and `items` which is a list of resources.
+  The `items` property is always defined, even if the response is empty. Therefore the `404`
+  response in this case is not possible. Clients need to handle empty responses by their own.
+  It is crutial that the subsequent requests contain the same set of parameters (like `limit`
+  or `start`) because if this values will change then the `nextPageToken` will be revalidated
+  and pagination will start from the first page.
+queryParameters:
+  limit:
+    type: number
+    description: Limit in the response list
+    maximum: 300
+    minimum: 1
+    example: 100
+    default: 25
+  start:
+    type: number
+    description: The start entry of the list
+    minimum: 0
+    example: 25
+    default: 0
+  nextPageToken:
+    type: string
+    example: CiAKGjBpNDd2Nmp2Zml2cXRwYjBpOXA
+    description: |
+      The `nextPageToken` is a web safe encoded cursor to the next entry in the database.
+      It can be obtained by requesting paginated resource and used in next request to get
+      next results page.
+    pattern: "[a-zA-Z0-9]+"
+responses:
+  200:
+    description: |
+      Paginated response containing a single page of the result.
+      By default one page of the results contains 25 items. You can extend it by setting a
+      `limit` query parameter in your request.
+      When changing parameters while using the `nextPageToken` the `nextPageToken` will be ignored
+      and new query will be performed. Queries with `nextPageToken` should contain the same set
+      of parameters as the first request.
+    body:
+      application/json:
+        type: object
+        properties:
+          items:
+            type: array
+            required: true
+            description: Contains a list of objects for this method.
+            items: <<resourceType>>
+          nextPageToken:
+            type: string
+            required: true
+            example: CiAKGjBpNDd2Nmp2Zml2cXRwYjBpOXA
+            description: |
+              The next page token is a web safe encoded cursor to the next entry in the database.
+              Use it in the next request to obtain next page of the results.
+  400:
+    description: |
+      The error response when one of the parameters is invalid and can't be parsed.
+      Nothing can be done at this time except correcting the request to send valid data.
+    body:
+      application/json:
+        displayName: Invalid
+        type: object
+        properties:
+          error:
+            type: boolean
+            required: true
+            example: true
+            description: Indicate that the response is errored.
+          message:
+            type: string
+            description: The error message associated with the error.
+            example: The `limit` parameter is invalid. Please, provide a number between 1 and 300.
+            required: true

package/data/apis/amf-helper-api/traits/results.raml

@@ -0,0 +1,19 @@
+queryParameters:
+  includeDeleted:
+    description: Whether to include deleted items. If set, all replies, including deleted replies (with content stripped) will be returned.
+    default: true
+    type: boolean
+    required: false
+  maxResults:
+    type: integer
+    description: The maximum number of replies to include in the response, used for paging. Acceptable values are 0 to 100, inclusive
+    default: 100
+    minimum: 0
+    maximum: 1000
+    required: false
+  pageToken:
+    type: string
+    required: false
+    description: |
+      Page token for changes.
+      The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response.

package/data/apis/amf-helper-api/traits/visibility.raml

@@ -0,0 +1,14 @@
+queryParameters:
+  visibility:
+    type: string
+    required: false
+    description: |
+      The visibility of the property.
+      The visibility of the new file. This parameter is only relevant when convert=false.
+      Acceptable values are:
+      - **"DEFAULT"**: The visibility of the new file is determined by the user's default visibility/sharing policies. (default)
+      - **"PRIVATE"**: The new file will be visible to only the owner.
+      The visibility of the new file. This parameter is only relevant when the source is not a native Google Doc and convert=false.
+      Acceptable values are:
+      - **DEFAULT"**: The visibility of the new file is determined by the user's default visibility/sharing policies. (default)
+      - **"PRIVATE"**: The new file will be visible to only the owner.

package/data/apis/amf-helper-api/types/app-person.raml

@@ -0,0 +1,101 @@
+#%RAML 1.0 DataType
+
+displayName: A person resource
+description: |
+  An object representing a person in the API.
+  This object will be used in all methods returning a Person or list of people.
+
+type: !include resource.raml
+example:
+  id: "R34fg663H9KW9MMSKISIhTs1dR7Hss7e"
+  name: "Pawel Psztyc"
+  birthday: "1983-10-20"
+  gender: male
+  url: "https://domain.com/profile/pawel.psztyc"
+  image:
+    url: https://domain.com/profile/pawel.psztyc/image
+    thumb: https://domain.com/profile/pawel.psztyc/image/thumb
+  tagline: Some text about me.
+  language: en_GB
+  etag: "W\\244m4n5kj3gbn2nj4k4n4"
+  favouriteNumber: 10
+  favouriteTime: 10:29:52
+  nillable: null
+
+properties:
+  id:
+    description: |
+      A unique identifier of a person.
+
+      It is a 32 bit string containing alphanumeric characters.
+    minLength: 32
+    maxLength: 32
+    pattern: "[A-Za-z0-9]*"
+  name:
+    required: true
+    example: John Smith
+    description: Person full name. The input will be rejected if this property is not set while creating new object.
+    type: string
+    pattern: "[0-9a-zA-Z ]+"
+  birthday:
+    type: date-only
+    description: The person's date of birth, represented as YYYY-MM-DD.
+  favouriteTime:
+    type: time-only
+    description: The person's favourite time of day
+  gender?:
+    type: string
+    description: |
+      The person's gender. Possible values includes, but are not limited to, the following values:
+      * "male" - Male gender.
+      * "female" - Female gender.
+      * "other" - Other.
+    enum: [male, female, other]
+    examples:
+      Women: female
+      Man: male
+      Elmo: other
+  favouriteNumber:
+    type: number
+    minimum: 0
+    maximum: 9999
+    multipleOf: 5
+    required: true
+    displayName: Favourite number
+    example: 25
+  url:
+    type: string
+    description: The URL of this person's profile.
+  image: !include image.raml
+  tagline:
+    type: string
+    description: The brief description (tagline) of this person.
+  language:
+    type: string
+    description: The user's preferred language for rendering.
+  newsletter:
+    type: boolean
+    required: false
+    default: false
+  age:
+    type: integer
+    required: false
+    description: |
+      Very unpractical property to have in a data store.
+  created:
+    type: datetime-only
+    required: false
+    example: 2018-04-09T19:10:15
+  fietype:
+    required: false
+    type: file
+    fileTypes:
+      - image/png
+      - image/jpeg
+      - image/jpg
+      - image/gif
+    minLength: 10
+    maxLength: 1000
+  nillable:
+    type: string | nil
+    default: null