picked 0.0.107-next.4 → 0.0.107-next.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -0,0 +1,110 @@
|
|
|
1
|
+
---
|
|
2
|
+
type: reference
|
|
3
|
+
layout: docs
|
|
4
|
+
generated: true
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Analytics sign in schema
|
|
8
|
+
|
|
9
|
+
See [Management API schema](/reference/management-api/schema) for every domain, the endpoint and authentication.
|
|
10
|
+
|
|
11
|
+
## Mutations
|
|
12
|
+
|
|
13
|
+
### `analyticsSignInTokenCreate`
|
|
14
|
+
|
|
15
|
+
Creates a short-lived token that signs the current user into analytics for an organization.
|
|
16
|
+
Refuses tokens issued to OAuth clients.
|
|
17
|
+
Scope: `ORGANIZATION_REPORTS_READ`.
|
|
18
|
+
|
|
19
|
+
```graphql
|
|
20
|
+
analyticsSignInTokenCreate(input: AnalyticsSignInTokenCreateInput!): AnalyticsSignInTokenCreatePayload! @auth(only: USER)
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
### `organizationAnalyticsProvision`
|
|
24
|
+
|
|
25
|
+
Sets analytics up for an organization: everything the organization's members need to sign
|
|
26
|
+
into analytics. Running it again sets up only what is missing.
|
|
27
|
+
Scope: `ORGANIZATION_REPORTS_READ`.
|
|
28
|
+
|
|
29
|
+
```graphql
|
|
30
|
+
organizationAnalyticsProvision(input: OrganizationAnalyticsProvisionInput!): OrganizationAnalyticsProvisionPayload! @auth(only: USER)
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
## Types
|
|
34
|
+
|
|
35
|
+
### `AnalyticsSignInTokenCreateInput`
|
|
36
|
+
|
|
37
|
+
```graphql
|
|
38
|
+
"""The input of `analyticsSignInTokenCreate`."""
|
|
39
|
+
input AnalyticsSignInTokenCreateInput {
|
|
40
|
+
"""The ID of the organization whose reports the user opens."""
|
|
41
|
+
organizationId: ID!
|
|
42
|
+
}
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
### `AnalyticsSignInTokenCreatePayload`
|
|
46
|
+
|
|
47
|
+
```graphql
|
|
48
|
+
"""The result of `analyticsSignInTokenCreate`."""
|
|
49
|
+
type AnalyticsSignInTokenCreatePayload {
|
|
50
|
+
"""
|
|
51
|
+
The signed token analytics accepts in exchange for a session. It expires after five minutes.
|
|
52
|
+
"""
|
|
53
|
+
token: String!
|
|
54
|
+
}
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
### `AnalyticsProvisioningStatus`
|
|
58
|
+
|
|
59
|
+
```graphql
|
|
60
|
+
"""Whether an organization's members can sign into analytics."""
|
|
61
|
+
enum AnalyticsProvisioningStatus {
|
|
62
|
+
"""Analytics is still being set up for the organization."""
|
|
63
|
+
PENDING
|
|
64
|
+
"""Members can sign into analytics."""
|
|
65
|
+
READY
|
|
66
|
+
"""
|
|
67
|
+
The last attempt to set analytics up failed. Running `organizationAnalyticsProvision` retries it.
|
|
68
|
+
"""
|
|
69
|
+
FAILED
|
|
70
|
+
}
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
### `OrganizationAnalyticsProvisioning`
|
|
74
|
+
|
|
75
|
+
```graphql
|
|
76
|
+
"""How far analytics is set up for an organization."""
|
|
77
|
+
type OrganizationAnalyticsProvisioning {
|
|
78
|
+
"""The organization's status."""
|
|
79
|
+
status: AnalyticsProvisioningStatus!
|
|
80
|
+
}
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
### `Organization` (extension)
|
|
84
|
+
|
|
85
|
+
```graphql
|
|
86
|
+
extend type Organization {
|
|
87
|
+
"""How far analytics is set up for the organization."""
|
|
88
|
+
analyticsProvisioning: OrganizationAnalyticsProvisioning!
|
|
89
|
+
}
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
### `OrganizationAnalyticsProvisionInput`
|
|
93
|
+
|
|
94
|
+
```graphql
|
|
95
|
+
"""The input of `organizationAnalyticsProvision`."""
|
|
96
|
+
input OrganizationAnalyticsProvisionInput {
|
|
97
|
+
"""The ID of the organization to set analytics up for."""
|
|
98
|
+
organizationId: ID!
|
|
99
|
+
}
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
### `OrganizationAnalyticsProvisionPayload`
|
|
103
|
+
|
|
104
|
+
```graphql
|
|
105
|
+
"""The result of `organizationAnalyticsProvision`."""
|
|
106
|
+
type OrganizationAnalyticsProvisionPayload {
|
|
107
|
+
"""How far analytics is set up after the attempt."""
|
|
108
|
+
analyticsProvisioning: OrganizationAnalyticsProvisioning!
|
|
109
|
+
}
|
|
110
|
+
```
|
|
@@ -29,6 +29,7 @@ An operation with `@auth` needs a caller that has authenticated. `@auth(only: US
|
|
|
29
29
|
| [`actionDelete`](/reference/management-api/schema/action#actiondelete) | Mutation | Deletes an action and the workflow it starts. An action that an experience references is not deleted, and comes back as an `IN_USE` user error. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
|
|
30
30
|
| [`actions`](/reference/management-api/schema/action#actions) | Query | Lists the actions in a workspace. `search` matches a case-insensitive substring of the name; `sortKey` and `reverse` set the order. Scope: `ORGANIZATION_WORKSPACE_READ`. |
|
|
31
31
|
| [`actionUpdate`](/reference/management-api/schema/action#actionupdate) | Mutation | Updates an action. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
|
|
32
|
+
| [`analyticsSignInTokenCreate`](/reference/management-api/schema/analytics-sign-in#analyticssignintokencreate) | Mutation | Creates a short-lived token that signs the current user into analytics for an organization. Refuses tokens issued to OAuth clients. Scope: `ORGANIZATION_REPORTS_READ`. |
|
|
32
33
|
| [`apiKeyCreate`](/reference/management-api/schema/api-key#apikeycreate) | Mutation | Creates an API key and returns the full key, once. A blank name, no scopes, or a scope the caller does not hold or the key cannot carry returns `VALIDATION_ERROR`. Scope: `ORGANIZATION_API_KEYS_CREATE`. |
|
|
33
34
|
| [`apiKeyRevoke`](/reference/management-api/schema/api-key#apikeyrevoke) | Mutation | Revokes an API key, which then stops authenticating at once. Cannot be undone; an unknown or revoked key returns `NOT_FOUND`. Scope: `ORGANIZATION_API_KEYS_DELETE`. |
|
|
34
35
|
| [`apiKeys`](/reference/management-api/schema/api-key#apikeys) | Query | Lists an organisation's API keys, newest first. Revoked keys are left out. Scope: `ORGANIZATION_API_KEYS_READ`. |
|
|
@@ -121,6 +122,7 @@ An operation with `@auth` needs a caller that has authenticated. `@auth(only: US
|
|
|
121
122
|
| [`oauthConsentDeny`](/reference/management-api/schema/auth#oauthconsentdeny) | Mutation | Denies an OAuth authorisation request for the signed-in user. |
|
|
122
123
|
| [`oauthConsentDetails`](/reference/management-api/schema/auth#oauthconsentdetails) | Query | Reads an OAuth authorisation request waiting for the signed-in user's consent. Reading a request the user already consented to approves it. |
|
|
123
124
|
| [`organization`](/reference/management-api/schema/organization#organization) | Query | Reads an organisation by ID or slug. Null when no organisation matches. Scope: `ORGANIZATION_READ`. |
|
|
125
|
+
| [`organizationAnalyticsProvision`](/reference/management-api/schema/analytics-sign-in#organizationanalyticsprovision) | Mutation | Sets analytics up for an organization: everything the organization's members need to sign into analytics. Running it again sets up only what is missing. Scope: `ORGANIZATION_REPORTS_READ`. |
|
|
124
126
|
| [`organizationClientManagerScopesUpdate`](/reference/management-api/schema/organization#organizationclientmanagerscopesupdate) | Mutation | Sets the scopes a client manager holds in one organisation. The caller cannot edit their own scopes, and a client manager can add or remove only scopes they hold there themselves. Scope: `STAFF_INVITE_CLIENT_MANAGER`. |
|
|
125
127
|
| [`organizationCreate`](/reference/management-api/schema/organization#organizationcreate) | Mutation | Creates an organisation owned by the calling user. Scope: `ORGANIZATION_CREATE`. |
|
|
126
128
|
| [`organizationDelete`](/reference/management-api/schema/organization#organizationdelete) | Mutation | Deletes an organisation. Scope: `ORGANIZATION_DELETE`. |
|
|
@@ -212,6 +214,7 @@ An operation with `@auth` needs a caller that has authenticated. `@auth(only: US
|
|
|
212
214
|
|
|
213
215
|
- [Action](/reference/management-api/schema/action)
|
|
214
216
|
- [Analytics session](/reference/management-api/schema/analytics-session)
|
|
217
|
+
- [Analytics sign in](/reference/management-api/schema/analytics-sign-in)
|
|
215
218
|
- [Analytics](/reference/management-api/schema/analytics)
|
|
216
219
|
- [Api key](/reference/management-api/schema/api-key)
|
|
217
220
|
- [Auth](/reference/management-api/schema/auth)
|
package/package.json
CHANGED
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "picked",
|
|
3
3
|
"description": "The Picked SDK front door: the client, the picked.config helpers, and the picked CLI in one install",
|
|
4
|
-
"version": "0.0.107-next.
|
|
4
|
+
"version": "0.0.107-next.5",
|
|
5
5
|
"bin": {
|
|
6
6
|
"picked": "dist/esm/bin.js"
|
|
7
7
|
},
|
|
8
8
|
"dependencies": {
|
|
9
|
-
"@picked/cli": "0.0.107-next.
|
|
10
|
-
"@picked/config": "0.0.107-next.
|
|
9
|
+
"@picked/cli": "0.0.107-next.5",
|
|
10
|
+
"@picked/config": "0.0.107-next.5"
|
|
11
11
|
},
|
|
12
12
|
"devDependencies": {
|
|
13
13
|
"@picked/client": "workspace:*",
|
|
@@ -64,7 +64,7 @@
|
|
|
64
64
|
"main": "./dist/cjs/index.js",
|
|
65
65
|
"module": "./dist/esm/index.js",
|
|
66
66
|
"peerDependencies": {
|
|
67
|
-
"@picked/client": "0.0.107-next.
|
|
67
|
+
"@picked/client": "0.0.107-next.5"
|
|
68
68
|
},
|
|
69
69
|
"private": false,
|
|
70
70
|
"publishConfig": {
|