diff --git a/CHANGELOG.md b/CHANGELOG.md index e5a93c93..4962c27d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,12 @@ +4.7.0 - May 31, 2018 + +* chore: fix test (Hovhannes Babayan) +* feat: add `fields` parameter to metadata() method (Hovhannes Babayan) +* Update to node 10 in .travis.yml (greenkeeper[bot]) +* chore(package): update istanbul-instrumenter-loader to version 3.0.1 (greenkeeper[bot]) +* chore(package): update execa to version 0.10.0 (greenkeeper[bot]) +* chore(package): update typedoc to version 0.11.0 (greenkeeper[bot]) + 4.6.0 - February 20, 2018 * chore: upgrade packages typescript@2.7.2 ts-loader@3.5.0 (Sassoun Derderian) diff --git a/docs/assets/js/search.js b/docs/assets/js/search.js index f230f6fd..6053f310 100644 --- a/docs/assets/js/search.js +++ b/docs/assets/js/search.js @@ -1,3 +1,3 @@ -var typedoc = typedoc || {}; +var typedoc = typedoc || {}; typedoc.search = typedoc.search || {}; typedoc.search.data = {"kinds":{"1":"External module","32":"Variable","64":"Function","128":"Class","256":"Interface","512":"Constructor","1024":"Property","2048":"Method","65536":"Type literal","2097152":"Object literal","4194304":"Type alias"},"rows":[{"id":0,"kind":1,"name":"\"Api\"","url":"modules/_api_.html","classes":"tsd-kind-external-module"},{"id":1,"kind":256,"name":"IHttpOptions","url":"interfaces/_api_.ihttpoptions.html","classes":"tsd-kind-interface tsd-parent-kind-external-module","parent":"\"Api\""},{"id":2,"kind":1024,"name":"path","url":"interfaces/_api_.ihttpoptions.html#path","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"Api\".IHttpOptions"},{"id":3,"kind":1024,"name":"method","url":"interfaces/_api_.ihttpoptions.html#method","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"Api\".IHttpOptions"},{"id":4,"kind":1024,"name":"url","url":"interfaces/_api_.ihttpoptions.html#url","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"Api\".IHttpOptions"},{"id":5,"kind":1024,"name":"alwaysUseGet","url":"interfaces/_api_.ihttpoptions.html#alwaysuseget","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"Api\".IHttpOptions"},{"id":6,"kind":1024,"name":"headers","url":"interfaces/_api_.ihttpoptions.html#headers","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"Api\".IHttpOptions"},{"id":7,"kind":65536,"name":"__type","url":"interfaces/_api_.ihttpoptions.html#headers.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"\"Api\".IHttpOptions.headers"},{"id":8,"kind":32,"name":"sessionID","url":"interfaces/_api_.ihttpoptions.html#headers.__type.sessionid","classes":"tsd-kind-variable tsd-parent-kind-type-literal tsd-is-not-exported","parent":"\"Api\".IHttpOptions.headers.__type"},{"id":9,"kind":32,"name":"X-XSRF-TOKEN","url":"interfaces/_api_.ihttpoptions.html#headers.__type.x_xsrf_token","classes":"tsd-kind-variable tsd-parent-kind-type-literal tsd-is-not-exported","parent":"\"Api\".IHttpOptions.headers.__type"},{"id":10,"kind":32,"name":"apiKey","url":"interfaces/_api_.ihttpoptions.html#headers.__type.apikey","classes":"tsd-kind-variable tsd-parent-kind-type-literal tsd-is-not-exported","parent":"\"Api\".IHttpOptions.headers.__type"},{"id":11,"kind":256,"name":"IApiConfig","url":"interfaces/_api_.iapiconfig.html","classes":"tsd-kind-interface tsd-parent-kind-external-module","parent":"\"Api\""},{"id":12,"kind":1024,"name":"url","url":"interfaces/_api_.iapiconfig.html#url","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"Api\".IApiConfig"},{"id":13,"kind":1024,"name":"version","url":"interfaces/_api_.iapiconfig.html#version","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"Api\".IApiConfig"},{"id":14,"kind":1024,"name":"alwaysUseGet","url":"interfaces/_api_.iapiconfig.html#alwaysuseget","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"Api\".IApiConfig"},{"id":15,"kind":1024,"name":"apiKey","url":"interfaces/_api_.iapiconfig.html#apikey","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"Api\".IApiConfig"},{"id":16,"kind":1024,"name":"headers","url":"interfaces/_api_.iapiconfig.html#headers","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"Api\".IApiConfig"},{"id":17,"kind":65536,"name":"__type","url":"interfaces/_api_.iapiconfig.html#headers.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"\"Api\".IApiConfig.headers"},{"id":18,"kind":128,"name":"Api","url":"classes/_api_.api.html","classes":"tsd-kind-class tsd-parent-kind-external-module","parent":"\"Api\""},{"id":19,"kind":2097152,"name":"Methods","url":"classes/_api_.api.html#methods","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"\"Api\".Api"},{"id":20,"kind":32,"name":"GET","url":"classes/_api_.api.html#methods.get-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"\"Api\".Api.Methods"},{"id":21,"kind":32,"name":"PUT","url":"classes/_api_.api.html#methods.put","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"\"Api\".Api.Methods"},{"id":22,"kind":32,"name":"DELETE","url":"classes/_api_.api.html#methods.delete","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"\"Api\".Api.Methods"},{"id":23,"kind":32,"name":"POST","url":"classes/_api_.api.html#methods.post","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"\"Api\".Api.Methods"},{"id":24,"kind":1024,"name":"_httpOptions","url":"classes/_api_.api.html#_httpoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":25,"kind":1024,"name":"serverAcceptsJSON","url":"classes/_api_.api.html#serveracceptsjson","classes":"tsd-kind-property tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":26,"kind":512,"name":"constructor","url":"classes/_api_.api.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":27,"kind":2048,"name":"getApiKey","url":"classes/_api_.api.html#getapikey","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":28,"kind":2048,"name":"copy","url":"classes/_api_.api.html#copy","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":29,"kind":2048,"name":"count","url":"classes/_api_.api.html#count","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":30,"kind":2048,"name":"clearApiKey","url":"classes/_api_.api.html#clearapikey","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":31,"kind":2048,"name":"create","url":"classes/_api_.api.html#create","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":32,"kind":2048,"name":"edit","url":"classes/_api_.api.html#edit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":33,"kind":2048,"name":"editMultiple","url":"classes/_api_.api.html#editmultiple","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":34,"kind":2048,"name":"execute","url":"classes/_api_.api.html#execute","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":35,"kind":2048,"name":"get","url":"classes/_api_.api.html#get","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":36,"kind":2048,"name":"login","url":"classes/_api_.api.html#login","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":37,"kind":2048,"name":"logout","url":"classes/_api_.api.html#logout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":38,"kind":2048,"name":"metadata","url":"classes/_api_.api.html#metadata","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":39,"kind":2048,"name":"namedQuery","url":"classes/_api_.api.html#namedquery","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":40,"kind":2048,"name":"remove","url":"classes/_api_.api.html#remove","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":41,"kind":2048,"name":"report","url":"classes/_api_.api.html#report","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":42,"kind":2048,"name":"request","url":"classes/_api_.api.html#request","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":43,"kind":2048,"name":"search","url":"classes/_api_.api.html#search","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":44,"kind":2048,"name":"setApiKey","url":"classes/_api_.api.html#setapikey","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":45,"kind":2048,"name":"setSessionID","url":"classes/_api_.api.html#setsessionid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":46,"kind":2048,"name":"setXSRFToken","url":"classes/_api_.api.html#setxsrftoken","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":47,"kind":2048,"name":"uploadFromStream","url":"classes/_api_.api.html#uploadfromstream","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":48,"kind":2048,"name":"uploadFileContent","url":"classes/_api_.api.html#uploadfilecontent","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":49,"kind":4194304,"name":"TFields","url":"modules/_api_.html#tfields","classes":"tsd-kind-type-alias tsd-parent-kind-external-module","parent":"\"Api\""},{"id":50,"kind":32,"name":"GlobalScope","url":"modules/_api_.html#globalscope","classes":"tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported","parent":"\"Api\""},{"id":51,"kind":64,"name":"queryStringify","url":"modules/_api_.html#querystringify","classes":"tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported","parent":"\"Api\""},{"id":52,"kind":4194304,"name":"TSuccessHandler","url":"modules/_api_.html#tsuccesshandler","classes":"tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter","parent":"\"Api\""},{"id":53,"kind":65536,"name":"__type","url":"modules/_api_.html#tsuccesshandler.__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias tsd-is-not-exported","parent":"\"Api\".TSuccessHandler"},{"id":54,"kind":4194304,"name":"TFailureHandler","url":"modules/_api_.html#tfailurehandler","classes":"tsd-kind-type-alias tsd-parent-kind-external-module","parent":"\"Api\""},{"id":55,"kind":65536,"name":"__type","url":"modules/_api_.html#tfailurehandler.__type","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias tsd-is-not-exported","parent":"\"Api\".TFailureHandler"},{"id":56,"kind":2097152,"name":"ResponseHandler","url":"modules/_api_.html#responsehandler","classes":"tsd-kind-object-literal tsd-parent-kind-external-module","parent":"\"Api\""},{"id":57,"kind":64,"name":"success","url":"modules/_api_.html#responsehandler.success","classes":"tsd-kind-function tsd-parent-kind-object-literal","parent":"\"Api\".ResponseHandler"},{"id":58,"kind":64,"name":"failure","url":"modules/_api_.html#responsehandler.failure","classes":"tsd-kind-function tsd-parent-kind-object-literal","parent":"\"Api\".ResponseHandler"},{"id":59,"kind":1,"name":"\"index\"","url":"modules/_index_.html","classes":"tsd-kind-external-module"}]}; \ No newline at end of file diff --git a/docs/classes/_api_.api.html b/docs/classes/_api_.api.html index 5a6ce658..9c2a74ca 100644 --- a/docs/classes/_api_.api.html +++ b/docs/classes/_api_.api.html @@ -154,7 +154,7 @@

constructor

  • Parameters

    @@ -176,7 +176,7 @@

    _httpOptions

    _httpOptions: IHttpOptions
    @@ -186,7 +186,7 @@

    serverAcceptsJSON

    serverAcceptsJSON: boolean
    @@ -203,7 +203,7 @@

    clearApiKey

  • @@ -232,7 +232,7 @@

    copy

  • @@ -291,7 +291,7 @@

    count

  • @@ -330,7 +330,7 @@

    create

  • @@ -376,7 +376,7 @@

    edit

  • @@ -428,7 +428,7 @@

    editMultiple

  • @@ -474,7 +474,7 @@

    execute

  • @@ -526,7 +526,7 @@

    get

  • @@ -575,7 +575,7 @@

    getApiKey

  • @@ -618,7 +618,7 @@

    login

  • @@ -662,7 +662,7 @@

    logout

  • @@ -684,13 +684,13 @@

    Returns Promise

    metadata

      -
    • metadata(objCode?: string): Promise<any>
      • +
    • metadata(objCode?: string, fields?: TFields): Promise<any>
    • @@ -708,6 +708,12 @@

      Parameters

    • Optional objCode: string
      • +
    • +
      Optional fields: TFields
      +
      +

      Which fields to return.

      +
      +

    Returns Promise<any>

    A promise which will resolved with object metadata if everything went ok and rejected otherwise

    @@ -724,7 +730,7 @@

    namedQuery

  • @@ -776,7 +782,7 @@

    remove

  • @@ -822,7 +828,7 @@

    report

  • @@ -865,7 +871,7 @@

    request

  • @@ -914,7 +920,7 @@

    search

  • @@ -960,7 +966,7 @@

    setApiKey

  • @@ -994,7 +1000,7 @@

    setSessionID

  • @@ -1030,7 +1036,7 @@

    setXSRFToken

  • @@ -1063,7 +1069,7 @@

    uploadFileContent

  • Parameters

    @@ -1089,7 +1095,7 @@

    uploadFromStream

  • @@ -1139,7 +1145,7 @@

    Static Methods

    Methods: object
    @@ -1148,7 +1154,7 @@

    DELETE

    DELETE: string = "DELETE"
    @@ -1158,7 +1164,7 @@

    GET

    GET: string = "GET"
    @@ -1168,7 +1174,7 @@

    POST

    POST: string = "POST"
    @@ -1178,7 +1184,7 @@

    PUT

    PUT: string = "PUT"
    diff --git a/docs/interfaces/_api_.iapiconfig.html b/docs/interfaces/_api_.iapiconfig.html index 70b5b67f..20757cf9 100644 --- a/docs/interfaces/_api_.iapiconfig.html +++ b/docs/interfaces/_api_.iapiconfig.html @@ -100,7 +100,7 @@

    Optional alwaysUseGe
    alwaysUseGet: boolean
    @@ -110,7 +110,7 @@

    Optional apiKey

    apiKey: string
    @@ -120,7 +120,7 @@

    Optional headers

    headers: object
    @@ -138,7 +138,7 @@

    url

    url: string
    @@ -148,7 +148,7 @@

    Optional version

    version: string
    diff --git a/docs/interfaces/_api_.ihttpoptions.html b/docs/interfaces/_api_.ihttpoptions.html index 9aefd253..472d278b 100644 --- a/docs/interfaces/_api_.ihttpoptions.html +++ b/docs/interfaces/_api_.ihttpoptions.html @@ -100,7 +100,7 @@

    Optional alwaysUseGe
    alwaysUseGet: boolean
    @@ -110,7 +110,7 @@

    headers

    headers: object
    @@ -134,7 +134,7 @@

    Optional method

    method: string
    @@ -144,7 +144,7 @@

    Optional path

    path: string
    @@ -154,7 +154,7 @@

    url

    url: string
    diff --git a/docs/modules/_api_.html b/docs/modules/_api_.html index bcbe51a9..613dcd37 100644 --- a/docs/modules/_api_.html +++ b/docs/modules/_api_.html @@ -134,7 +134,7 @@

    TFailureHandler

    TFailureHandler: function
    @@ -165,7 +165,7 @@

    TFields

    TFields: string | string[]
    @@ -175,7 +175,7 @@

    TSuccessHandler

    TSuccessHandler: function
    @@ -209,7 +209,7 @@

    Const GlobalScope

    GlobalScope: any = Function('return this')()
    @@ -226,7 +226,7 @@

    Const queryStringify

  • Parameters

    @@ -248,7 +248,7 @@

    Const ResponseHandler

    ResponseHandler: object
    @@ -261,7 +261,7 @@

    failure

  • Parameters

    @@ -284,7 +284,7 @@

    success

  • Parameters

    diff --git a/package.json b/package.json index b926e44d..7558606d 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "workfront-api", - "version": "4.6.0", + "version": "4.7.0", "description": "A Workfront API for the Node.js and the Web", "main": "dist/workfront.js", "module": "es/index.js",