diff --git a/CHANGELOG.md b/CHANGELOG.md index eb1b022..f4ba292 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,10 @@ +## 0.26.0 (2023-09-01) + +* release version 0.26.0 ([6da1291](https://github.com/entrecode/ec.sdk/commit/6da1291)) +* feat: account clients with new properties ([346831f](https://github.com/entrecode/ec.sdk/commit/346831f)) + + + ## 0.25.1 (2022-12-19) * bump superagent ([dec4506](https://github.com/entrecode/ec.sdk/commit/dec4506)) diff --git a/docs/index.html b/docs/index.html index 90ae437..ade52eb 100644 --- a/docs/index.html +++ b/docs/index.html @@ -2,7 +2,7 @@ - ec.sdk 0.25.1 | Documentation + ec.sdk 0.26.0 | Documentation @@ -15,7 +15,7 @@

ec.sdk

-
0.25.1
+
0.26.0
ec.sdk +
  • + DMAuthTokenResource + + + +
  • + + +
  • + DMAuthTokenList + + + +
  • + +
  • @@ -3304,26 +3324,6 @@

    ec.sdk

  • - -
  • - DMAuthTokenResource - - - -
  • - - -
  • - DMAuthTokenList - - - -
  • -
    @@ -6450,6 +6450,43 @@

    +
    Example
    + + +
    const accounts = new Accounts();
    +
    +const publicClient = await accounts.createClient({
    +  clientID: 'my-public-client',
    +  clientName: 'A public client for web applications',
    +  grantTypes: ['authorization_code', 'refresh_token'],
    +  tokenEndpointAuthMethod: 'none',
    +  redirectURIs: ['https://my.app.com/redirect'],
    +  postLogoutRedirectURIs: ['https://my.app.com/logout'],
    +  authUIOrigin: 'https://login.entrecode.de',
    +  logoURI: 'https://entrecode.de/de/assets/ec-logo.svg'
    +});
    +
    +const confidentialClient = await accounts.createClient({
    +  clientID: 'my-private-client',
    +  clientName: 'A confidential client for server side applications',
    +  grantTypes: ['authorization_code', 'refresh_token'],
    +  tokenEndpointAuthMethod: 'client_secret_basic',
    +  clientSecret: 'my-secret',
    +  redirectURIs: ['https://my.app.com/redirect'],
    +  postLogoutRedirectURIs: ['https://my.app.com/logout'],
    +  authUIOrigin: 'https://login.entrecode.de',
    +  logoURI: 'https://entrecode.de/de/assets/ec-logo.svg'
    +});
    +
    +const apiClient = await accounts.createClient({
    +  clientID: 'my-api-client',
    +  clientName: 'A client for API access',
    +  grantTypes: ['client_credentials'],
    +  tokenEndpointAuthMethod: 'client_secret_basic',
    +  clientSecret: 'my-secret',
    +});
    + + @@ -18586,18 +18623,99 @@

    : The id of the client +

    + +
    + created (Date) + : The +Date + on which this client was created, is set on creation + + +
    + +
    + modified (Date) + : The +Date + on which this client was last modified, is set on updates + + +
    + +
    + clientName (string) + : The name of the client (human readable) + + +
    + +
    + clientType (("Public Client" | "Private Client" | "API Client" | "Legacy Client" | "Unknown Client")) + : The type of the client, computed depending on settings + + +
    + +
    + grantTypes (Array<("authorization_code" | "refresh_token" | "client_credentials")>) + : The grant types of the client + + +
    + +
    + tokenEndpointAuthMethod (("client_secret_basic" | "none")) + : The token endpoint authentication method of the client + + +
    + +
    + clientSecret (string) + : The client secret - set only if grantTypes contains 'client_credentials' + + +
    + +
    + redirectURIs (Array<string>) + : The redirect URIs of the client + + +
    + +
    + postLogoutRedirectURIs (Array<string>) + : The post logout redirect URIs of the client + + +
    + +
    + authUIOrigin (string) + : The auth UI origin of the client + + +
    + +
    + logoURI (string) + : The logo URI of the client + +
    callbackURL (string) - : callback URL + : The legacy client callback URL
    config (clientConfig) - : The config + : The legacy client config
    @@ -18638,7 +18756,7 @@

    -

    Configuration of a client

    +

    Configuration of a legacy client

    clientConfig
    @@ -28448,6 +28566,224 @@

    + + + + + +
    + + +
    + +

    + DMAuthTokenResource +

    + + +
    + + +

    DMAuthToken resource class

    + +
    new DMAuthTokenResource(resource: object, environment: string, traversal: object?)
    + + +

    + Extends + + Resource_1.default + +

    + + + + + + + + + + +
    Parameters
    +
    + +
    +
    + resource (object) + resource loaded from the API. + +
    + +
    + +
    +
    + environment (string) + the environment this resource is associated to. + +
    + +
    + +
    +
    + traversal (object?) + traversal from which traverson can continue. + +
    + +
    + +
    + + + +
    Properties
    +
    + +
    + created (Date) + : "issued at" date + + +
    + +
    + validUntil (Date) + : expiration date of the token + + +
    + +
    + near (string) + : IP Address Location + + +
    + +
    + device (string) + : Device Information + + +
    + +
    + isCurrent (boolean) + : true if this is the currently active token + + +
    + +
    + + + + + + + + + + + + + + + + + +
    + + + + +
    + + +
    + +

    + DMAuthTokenList +

    + + +
    + + +

    Tag list resource class.

    + +
    new DMAuthTokenList(resource: object, environment: string, traversal: object?)
    + + +

    + Extends + + ListResource_1.default + +

    + + + + + + + + + + +
    Parameters
    +
    + +
    +
    + resource (object) + resource loaded from the API. + +
    + +
    + +
    +
    + environment (string) + the environment this resource is associated to. + +
    + +
    + +
    +
    + traversal (object?) + traversal from which traverson can continue. + +
    + +
    + +
    + + + + + + + + + + + + + + + + + + +
    @@ -35914,7 +36250,12 @@

    -

    0.25.1 (2022-12-19)

    +

    0.26.0 (2023-09-01)

    + +

    0.25.1 (2022-12-19)