diff --git a/CHANGELOG.md b/CHANGELOG.md index 9af5c8a3..6f48d830 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,35 @@ +4.0.0-0 - July 29, 2017 + +* chore: add E2E tests `npm run e2e` connects to http://localhost:8080, creates a customer and runs multiple API scenarios (Sassoun Derderian) +* fix: request gets JSON as body When an object is created or edited the payload can be either an object or an object with `updates` property (Sassoun Derderian) +* chore(package): update typedoc to version 0.8.0 (greenkeeper[bot]) +* chore(package): update webpack to version 3.4.1 (greenkeeper[bot]) +* fix: make send JSON body optional (Sassoun Derderian) +* fix: update examples api version to >v5.0 (Sassoun Derderian) +* chore(package): update @types/form-data to version 2.2.0 (greenkeeper[bot]) +* fix #103: All response from server should be in JSON format (Sassoun Derderian) +* chore: disable SauceLabs test if the PR is from fork TravisCI doesn't set encrypted environment variables for Pull Requests that are not from the same repository https://docs.travis-ci.com/user/pull-requests#Pull-Requests-and-Security-Restrictions (Sassoun Derderian) +* chore: remove package-lock.json from .gitignore (Sassoun Derderian) +* chore(package): update typescript to version 2.4.2 (greenkeeper[bot]) +* chore(package): update ts-loader to version 2.3.1 (greenkeeper[bot]) +* generate new encrypted SAUCE_ACCESS_KEY and SAUCE_USERNAME (Sassoun Derderian) +* encrypt username and access token (Sassoun Derderian) +* fix: set env in .travis.yml (Sassoun Derderian) +* fix: sauce access_key and username set as env variables (Sassoun Derderian) +* fix: set startConnect to false in karma-sauce-launcher (Sassoun Derderian) +* fix: configure karma-sauce-launcher the way angular did it (Sassoun Derderian) +* fix: set TRAVIS_JOB_NUMBER as tunnelIdentifier in karma-sauce-launcher (Sassoun Derderian) +* fix(package): update @types/node to version 8.0.14 (greenkeeper[bot]) +* Only using json encoding on put and post (Joe Wiggins) +* Fixing tests around changing to JSON bodies (Joe Wiggins) +* Removing package lock from git. Removing support for form encoded requests and moving to straight json. (Joe Wiggins) +* chore(package): update webpack to version 3.3.0 (greenkeeper[bot]) +* chore(package): update ts-loader to version 2.3.0 (greenkeeper[bot]) +* Forgot to update the version for bug fix (Joe Wiggins) +* Fixing alwaysUseGet feature and adding a test for it. Moving apiKey into headers for all requests when apiKey is used and adding to edit test (Joe Wiggins) +* chore(package): update karma-webpack to version 2.0.4 (greenkeeper[bot]) +* chore(package): update tslint to version 5.5.0 (greenkeeper[bot]) + 3.0.3 - July 11, 2017 * chore: reverting version change (Sassoun Derderian) diff --git a/docs/assets/js/search.js b/docs/assets/js/search.js index e3b5508f..e618e7ed 100644 --- a/docs/assets/js/search.js +++ b/docs/assets/js/search.js @@ -1,3 +1,3 @@ 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":"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":10,"kind":128,"name":"Api","url":"classes/_api_.api.html","classes":"tsd-kind-class tsd-parent-kind-external-module","parent":"\"Api\""},{"id":11,"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":12,"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":13,"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":14,"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":15,"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":16,"kind":1024,"name":"_httpOptions","url":"classes/_api_.api.html#_httpoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":17,"kind":1024,"name":"_httpParams","url":"classes/_api_.api.html#_httpparams","classes":"tsd-kind-property tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":18,"kind":512,"name":"constructor","url":"classes/_api_.api.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":19,"kind":2048,"name":"getApiKey","url":"classes/_api_.api.html#getapikey","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":20,"kind":2048,"name":"copy","url":"classes/_api_.api.html#copy","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":21,"kind":2048,"name":"count","url":"classes/_api_.api.html#count","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":22,"kind":2048,"name":"clearApiKey","url":"classes/_api_.api.html#clearapikey","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":23,"kind":2048,"name":"create","url":"classes/_api_.api.html#create","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":24,"kind":2048,"name":"edit","url":"classes/_api_.api.html#edit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":25,"kind":2048,"name":"execute","url":"classes/_api_.api.html#execute","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":26,"kind":2048,"name":"get","url":"classes/_api_.api.html#get","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":27,"kind":2048,"name":"login","url":"classes/_api_.api.html#login","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":28,"kind":2048,"name":"logout","url":"classes/_api_.api.html#logout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":29,"kind":2048,"name":"metadata","url":"classes/_api_.api.html#metadata","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":30,"kind":2048,"name":"namedQuery","url":"classes/_api_.api.html#namedquery","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":31,"kind":2048,"name":"remove","url":"classes/_api_.api.html#remove","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":32,"kind":2048,"name":"report","url":"classes/_api_.api.html#report","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":33,"kind":2048,"name":"request","url":"classes/_api_.api.html#request","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":34,"kind":2048,"name":"search","url":"classes/_api_.api.html#search","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":35,"kind":2048,"name":"setApiKey","url":"classes/_api_.api.html#setapikey","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":36,"kind":2048,"name":"setSessionID","url":"classes/_api_.api.html#setsessionid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":37,"kind":2048,"name":"uploadFromStream","url":"classes/_api_.api.html#uploadfromstream","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":38,"kind":2048,"name":"uploadFileContent","url":"classes/_api_.api.html#uploadfilecontent","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":39,"kind":4194304,"name":"THttpParams","url":"modules/_api_.html#thttpparams","classes":"tsd-kind-type-alias tsd-parent-kind-external-module","parent":"\"Api\""},{"id":40,"kind":4194304,"name":"TFields","url":"modules/_api_.html#tfields","classes":"tsd-kind-type-alias tsd-parent-kind-external-module","parent":"\"Api\""},{"id":41,"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":42,"kind":2097152,"name":"ResponseHandler","url":"modules/_api_.html#responsehandler","classes":"tsd-kind-object-literal tsd-parent-kind-external-module tsd-is-not-exported","parent":"\"Api\""},{"id":43,"kind":64,"name":"success","url":"modules/_api_.html#responsehandler.success","classes":"tsd-kind-function tsd-parent-kind-object-literal tsd-is-not-exported","parent":"\"Api\".ResponseHandler"},{"id":44,"kind":64,"name":"failure","url":"modules/_api_.html#responsehandler.failure","classes":"tsd-kind-function tsd-parent-kind-object-literal tsd-is-not-exported","parent":"\"Api\".ResponseHandler"},{"id":45,"kind":1,"name":"\"index\"","url":"modules/_index_.html","classes":"tsd-kind-external-module"}]}; \ No newline at end of file + 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":"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":10,"kind":128,"name":"Api","url":"classes/_api_.api.html","classes":"tsd-kind-class tsd-parent-kind-external-module","parent":"\"Api\""},{"id":11,"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":12,"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":13,"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":14,"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":15,"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":16,"kind":1024,"name":"_httpOptions","url":"classes/_api_.api.html#_httpoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":17,"kind":1024,"name":"_httpParams","url":"classes/_api_.api.html#_httpparams","classes":"tsd-kind-property tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":18,"kind":512,"name":"constructor","url":"classes/_api_.api.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":19,"kind":2048,"name":"getApiKey","url":"classes/_api_.api.html#getapikey","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":20,"kind":2048,"name":"copy","url":"classes/_api_.api.html#copy","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":21,"kind":2048,"name":"count","url":"classes/_api_.api.html#count","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":22,"kind":2048,"name":"clearApiKey","url":"classes/_api_.api.html#clearapikey","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":23,"kind":2048,"name":"create","url":"classes/_api_.api.html#create","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":24,"kind":2048,"name":"edit","url":"classes/_api_.api.html#edit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":25,"kind":2048,"name":"execute","url":"classes/_api_.api.html#execute","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":26,"kind":2048,"name":"get","url":"classes/_api_.api.html#get","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":27,"kind":2048,"name":"login","url":"classes/_api_.api.html#login","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":28,"kind":2048,"name":"logout","url":"classes/_api_.api.html#logout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":29,"kind":2048,"name":"metadata","url":"classes/_api_.api.html#metadata","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":30,"kind":2048,"name":"namedQuery","url":"classes/_api_.api.html#namedquery","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":31,"kind":2048,"name":"remove","url":"classes/_api_.api.html#remove","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":32,"kind":2048,"name":"report","url":"classes/_api_.api.html#report","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":33,"kind":2048,"name":"request","url":"classes/_api_.api.html#request","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":34,"kind":2048,"name":"search","url":"classes/_api_.api.html#search","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":35,"kind":2048,"name":"setApiKey","url":"classes/_api_.api.html#setapikey","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":36,"kind":2048,"name":"setSessionID","url":"classes/_api_.api.html#setsessionid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":37,"kind":2048,"name":"uploadFromStream","url":"classes/_api_.api.html#uploadfromstream","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":38,"kind":2048,"name":"uploadFileContent","url":"classes/_api_.api.html#uploadfilecontent","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":39,"kind":4194304,"name":"THttpParams","url":"modules/_api_.html#thttpparams","classes":"tsd-kind-type-alias tsd-parent-kind-external-module","parent":"\"Api\""},{"id":40,"kind":4194304,"name":"TFields","url":"modules/_api_.html#tfields","classes":"tsd-kind-type-alias tsd-parent-kind-external-module","parent":"\"Api\""},{"id":41,"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":42,"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":43,"kind":2097152,"name":"ResponseHandler","url":"modules/_api_.html#responsehandler","classes":"tsd-kind-object-literal tsd-parent-kind-external-module tsd-is-not-exported","parent":"\"Api\""},{"id":44,"kind":64,"name":"success","url":"modules/_api_.html#responsehandler.success","classes":"tsd-kind-function tsd-parent-kind-object-literal tsd-is-not-exported","parent":"\"Api\".ResponseHandler"},{"id":45,"kind":64,"name":"failure","url":"modules/_api_.html#responsehandler.failure","classes":"tsd-kind-function tsd-parent-kind-object-literal tsd-is-not-exported","parent":"\"Api\".ResponseHandler"},{"id":46,"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 9fad6f1f..7554382c 100644 --- a/docs/classes/_api_.api.html +++ b/docs/classes/_api_.api.html @@ -156,7 +156,7 @@

constructor

  • Parameters

    @@ -178,7 +178,7 @@

    _httpOptions

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

    _httpParams

    _httpParams: THttpParams
    @@ -205,7 +205,7 @@

    clearApiKey

  • @@ -234,7 +234,7 @@

    copy

  • @@ -287,7 +287,7 @@

    count

  • @@ -320,13 +320,13 @@

    Returns Promise

    create

      -
    • create(objCode: string, params: object, fields?: TFields): Promise<any>
      • +
    • create(objCode: string, params: any, fields?: TFields): Promise<any>
    • @@ -348,7 +348,7 @@
      objCode: string
    • -
      params: object
      +
      params: any

      Values of fields to be set for the new object. See Workfront API Explorer for the list of available fields for the given objCode.

      @@ -366,13 +366,13 @@

      Returns Promise

      edit

        -
      • edit(objCode: string, objID: string, updates: object, fields?: TFields): Promise<any>
        • +
      • edit(objCode: string, objID: string, updates: any, fields?: TFields): Promise<any>
      • @@ -400,7 +400,7 @@
        objID: string
      • -
        updates: object
        +
        updates: any

        Which fields to set. See Workfront API Explorer for the list of available fields for the given objCode.

        @@ -424,7 +424,7 @@

        execute

      • @@ -476,7 +476,7 @@

        get

      • @@ -525,7 +525,7 @@

        getApiKey

      • @@ -568,7 +568,7 @@

        login

      • @@ -612,7 +612,7 @@

        logout

      • @@ -640,7 +640,7 @@

        metadata

      • @@ -674,7 +674,7 @@

        namedQuery

      • @@ -726,7 +726,7 @@

        remove

      • @@ -772,7 +772,7 @@

        report

      • @@ -815,16 +815,32 @@

        request

      • +
        +
        +

        Do the request using Fetch API.

        +
        +
        +
        memberof
        +

        Api

        +
        +
        +

        Parameters

        • path: string
          +
          +

          URI path where the request calls

          +
        • params: THttpParams
          +
          +

          An object with params

          +
        • Optional fields: TFields
          @@ -834,6 +850,7 @@
          Default value method:

        Returns Promise<any>

        +

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

      @@ -847,7 +864,7 @@

      search

    • @@ -890,7 +907,7 @@

      setApiKey

    • @@ -924,7 +941,7 @@

      setSessionID

    • @@ -960,7 +977,7 @@

      uploadFileContent

    • Parameters

      @@ -986,7 +1003,7 @@

      uploadFromStream

    • @@ -1036,7 +1053,7 @@

      Static Methods

      Methods: object
      @@ -1045,7 +1062,7 @@

      DELETE

      DELETE: string = "DELETE"
      @@ -1055,7 +1072,7 @@

      GET

      GET: string = "GET"
      @@ -1065,7 +1082,7 @@

      POST

      POST: string = "POST"
      @@ -1075,7 +1092,7 @@

      PUT

      PUT: string = "PUT"
      @@ -1191,6 +1208,9 @@

      PUT

    • GlobalScope
      • +
    • + queryStringify +
    • ResponseHandler
      • diff --git a/docs/interfaces/_api_.ihttpoptions.html b/docs/interfaces/_api_.ihttpoptions.html index f36cc148..0be6ee81 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
      @@ -131,7 +131,7 @@

      Optional method

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

      Optional path

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

      url

      url: string
      @@ -209,6 +209,9 @@

      url

    • GlobalScope
      • +
    • + queryStringify +
    • ResponseHandler
      • diff --git a/docs/modules/_api_.html b/docs/modules/_api_.html index 1e4774c2..3d77c68c 100644 --- a/docs/modules/_api_.html +++ b/docs/modules/_api_.html @@ -109,6 +109,12 @@

      Variables

    • GlobalScope

    +
    +

    Functions

    + +

    Object literals

      @@ -126,7 +132,7 @@

      TFields

      TFields: string | string[]
    @@ -136,7 +142,7 @@

    THttpParams

    THttpParams: any
    @@ -149,11 +155,37 @@

    GlobalScope

    GlobalScope: any = Function('return this')()
    +
    +

    Functions

    +
    + +

    queryStringify

    +
      +
    • queryStringify(params: any): string
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        params: any
        +
        • +
      +

      Returns string

      +
      • +
    +
    +

    Object literals

    @@ -162,7 +194,7 @@

    ResponseHandler

    ResponseHandler: object
    @@ -175,7 +207,7 @@

    failure

  • Parameters

    @@ -198,7 +230,7 @@

    success

  • Parameters

    @@ -245,6 +277,9 @@

    Returns any GlobalScope

    • +
  • + queryStringify +
  • ResponseHandler
    • diff --git a/package.json b/package.json index 86e407f4..f758df6b 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "workfront-api", - "version": "3.0.3", + "version": "4.0.0-0", "description": "A Workfront API for the Node.js and the Web", "main": "dist/workfront.js", "module": "es/index.js",