- AddItems - Add Collection item
- Create - Create Collection
- Delete - Delete Collection
- DeleteItem - Delete Collection item
- Update - Update Collection
- UpdateItem - Update Collection item
- Retrieve - Read Collection
- List - List Collections
Add items to a Collection.
package main
import(
"context"
"os"
apiclientgo "github.com/gleanwork/api-client-go"
"github.com/gleanwork/api-client-go/models/components"
"log"
)
func main() {
ctx := context.Background()
s := apiclientgo.New(
apiclientgo.WithSecurity(os.Getenv("GLEAN_API_TOKEN")),
)
res, err := s.Client.Collections.AddItems(ctx, components.AddCollectionItemsRequest{
CollectionID: 7742.68,
}, nil)
if err != nil {
log.Fatal(err)
}
if res.AddCollectionItemsResponse != nil {
// handle response
}
}| Parameter | Type | Required | Description |
|---|---|---|---|
ctx |
context.Context | ✔️ | The context to use for the request. |
addCollectionItemsRequest |
components.AddCollectionItemsRequest | ✔️ | Data describing the add operation. |
locale |
*string |
➖ | The client's preferred locale in rfc5646 format (e.g. en, ja, pt-BR). If omitted, the Accept-Language will be used. If not present or not supported, defaults to the closest match or en. |
opts |
[]operations.Option | ➖ | The options for this request. |
*operations.AddcollectionitemsResponse, error
| Error Type | Status Code | Content Type |
|---|---|---|
| apierrors.APIError | 4XX, 5XX | */* |
Create a publicly visible (empty) Collection of documents.
package main
import(
"context"
"os"
apiclientgo "github.com/gleanwork/api-client-go"
"github.com/gleanwork/api-client-go/models/components"
"github.com/gleanwork/api-client-go/types"
"log"
"github.com/gleanwork/api-client-go/models/operations"
)
func main() {
ctx := context.Background()
s := apiclientgo.New(
apiclientgo.WithSecurity(os.Getenv("GLEAN_API_TOKEN")),
)
res, err := s.Client.Collections.Create(ctx, components.CreateCollectionRequest{
Name: "<value>",
AddedRoles: []components.UserRoleSpecification{
components.UserRoleSpecification{
Person: &components.Person{
Name: "George Clooney",
ObfuscatedID: "abc123",
RelatedDocuments: []components.RelatedDocuments{
components.RelatedDocuments{
QuerySuggestion: &components.QuerySuggestion{
Query: "app:github type:pull author:mortimer",
SearchProviderInfo: &components.SearchProviderInfo{
Name: apiclientgo.Pointer("Google"),
SearchLinkURLTemplate: apiclientgo.Pointer("https://www.google.com/search?q={query}&hl=en"),
},
Label: apiclientgo.Pointer("Mortimer's PRs"),
Datasource: apiclientgo.Pointer("github"),
RequestOptions: &components.SearchRequestOptions{
DatasourceFilter: apiclientgo.Pointer("JIRA"),
DatasourcesFilter: []string{
"JIRA",
},
QueryOverridesFacetFilters: apiclientgo.Pointer(true),
FacetFilters: []components.FacetFilter{
components.FacetFilter{
FieldName: apiclientgo.Pointer("type"),
Values: []components.FacetFilterValue{
components.FacetFilterValue{
Value: apiclientgo.Pointer("Spreadsheet"),
RelationType: components.RelationTypeEquals.ToPointer(),
},
components.FacetFilterValue{
Value: apiclientgo.Pointer("Presentation"),
RelationType: components.RelationTypeEquals.ToPointer(),
},
},
},
},
FacetFilterSets: []components.FacetFilterSet{
components.FacetFilterSet{
Filters: []components.FacetFilter{
components.FacetFilter{
FieldName: apiclientgo.Pointer("type"),
Values: []components.FacetFilterValue{
components.FacetFilterValue{
Value: apiclientgo.Pointer("Spreadsheet"),
RelationType: components.RelationTypeEquals.ToPointer(),
},
components.FacetFilterValue{
Value: apiclientgo.Pointer("Presentation"),
RelationType: components.RelationTypeEquals.ToPointer(),
},
},
},
},
},
components.FacetFilterSet{
Filters: []components.FacetFilter{
components.FacetFilter{
FieldName: apiclientgo.Pointer("type"),
Values: []components.FacetFilterValue{
components.FacetFilterValue{
Value: apiclientgo.Pointer("Spreadsheet"),
RelationType: components.RelationTypeEquals.ToPointer(),
},
components.FacetFilterValue{
Value: apiclientgo.Pointer("Presentation"),
RelationType: components.RelationTypeEquals.ToPointer(),
},
},
},
},
},
components.FacetFilterSet{
Filters: []components.FacetFilter{
components.FacetFilter{
FieldName: apiclientgo.Pointer("type"),
Values: []components.FacetFilterValue{
components.FacetFilterValue{
Value: apiclientgo.Pointer("Spreadsheet"),
RelationType: components.RelationTypeEquals.ToPointer(),
},
components.FacetFilterValue{
Value: apiclientgo.Pointer("Presentation"),
RelationType: components.RelationTypeEquals.ToPointer(),
},
},
},
},
},
},
FacetBucketSize: 977077,
AuthTokens: []components.AuthToken{
components.AuthToken{
AccessToken: "123abc",
Datasource: "gmail",
Scope: apiclientgo.Pointer("email profile https://www.googleapis.com/auth/gmail.readonly"),
TokenType: apiclientgo.Pointer("Bearer"),
AuthUser: apiclientgo.Pointer("1"),
},
},
},
Ranges: []components.TextRange{
components.TextRange{
StartIndex: 86650,
Document: &components.Document{
Metadata: &components.DocumentMetadata{
Datasource: apiclientgo.Pointer("datasource"),
ObjectType: apiclientgo.Pointer("Feature Request"),
Container: apiclientgo.Pointer("container"),
ParentID: apiclientgo.Pointer("JIRA_EN-1337"),
MimeType: apiclientgo.Pointer("mimeType"),
DocumentID: apiclientgo.Pointer("documentId"),
CreateTime: types.MustNewTimeFromString("2000-01-23T04:56:07.000Z"),
UpdateTime: types.MustNewTimeFromString("2000-01-23T04:56:07.000Z"),
Components: []string{
"Backend",
"Networking",
},
Status: apiclientgo.Pointer("[\"Done\"]"),
Pins: []components.PinDocument{
components.PinDocument{
AudienceFilters: []components.FacetFilter{
components.FacetFilter{
FieldName: apiclientgo.Pointer("type"),
Values: []components.FacetFilterValue{
components.FacetFilterValue{
Value: apiclientgo.Pointer("Spreadsheet"),
RelationType: components.RelationTypeEquals.ToPointer(),
},
components.FacetFilterValue{
Value: apiclientgo.Pointer("Presentation"),
RelationType: components.RelationTypeEquals.ToPointer(),
},
},
},
},
DocumentID: "<id>",
},
},
Collections: []components.Collection{
components.Collection{
Name: "<value>",
Description: "meaty dial elegantly while react",
AudienceFilters: []components.FacetFilter{
components.FacetFilter{
FieldName: apiclientgo.Pointer("type"),
Values: []components.FacetFilterValue{
components.FacetFilterValue{
Value: apiclientgo.Pointer("Spreadsheet"),
RelationType: components.RelationTypeEquals.ToPointer(),
},
components.FacetFilterValue{
Value: apiclientgo.Pointer("Presentation"),
RelationType: components.RelationTypeEquals.ToPointer(),
},
},
},
},
ID: 854591,
Items: []components.CollectionItem{
components.CollectionItem{
CollectionID: 697663,
Shortcut: &components.Shortcut{
InputAlias: "<value>",
},
ItemType: components.CollectionItemItemTypeText,
},
components.CollectionItem{
CollectionID: 697663,
Shortcut: &components.Shortcut{
InputAlias: "<value>",
},
ItemType: components.CollectionItemItemTypeText,
},
components.CollectionItem{
CollectionID: 697663,
Shortcut: &components.Shortcut{
InputAlias: "<value>",
},
ItemType: components.CollectionItemItemTypeText,
},
},
},
},
Interactions: &components.DocumentInteractions{
Reacts: []components.Reaction{
components.Reaction{},
components.Reaction{},
},
Shares: []components.Share{
components.Share{
NumDaysAgo: 365776,
},
components.Share{
NumDaysAgo: 365776,
},
components.Share{
NumDaysAgo: 365776,
},
},
},
Verification: &components.Verification{
State: components.StateDeprecated,
Metadata: &components.VerificationMetadata{
Reminders: []components.Reminder{
components.Reminder{
Assignee: components.Person{
Name: "George Clooney",
ObfuscatedID: "abc123",
},
RemindAt: 268615,
},
},
LastReminder: &components.Reminder{
Assignee: components.Person{
Name: "George Clooney",
ObfuscatedID: "abc123",
},
RemindAt: 423482,
},
},
},
Shortcuts: []components.Shortcut{
components.Shortcut{
InputAlias: "<value>",
},
components.Shortcut{
InputAlias: "<value>",
},
components.Shortcut{
InputAlias: "<value>",
},
},
CustomData: map[string]components.CustomDataValue{
"someCustomField": components.CustomDataValue{},
},
},
},
},
},
InputDetails: &components.SearchRequestInputDetails{
HasCopyPaste: apiclientgo.Pointer(true),
},
},
Results: []components.SearchResult{
components.SearchResult{
Title: apiclientgo.Pointer("title"),
URL: "https://example.com/foo/bar",
NativeAppURL: apiclientgo.Pointer("slack://foo/bar"),
Snippets: []components.SearchResultSnippet{
components.SearchResultSnippet{
MimeType: apiclientgo.Pointer("mimeType"),
Snippet: apiclientgo.Pointer("snippet"),
},
},
},
},
},
components.RelatedDocuments{
QuerySuggestion: &components.QuerySuggestion{
Query: "app:github type:pull author:mortimer",
SearchProviderInfo: &components.SearchProviderInfo{
Name: apiclientgo.Pointer("Google"),
SearchLinkURLTemplate: apiclientgo.Pointer("https://www.google.com/search?q={query}&hl=en"),
},
Label: apiclientgo.Pointer("Mortimer's PRs"),
Datasource: apiclientgo.Pointer("github"),
RequestOptions: &components.SearchRequestOptions{
DatasourceFilter: apiclientgo.Pointer("JIRA"),
DatasourcesFilter: []string{
"JIRA",
},
QueryOverridesFacetFilters: apiclientgo.Pointer(true),
FacetFilters: []components.FacetFilter{
components.FacetFilter{
FieldName: apiclientgo.Pointer("type"),
Values: []components.FacetFilterValue{
components.FacetFilterValue{
Value: apiclientgo.Pointer("Spreadsheet"),
RelationType: components.RelationTypeEquals.ToPointer(),
},
components.FacetFilterValue{
Value: apiclientgo.Pointer("Presentation"),
RelationType: components.RelationTypeEquals.ToPointer(),
},
},
},
},
FacetFilterSets: []components.FacetFilterSet{
components.FacetFilterSet{
Filters: []components.FacetFilter{
components.FacetFilter{
FieldName: apiclientgo.Pointer("type"),
Values: []components.FacetFilterValue{
components.FacetFilterValue{
Value: apiclientgo.Pointer("Spreadsheet"),
RelationType: components.RelationTypeEquals.ToPointer(),
},
components.FacetFilterValue{
Value: apiclientgo.Pointer("Presentation"),
RelationType: components.RelationTypeEquals.ToPointer(),
},
},
},
},
},
components.FacetFilterSet{
Filters: []components.FacetFilter{
components.FacetFilter{
FieldName: apiclientgo.Pointer("type"),
Values: []components.FacetFilterValue{
components.FacetFilterValue{
Value: apiclientgo.Pointer("Spreadsheet"),
RelationType: components.RelationTypeEquals.ToPointer(),
},
components.FacetFilterValue{
Value: apiclientgo.Pointer("Presentation"),
RelationType: components.RelationTypeEquals.ToPointer(),
},
},
},
},
},
components.FacetFilterSet{
Filters: []components.FacetFilter{
components.FacetFilter{
FieldName: apiclientgo.Pointer("type"),
Values: []components.FacetFilterValue{
components.FacetFilterValue{
Value: apiclientgo.Pointer("Spreadsheet"),
RelationType: components.RelationTypeEquals.ToPointer(),
},
components.FacetFilterValue{
Value: apiclientgo.Pointer("Presentation"),
RelationType: components.RelationTypeEquals.ToPointer(),
},
},
},
},
},
},
FacetBucketSize: 977077,
AuthTokens: []components.AuthToken{
components.AuthToken{
AccessToken: "123abc",
Datasource: "gmail",
Scope: apiclientgo.Pointer("email profile https://www.googleapis.com/auth/gmail.readonly"),
TokenType: apiclientgo.Pointer("Bearer"),
AuthUser: apiclientgo.Pointer("1"),
},
},
},
Ranges: []components.TextRange{
components.TextRange{
StartIndex: 86650,
Document: &components.Document{
Metadata: &components.DocumentMetadata{
Datasource: apiclientgo.Pointer("datasource"),
ObjectType: apiclientgo.Pointer("Feature Request"),
Container: apiclientgo.Pointer("container"),
ParentID: apiclientgo.Pointer("JIRA_EN-1337"),
MimeType: apiclientgo.Pointer("mimeType"),
DocumentID: apiclientgo.Pointer("documentId"),
CreateTime: types.MustNewTimeFromString("2000-01-23T04:56:07.000Z"),
UpdateTime: types.MustNewTimeFromString("2000-01-23T04:56:07.000Z"),
Components: []string{
"Backend",
"Networking",
},
Status: apiclientgo.Pointer("[\"Done\"]"),
Pins: []components.PinDocument{
components.PinDocument{
AudienceFilters: []components.FacetFilter{
components.FacetFilter{
FieldName: apiclientgo.Pointer("type"),
Values: []components.FacetFilterValue{
components.FacetFilterValue{
Value: apiclientgo.Pointer("Spreadsheet"),
RelationType: components.RelationTypeEquals.ToPointer(),
},
components.FacetFilterValue{
Value: apiclientgo.Pointer("Presentation"),
RelationType: components.RelationTypeEquals.ToPointer(),
},
},
},
},
DocumentID: "<id>",
},
},
Collections: []components.Collection{
components.Collection{
Name: "<value>",
Description: "meaty dial elegantly while react",
AudienceFilters: []components.FacetFilter{
components.FacetFilter{
FieldName: apiclientgo.Pointer("type"),
Values: []components.FacetFilterValue{
components.FacetFilterValue{
Value: apiclientgo.Pointer("Spreadsheet"),
RelationType: components.RelationTypeEquals.ToPointer(),
},
components.FacetFilterValue{
Value: apiclientgo.Pointer("Presentation"),
RelationType: components.RelationTypeEquals.ToPointer(),
},
},
},
},
ID: 854591,
Items: []components.CollectionItem{
components.CollectionItem{
CollectionID: 697663,
Shortcut: &components.Shortcut{
InputAlias: "<value>",
},
ItemType: components.CollectionItemItemTypeText,
},
components.CollectionItem{
CollectionID: 697663,
Shortcut: &components.Shortcut{
InputAlias: "<value>",
},
ItemType: components.CollectionItemItemTypeText,
},
components.CollectionItem{
CollectionID: 697663,
Shortcut: &components.Shortcut{
InputAlias: "<value>",
},
ItemType: components.CollectionItemItemTypeText,
},
},
},
},
Interactions: &components.DocumentInteractions{
Reacts: []components.Reaction{
components.Reaction{},
components.Reaction{},
},
Shares: []components.Share{
components.Share{
NumDaysAgo: 365776,
},
components.Share{
NumDaysAgo: 365776,
},
components.Share{
NumDaysAgo: 365776,
},
},
},
Verification: &components.Verification{
State: components.StateDeprecated,
Metadata: &components.VerificationMetadata{
Reminders: []components.Reminder{
components.Reminder{
Assignee: components.Person{
Name: "George Clooney",
ObfuscatedID: "abc123",
},
RemindAt: 268615,
},
},
LastReminder: &components.Reminder{
Assignee: components.Person{
Name: "George Clooney",
ObfuscatedID: "abc123",
},
RemindAt: 423482,
},
},
},
Shortcuts: []components.Shortcut{
components.Shortcut{
InputAlias: "<value>",
},
components.Shortcut{
InputAlias: "<value>",
},
components.Shortcut{
InputAlias: "<value>",
},
},
CustomData: map[string]components.CustomDataValue{
"someCustomField": components.CustomDataValue{},
},
},
},
},
},
InputDetails: &components.SearchRequestInputDetails{
HasCopyPaste: apiclientgo.Pointer(true),
},
},
Results: []components.SearchResult{
components.SearchResult{
Title: apiclientgo.Pointer("title"),
URL: "https://example.com/foo/bar",
NativeAppURL: apiclientgo.Pointer("slack://foo/bar"),
Snippets: []components.SearchResultSnippet{
components.SearchResultSnippet{
MimeType: apiclientgo.Pointer("mimeType"),
Snippet: apiclientgo.Pointer("snippet"),
},
},
},
},
},
},
Metadata: &components.PersonMetadata{
Type: components.PersonMetadataTypeFullTime.ToPointer(),
Title: apiclientgo.Pointer("Actor"),
Department: apiclientgo.Pointer("Movies"),
Email: apiclientgo.Pointer("george@example.com"),
Location: apiclientgo.Pointer("Hollywood, CA"),
Phone: apiclientgo.Pointer("6505551234"),
PhotoURL: apiclientgo.Pointer("https://example.com/george.jpg"),
StartDate: types.MustNewDateFromString("2000-01-23"),
DatasourceProfile: []components.DatasourceProfile{
components.DatasourceProfile{
Datasource: "github",
Handle: "<value>",
},
components.DatasourceProfile{
Datasource: "github",
Handle: "<value>",
},
},
QuerySuggestions: &components.QuerySuggestionList{
Suggestions: []components.QuerySuggestion{
components.QuerySuggestion{
Query: "app:github type:pull author:mortimer",
Label: apiclientgo.Pointer("Mortimer's PRs"),
Datasource: apiclientgo.Pointer("github"),
},
},
},
InviteInfo: &components.InviteInfo{
Invites: []components.ChannelInviteInfo{
components.ChannelInviteInfo{},
components.ChannelInviteInfo{},
},
},
CustomFields: []components.CustomFieldData{
components.CustomFieldData{
Label: "<value>",
Values: []components.CustomFieldValue{
components.CreateCustomFieldValueCustomFieldValueStr(
components.CustomFieldValueStr{},
),
components.CreateCustomFieldValueCustomFieldValueStr(
components.CustomFieldValueStr{},
),
components.CreateCustomFieldValueCustomFieldValueStr(
components.CustomFieldValueStr{},
),
},
},
components.CustomFieldData{
Label: "<value>",
Values: []components.CustomFieldValue{
components.CreateCustomFieldValueCustomFieldValueStr(
components.CustomFieldValueStr{},
),
components.CreateCustomFieldValueCustomFieldValueStr(
components.CustomFieldValueStr{},
),
components.CreateCustomFieldValueCustomFieldValueStr(
components.CustomFieldValueStr{},
),
},
},
},
Badges: []components.Badge{
components.Badge{
Key: apiclientgo.Pointer("deployment_name_new_hire"),
DisplayName: apiclientgo.Pointer("New hire"),
IconConfig: &components.IconConfig{
Color: apiclientgo.Pointer("#343CED"),
Key: apiclientgo.Pointer("person_icon"),
IconType: components.IconTypeGlyph.ToPointer(),
Name: apiclientgo.Pointer("user"),
},
},
},
},
},
Role: components.UserRoleVerifier,
},
},
RemovedRoles: []components.UserRoleSpecification{
components.UserRoleSpecification{
Person: &components.Person{
Name: "George Clooney",
ObfuscatedID: "abc123",
Metadata: &components.PersonMetadata{
Type: components.PersonMetadataTypeFullTime.ToPointer(),
Title: apiclientgo.Pointer("Actor"),
Department: apiclientgo.Pointer("Movies"),
Email: apiclientgo.Pointer("george@example.com"),
Location: apiclientgo.Pointer("Hollywood, CA"),
Phone: apiclientgo.Pointer("6505551234"),
PhotoURL: apiclientgo.Pointer("https://example.com/george.jpg"),
StartDate: types.MustNewDateFromString("2000-01-23"),
DatasourceProfile: []components.DatasourceProfile{
components.DatasourceProfile{
Datasource: "github",
Handle: "<value>",
},
components.DatasourceProfile{
Datasource: "github",
Handle: "<value>",
},
},
QuerySuggestions: &components.QuerySuggestionList{
Suggestions: []components.QuerySuggestion{
components.QuerySuggestion{
Query: "app:github type:pull author:mortimer",
Label: apiclientgo.Pointer("Mortimer's PRs"),
Datasource: apiclientgo.Pointer("github"),
},
},
},
InviteInfo: &components.InviteInfo{
Invites: []components.ChannelInviteInfo{
components.ChannelInviteInfo{},
components.ChannelInviteInfo{},
},
},
Badges: []components.Badge{
components.Badge{
Key: apiclientgo.Pointer("deployment_name_new_hire"),
DisplayName: apiclientgo.Pointer("New hire"),
IconConfig: &components.IconConfig{
Color: apiclientgo.Pointer("#343CED"),
Key: apiclientgo.Pointer("person_icon"),
IconType: components.IconTypeGlyph.ToPointer(),
Name: apiclientgo.Pointer("user"),
},
},
},
},
},
Role: components.UserRoleViewer,
},
},
AudienceFilters: []components.FacetFilter{
components.FacetFilter{
FieldName: apiclientgo.Pointer("type"),
Values: []components.FacetFilterValue{
components.FacetFilterValue{
Value: apiclientgo.Pointer("Spreadsheet"),
RelationType: components.RelationTypeEquals.ToPointer(),
},
components.FacetFilterValue{
Value: apiclientgo.Pointer("Presentation"),
RelationType: components.RelationTypeEquals.ToPointer(),
},
},
},
},
}, nil)
if err != nil {
log.Fatal(err)
}
if res.OneOf != nil {
switch res.OneOf.Type {
case operations.CreatecollectionResponseBodyTypeResponseBody1:
// res.OneOf.ResponseBody1 is populated
case operations.CreatecollectionResponseBodyTypeResponseBody2:
// res.OneOf.ResponseBody2 is populated
}
}
}| Parameter | Type | Required | Description |
|---|---|---|---|
ctx |
context.Context | ✔️ | The context to use for the request. |
createCollectionRequest |
components.CreateCollectionRequest | ✔️ | Collection content plus any additional metadata for the request. |
locale |
*string |
➖ | The client's preferred locale in rfc5646 format (e.g. en, ja, pt-BR). If omitted, the Accept-Language will be used. If not present or not supported, defaults to the closest match or en. |
opts |
[]operations.Option | ➖ | The options for this request. |
*operations.CreatecollectionResponse, error
| Error Type | Status Code | Content Type |
|---|---|---|
| apierrors.CollectionError | 422 | application/json |
| apierrors.APIError | 4XX, 5XX | */* |
Delete a Collection given the Collection's ID.
package main
import(
"context"
"os"
apiclientgo "github.com/gleanwork/api-client-go"
"github.com/gleanwork/api-client-go/models/components"
"log"
)
func main() {
ctx := context.Background()
s := apiclientgo.New(
apiclientgo.WithSecurity(os.Getenv("GLEAN_API_TOKEN")),
)
res, err := s.Client.Collections.Delete(ctx, components.DeleteCollectionRequest{
Ids: []int64{
930352,
156719,
25102,
},
}, nil)
if err != nil {
log.Fatal(err)
}
if res != nil {
// handle response
}
}| Parameter | Type | Required | Description |
|---|---|---|---|
ctx |
context.Context | ✔️ | The context to use for the request. |
deleteCollectionRequest |
components.DeleteCollectionRequest | ✔️ | DeleteCollection request |
locale |
*string |
➖ | The client's preferred locale in rfc5646 format (e.g. en, ja, pt-BR). If omitted, the Accept-Language will be used. If not present or not supported, defaults to the closest match or en. |
opts |
[]operations.Option | ➖ | The options for this request. |
*operations.DeletecollectionResponse, error
| Error Type | Status Code | Content Type |
|---|---|---|
| apierrors.CollectionError | 422 | application/json |
| apierrors.APIError | 4XX, 5XX | */* |
Delete a single item from a Collection.
package main
import(
"context"
"os"
apiclientgo "github.com/gleanwork/api-client-go"
"github.com/gleanwork/api-client-go/models/components"
"log"
)
func main() {
ctx := context.Background()
s := apiclientgo.New(
apiclientgo.WithSecurity(os.Getenv("GLEAN_API_TOKEN")),
)
res, err := s.Client.Collections.DeleteItem(ctx, components.DeleteCollectionItemRequest{
CollectionID: 6980.49,
ItemID: "<id>",
}, nil)
if err != nil {
log.Fatal(err)
}
if res.DeleteCollectionItemResponse != nil {
// handle response
}
}| Parameter | Type | Required | Description |
|---|---|---|---|
ctx |
context.Context | ✔️ | The context to use for the request. |
deleteCollectionItemRequest |
components.DeleteCollectionItemRequest | ✔️ | Data describing the delete operation. |
locale |
*string |
➖ | The client's preferred locale in rfc5646 format (e.g. en, ja, pt-BR). If omitted, the Accept-Language will be used. If not present or not supported, defaults to the closest match or en. |
opts |
[]operations.Option | ➖ | The options for this request. |
*operations.DeletecollectionitemResponse, error
| Error Type | Status Code | Content Type |
|---|---|---|
| apierrors.APIError | 4XX, 5XX | */* |
Update the properties of an existing Collection.
package main
import(
"context"
"os"
apiclientgo "github.com/gleanwork/api-client-go"
"github.com/gleanwork/api-client-go/models/components"
"github.com/gleanwork/api-client-go/types"
"log"
)
func main() {
ctx := context.Background()
s := apiclientgo.New(
apiclientgo.WithSecurity(os.Getenv("GLEAN_API_TOKEN")),
)
res, err := s.Client.Collections.Update(ctx, components.EditCollectionRequest{
Name: "<value>",
AddedRoles: []components.UserRoleSpecification{
components.UserRoleSpecification{
Person: &components.Person{
Name: "George Clooney",
ObfuscatedID: "abc123",
RelatedDocuments: []components.RelatedDocuments{
components.RelatedDocuments{
QuerySuggestion: &components.QuerySuggestion{
Query: "app:github type:pull author:mortimer",
SearchProviderInfo: &components.SearchProviderInfo{
Name: apiclientgo.Pointer("Google"),
SearchLinkURLTemplate: apiclientgo.Pointer("https://www.google.com/search?q={query}&hl=en"),
},
Label: apiclientgo.Pointer("Mortimer's PRs"),
Datasource: apiclientgo.Pointer("github"),
RequestOptions: &components.SearchRequestOptions{
DatasourceFilter: apiclientgo.Pointer("JIRA"),
DatasourcesFilter: []string{
"JIRA",
},
QueryOverridesFacetFilters: apiclientgo.Pointer(true),
FacetFilters: []components.FacetFilter{
components.FacetFilter{
FieldName: apiclientgo.Pointer("type"),
Values: []components.FacetFilterValue{
components.FacetFilterValue{
Value: apiclientgo.Pointer("Spreadsheet"),
RelationType: components.RelationTypeEquals.ToPointer(),
},
components.FacetFilterValue{
Value: apiclientgo.Pointer("Presentation"),
RelationType: components.RelationTypeEquals.ToPointer(),
},
},
},
},
FacetFilterSets: []components.FacetFilterSet{
components.FacetFilterSet{
Filters: []components.FacetFilter{
components.FacetFilter{
FieldName: apiclientgo.Pointer("type"),
Values: []components.FacetFilterValue{
components.FacetFilterValue{
Value: apiclientgo.Pointer("Spreadsheet"),
RelationType: components.RelationTypeEquals.ToPointer(),
},
components.FacetFilterValue{
Value: apiclientgo.Pointer("Presentation"),
RelationType: components.RelationTypeEquals.ToPointer(),
},
},
},
},
},
components.FacetFilterSet{
Filters: []components.FacetFilter{
components.FacetFilter{
FieldName: apiclientgo.Pointer("type"),
Values: []components.FacetFilterValue{
components.FacetFilterValue{
Value: apiclientgo.Pointer("Spreadsheet"),
RelationType: components.RelationTypeEquals.ToPointer(),
},
components.FacetFilterValue{
Value: apiclientgo.Pointer("Presentation"),
RelationType: components.RelationTypeEquals.ToPointer(),
},
},
},
},
},
},
FacetBucketSize: 797260,
AuthTokens: []components.AuthToken{
components.AuthToken{
AccessToken: "123abc",
Datasource: "gmail",
Scope: apiclientgo.Pointer("email profile https://www.googleapis.com/auth/gmail.readonly"),
TokenType: apiclientgo.Pointer("Bearer"),
AuthUser: apiclientgo.Pointer("1"),
},
},
},
Ranges: []components.TextRange{
components.TextRange{
StartIndex: 932928,
Document: &components.Document{
Metadata: &components.DocumentMetadata{
Datasource: apiclientgo.Pointer("datasource"),
ObjectType: apiclientgo.Pointer("Feature Request"),
Container: apiclientgo.Pointer("container"),
ParentID: apiclientgo.Pointer("JIRA_EN-1337"),
MimeType: apiclientgo.Pointer("mimeType"),
DocumentID: apiclientgo.Pointer("documentId"),
CreateTime: types.MustNewTimeFromString("2000-01-23T04:56:07.000Z"),
UpdateTime: types.MustNewTimeFromString("2000-01-23T04:56:07.000Z"),
Components: []string{
"Backend",
"Networking",
},
Status: apiclientgo.Pointer("[\"Done\"]"),
Pins: []components.PinDocument{
components.PinDocument{
AudienceFilters: []components.FacetFilter{
components.FacetFilter{
FieldName: apiclientgo.Pointer("type"),
Values: []components.FacetFilterValue{
components.FacetFilterValue{
Value: apiclientgo.Pointer("Spreadsheet"),
RelationType: components.RelationTypeEquals.ToPointer(),
},
components.FacetFilterValue{
Value: apiclientgo.Pointer("Presentation"),
RelationType: components.RelationTypeEquals.ToPointer(),
},
},
},
},
DocumentID: "<id>",
},
components.PinDocument{
AudienceFilters: []components.FacetFilter{
components.FacetFilter{
FieldName: apiclientgo.Pointer("type"),
Values: []components.FacetFilterValue{
components.FacetFilterValue{
Value: apiclientgo.Pointer("Spreadsheet"),
RelationType: components.RelationTypeEquals.ToPointer(),
},
components.FacetFilterValue{
Value: apiclientgo.Pointer("Presentation"),
RelationType: components.RelationTypeEquals.ToPointer(),
},
},
},
},
DocumentID: "<id>",
},
},
Collections: []components.Collection{
components.Collection{
Name: "<value>",
Description: "how by extroverted excess kissingly scruple yearningly",
AudienceFilters: []components.FacetFilter{
components.FacetFilter{
FieldName: apiclientgo.Pointer("type"),
Values: []components.FacetFilterValue{
components.FacetFilterValue{
Value: apiclientgo.Pointer("Spreadsheet"),
RelationType: components.RelationTypeEquals.ToPointer(),
},
components.FacetFilterValue{
Value: apiclientgo.Pointer("Presentation"),
RelationType: components.RelationTypeEquals.ToPointer(),
},
},
},
},
ID: 416110,
Items: []components.CollectionItem{
components.CollectionItem{
CollectionID: 959645,
Shortcut: &components.Shortcut{
InputAlias: "<value>",
},
ItemType: components.CollectionItemItemTypeText,
},
components.CollectionItem{
CollectionID: 959645,
Shortcut: &components.Shortcut{
InputAlias: "<value>",
},
ItemType: components.CollectionItemItemTypeText,
},
components.CollectionItem{
CollectionID: 959645,
Shortcut: &components.Shortcut{
InputAlias: "<value>",
},
ItemType: components.CollectionItemItemTypeText,
},
},
},
components.Collection{
Name: "<value>",
Description: "how by extroverted excess kissingly scruple yearningly",
AudienceFilters: []components.FacetFilter{
components.FacetFilter{
FieldName: apiclientgo.Pointer("type"),
Values: []components.FacetFilterValue{
components.FacetFilterValue{
Value: apiclientgo.Pointer("Spreadsheet"),
RelationType: components.RelationTypeEquals.ToPointer(),
},
components.FacetFilterValue{
Value: apiclientgo.Pointer("Presentation"),
RelationType: components.RelationTypeEquals.ToPointer(),
},
},
},
},
ID: 416110,
Items: []components.CollectionItem{
components.CollectionItem{
CollectionID: 959645,
Shortcut: &components.Shortcut{
InputAlias: "<value>",
},
ItemType: components.CollectionItemItemTypeText,
},
components.CollectionItem{
CollectionID: 959645,
Shortcut: &components.Shortcut{
InputAlias: "<value>",
},
ItemType: components.CollectionItemItemTypeText,
},
components.CollectionItem{
CollectionID: 959645,
Shortcut: &components.Shortcut{
InputAlias: "<value>",
},
ItemType: components.CollectionItemItemTypeText,
},
},
},
},
Interactions: &components.DocumentInteractions{
Reacts: []components.Reaction{
components.Reaction{},
components.Reaction{},
components.Reaction{},
},
Shares: []components.Share{
components.Share{
NumDaysAgo: 927933,
},
components.Share{
NumDaysAgo: 927933,
},
components.Share{
NumDaysAgo: 927933,
},
},
},
Verification: &components.Verification{
State: components.StateUnverified,
Metadata: &components.VerificationMetadata{
Reminders: []components.Reminder{
components.Reminder{
Assignee: components.Person{
Name: "George Clooney",
ObfuscatedID: "abc123",
},
RemindAt: 353914,
},
components.Reminder{
Assignee: components.Person{
Name: "George Clooney",
ObfuscatedID: "abc123",
},
RemindAt: 353914,
},
},
LastReminder: &components.Reminder{
Assignee: components.Person{
Name: "George Clooney",
ObfuscatedID: "abc123",
},
RemindAt: 314497,
},
},
},
Shortcuts: []components.Shortcut{
components.Shortcut{
InputAlias: "<value>",
},
components.Shortcut{
InputAlias: "<value>",
},
},
CustomData: map[string]components.CustomDataValue{
"someCustomField": components.CustomDataValue{},
},
},
},
},
},
InputDetails: &components.SearchRequestInputDetails{
HasCopyPaste: apiclientgo.Pointer(true),
},
},
Results: []components.SearchResult{
components.SearchResult{
Title: apiclientgo.Pointer("title"),
URL: "https://example.com/foo/bar",
NativeAppURL: apiclientgo.Pointer("slack://foo/bar"),
Snippets: []components.SearchResultSnippet{
components.SearchResultSnippet{
MimeType: apiclientgo.Pointer("mimeType"),
Snippet: apiclientgo.Pointer("snippet"),
},
},
},
},
},
components.RelatedDocuments{
QuerySuggestion: &components.QuerySuggestion{
Query: "app:github type:pull author:mortimer",
SearchProviderInfo: &components.SearchProviderInfo{
Name: apiclientgo.Pointer("Google"),
SearchLinkURLTemplate: apiclientgo.Pointer("https://www.google.com/search?q={query}&hl=en"),
},
Label: apiclientgo.Pointer("Mortimer's PRs"),
Datasource: apiclientgo.Pointer("github"),
RequestOptions: &components.SearchRequestOptions{
DatasourceFilter: apiclientgo.Pointer("JIRA"),
DatasourcesFilter: []string{
"JIRA",
},
QueryOverridesFacetFilters: apiclientgo.Pointer(true),
FacetFilters: []components.FacetFilter{
components.FacetFilter{
FieldName: apiclientgo.Pointer("type"),
Values: []components.FacetFilterValue{
components.FacetFilterValue{
Value: apiclientgo.Pointer("Spreadsheet"),
RelationType: components.RelationTypeEquals.ToPointer(),
},
components.FacetFilterValue{
Value: apiclientgo.Pointer("Presentation"),
RelationType: components.RelationTypeEquals.ToPointer(),
},
},
},
},
FacetFilterSets: []components.FacetFilterSet{
components.FacetFilterSet{
Filters: []components.FacetFilter{
components.FacetFilter{
FieldName: apiclientgo.Pointer("type"),
Values: []components.FacetFilterValue{
components.FacetFilterValue{
Value: apiclientgo.Pointer("Spreadsheet"),
RelationType: components.RelationTypeEquals.ToPointer(),
},
components.FacetFilterValue{
Value: apiclientgo.Pointer("Presentation"),
RelationType: components.RelationTypeEquals.ToPointer(),
},
},
},
},
},
components.FacetFilterSet{
Filters: []components.FacetFilter{
components.FacetFilter{
FieldName: apiclientgo.Pointer("type"),
Values: []components.FacetFilterValue{
components.FacetFilterValue{
Value: apiclientgo.Pointer("Spreadsheet"),
RelationType: components.RelationTypeEquals.ToPointer(),
},
components.FacetFilterValue{
Value: apiclientgo.Pointer("Presentation"),
RelationType: components.RelationTypeEquals.ToPointer(),
},
},
},
},
},
},
FacetBucketSize: 797260,
AuthTokens: []components.AuthToken{
components.AuthToken{
AccessToken: "123abc",
Datasource: "gmail",
Scope: apiclientgo.Pointer("email profile https://www.googleapis.com/auth/gmail.readonly"),
TokenType: apiclientgo.Pointer("Bearer"),
AuthUser: apiclientgo.Pointer("1"),
},
},
},
Ranges: []components.TextRange{
components.TextRange{
StartIndex: 932928,
Document: &components.Document{
Metadata: &components.DocumentMetadata{
Datasource: apiclientgo.Pointer("datasource"),
ObjectType: apiclientgo.Pointer("Feature Request"),
Container: apiclientgo.Pointer("container"),
ParentID: apiclientgo.Pointer("JIRA_EN-1337"),
MimeType: apiclientgo.Pointer("mimeType"),
DocumentID: apiclientgo.Pointer("documentId"),
CreateTime: types.MustNewTimeFromString("2000-01-23T04:56:07.000Z"),
UpdateTime: types.MustNewTimeFromString("2000-01-23T04:56:07.000Z"),
Components: []string{
"Backend",
"Networking",
},
Status: apiclientgo.Pointer("[\"Done\"]"),
Pins: []components.PinDocument{
components.PinDocument{
AudienceFilters: []components.FacetFilter{
components.FacetFilter{
FieldName: apiclientgo.Pointer("type"),
Values: []components.FacetFilterValue{
components.FacetFilterValue{
Value: apiclientgo.Pointer("Spreadsheet"),
RelationType: components.RelationTypeEquals.ToPointer(),
},
components.FacetFilterValue{
Value: apiclientgo.Pointer("Presentation"),
RelationType: components.RelationTypeEquals.ToPointer(),
},
},
},
},
DocumentID: "<id>",
},
components.PinDocument{
AudienceFilters: []components.FacetFilter{
components.FacetFilter{
FieldName: apiclientgo.Pointer("type"),
Values: []components.FacetFilterValue{
components.FacetFilterValue{
Value: apiclientgo.Pointer("Spreadsheet"),
RelationType: components.RelationTypeEquals.ToPointer(),
},
components.FacetFilterValue{
Value: apiclientgo.Pointer("Presentation"),
RelationType: components.RelationTypeEquals.ToPointer(),
},
},
},
},
DocumentID: "<id>",
},
},
Collections: []components.Collection{
components.Collection{
Name: "<value>",
Description: "how by extroverted excess kissingly scruple yearningly",
AudienceFilters: []components.FacetFilter{
components.FacetFilter{
FieldName: apiclientgo.Pointer("type"),
Values: []components.FacetFilterValue{
components.FacetFilterValue{
Value: apiclientgo.Pointer("Spreadsheet"),
RelationType: components.RelationTypeEquals.ToPointer(),
},
components.FacetFilterValue{
Value: apiclientgo.Pointer("Presentation"),
RelationType: components.RelationTypeEquals.ToPointer(),
},
},
},
},
ID: 416110,
Items: []components.CollectionItem{
components.CollectionItem{
CollectionID: 959645,
Shortcut: &components.Shortcut{
InputAlias: "<value>",
},
ItemType: components.CollectionItemItemTypeText,
},
components.CollectionItem{
CollectionID: 959645,
Shortcut: &components.Shortcut{
InputAlias: "<value>",
},
ItemType: components.CollectionItemItemTypeText,
},
components.CollectionItem{
CollectionID: 959645,
Shortcut: &components.Shortcut{
InputAlias: "<value>",
},
ItemType: components.CollectionItemItemTypeText,
},
},
},
components.Collection{
Name: "<value>",
Description: "how by extroverted excess kissingly scruple yearningly",
AudienceFilters: []components.FacetFilter{
components.FacetFilter{
FieldName: apiclientgo.Pointer("type"),
Values: []components.FacetFilterValue{
components.FacetFilterValue{
Value: apiclientgo.Pointer("Spreadsheet"),
RelationType: components.RelationTypeEquals.ToPointer(),
},
components.FacetFilterValue{
Value: apiclientgo.Pointer("Presentation"),
RelationType: components.RelationTypeEquals.ToPointer(),
},
},
},
},
ID: 416110,
Items: []components.CollectionItem{
components.CollectionItem{
CollectionID: 959645,
Shortcut: &components.Shortcut{
InputAlias: "<value>",
},
ItemType: components.CollectionItemItemTypeText,
},
components.CollectionItem{
CollectionID: 959645,
Shortcut: &components.Shortcut{
InputAlias: "<value>",
},
ItemType: components.CollectionItemItemTypeText,
},
components.CollectionItem{
CollectionID: 959645,
Shortcut: &components.Shortcut{
InputAlias: "<value>",
},
ItemType: components.CollectionItemItemTypeText,
},
},
},
},
Interactions: &components.DocumentInteractions{
Reacts: []components.Reaction{
components.Reaction{},
components.Reaction{},
components.Reaction{},
},
Shares: []components.Share{
components.Share{
NumDaysAgo: 927933,
},
components.Share{
NumDaysAgo: 927933,
},
components.Share{
NumDaysAgo: 927933,
},
},
},
Verification: &components.Verification{
State: components.StateUnverified,
Metadata: &components.VerificationMetadata{
Reminders: []components.Reminder{
components.Reminder{
Assignee: components.Person{
Name: "George Clooney",
ObfuscatedID: "abc123",
},
RemindAt: 353914,
},
components.Reminder{
Assignee: components.Person{
Name: "George Clooney",
ObfuscatedID: "abc123",
},
RemindAt: 353914,
},
},
LastReminder: &components.Reminder{
Assignee: components.Person{
Name: "George Clooney",
ObfuscatedID: "abc123",
},
RemindAt: 314497,
},
},
},
Shortcuts: []components.Shortcut{
components.Shortcut{
InputAlias: "<value>",
},
components.Shortcut{
InputAlias: "<value>",
},
},
CustomData: map[string]components.CustomDataValue{
"someCustomField": components.CustomDataValue{},
},
},
},
},
},
InputDetails: &components.SearchRequestInputDetails{
HasCopyPaste: apiclientgo.Pointer(true),
},
},
Results: []components.SearchResult{
components.SearchResult{
Title: apiclientgo.Pointer("title"),
URL: "https://example.com/foo/bar",
NativeAppURL: apiclientgo.Pointer("slack://foo/bar"),
Snippets: []components.SearchResultSnippet{
components.SearchResultSnippet{
MimeType: apiclientgo.Pointer("mimeType"),
Snippet: apiclientgo.Pointer("snippet"),
},
},
},
},
},
components.RelatedDocuments{
QuerySuggestion: &components.QuerySuggestion{
Query: "app:github type:pull author:mortimer",
SearchProviderInfo: &components.SearchProviderInfo{
Name: apiclientgo.Pointer("Google"),
SearchLinkURLTemplate: apiclientgo.Pointer("https://www.google.com/search?q={query}&hl=en"),
},
Label: apiclientgo.Pointer("Mortimer's PRs"),
Datasource: apiclientgo.Pointer("github"),
RequestOptions: &components.SearchRequestOptions{
DatasourceFilter: apiclientgo.Pointer("JIRA"),
DatasourcesFilter: []string{
"JIRA",
},
QueryOverridesFacetFilters: apiclientgo.Pointer(true),
FacetFilters: []components.FacetFilter{
components.FacetFilter{
FieldName: apiclientgo.Pointer("type"),
Values: []components.FacetFilterValue{
components.FacetFilterValue{
Value: apiclientgo.Pointer("Spreadsheet"),
RelationType: components.RelationTypeEquals.ToPointer(),
},
components.FacetFilterValue{
Value: apiclientgo.Pointer("Presentation"),
RelationType: components.RelationTypeEquals.ToPointer(),
},
},
},
},
FacetFilterSets: []components.FacetFilterSet{
components.FacetFilterSet{
Filters: []components.FacetFilter{
components.FacetFilter{
FieldName: apiclientgo.Pointer("type"),
Values: []components.FacetFilterValue{
components.FacetFilterValue{
Value: apiclientgo.Pointer("Spreadsheet"),
RelationType: components.RelationTypeEquals.ToPointer(),
},
components.FacetFilterValue{
Value: apiclientgo.Pointer("Presentation"),
RelationType: components.RelationTypeEquals.ToPointer(),
},
},
},
},
},
components.FacetFilterSet{
Filters: []components.FacetFilter{
components.FacetFilter{
FieldName: apiclientgo.Pointer("type"),
Values: []components.FacetFilterValue{
components.FacetFilterValue{
Value: apiclientgo.Pointer("Spreadsheet"),
RelationType: components.RelationTypeEquals.ToPointer(),
},
components.FacetFilterValue{
Value: apiclientgo.Pointer("Presentation"),
RelationType: components.RelationTypeEquals.ToPointer(),
},
},
},
},
},
},
FacetBucketSize: 797260,
AuthTokens: []components.AuthToken{
components.AuthToken{
AccessToken: "123abc",
Datasource: "gmail",
Scope: apiclientgo.Pointer("email profile https://www.googleapis.com/auth/gmail.readonly"),
TokenType: apiclientgo.Pointer("Bearer"),
AuthUser: apiclientgo.Pointer("1"),
},
},
},
Ranges: []components.TextRange{
components.TextRange{
StartIndex: 932928,
Document: &components.Document{
Metadata: &components.DocumentMetadata{
Datasource: apiclientgo.Pointer("datasource"),
ObjectType: apiclientgo.Pointer("Feature Request"),
Container: apiclientgo.Pointer("container"),
ParentID: apiclientgo.Pointer("JIRA_EN-1337"),
MimeType: apiclientgo.Pointer("mimeType"),
DocumentID: apiclientgo.Pointer("documentId"),
CreateTime: types.MustNewTimeFromString("2000-01-23T04:56:07.000Z"),
UpdateTime: types.MustNewTimeFromString("2000-01-23T04:56:07.000Z"),
Components: []string{
"Backend",
"Networking",
},
Status: apiclientgo.Pointer("[\"Done\"]"),
Pins: []components.PinDocument{
components.PinDocument{
AudienceFilters: []components.FacetFilter{
components.FacetFilter{
FieldName: apiclientgo.Pointer("type"),
Values: []components.FacetFilterValue{
components.FacetFilterValue{
Value: apiclientgo.Pointer("Spreadsheet"),
RelationType: components.RelationTypeEquals.ToPointer(),
},
components.FacetFilterValue{
Value: apiclientgo.Pointer("Presentation"),
RelationType: components.RelationTypeEquals.ToPointer(),
},
},
},
},
DocumentID: "<id>",
},
components.PinDocument{
AudienceFilters: []components.FacetFilter{
components.FacetFilter{
FieldName: apiclientgo.Pointer("type"),
Values: []components.FacetFilterValue{
components.FacetFilterValue{
Value: apiclientgo.Pointer("Spreadsheet"),
RelationType: components.RelationTypeEquals.ToPointer(),
},
components.FacetFilterValue{
Value: apiclientgo.Pointer("Presentation"),
RelationType: components.RelationTypeEquals.ToPointer(),
},
},
},
},
DocumentID: "<id>",
},
},
Collections: []components.Collection{
components.Collection{
Name: "<value>",
Description: "how by extroverted excess kissingly scruple yearningly",
AudienceFilters: []components.FacetFilter{
components.FacetFilter{
FieldName: apiclientgo.Pointer("type"),
Values: []components.FacetFilterValue{
components.FacetFilterValue{
Value: apiclientgo.Pointer("Spreadsheet"),
RelationType: components.RelationTypeEquals.ToPointer(),
},
components.FacetFilterValue{
Value: apiclientgo.Pointer("Presentation"),
RelationType: components.RelationTypeEquals.ToPointer(),
},
},
},
},
ID: 416110,
Items: []components.CollectionItem{
components.CollectionItem{
CollectionID: 959645,
Shortcut: &components.Shortcut{
InputAlias: "<value>",
},
ItemType: components.CollectionItemItemTypeText,
},
components.CollectionItem{
CollectionID: 959645,
Shortcut: &components.Shortcut{
InputAlias: "<value>",
},
ItemType: components.CollectionItemItemTypeText,
},
components.CollectionItem{
CollectionID: 959645,
Shortcut: &components.Shortcut{
InputAlias: "<value>",
},
ItemType: components.CollectionItemItemTypeText,
},
},
},
components.Collection{
Name: "<value>",
Description: "how by extroverted excess kissingly scruple yearningly",
AudienceFilters: []components.FacetFilter{
components.FacetFilter{
FieldName: apiclientgo.Pointer("type"),
Values: []components.FacetFilterValue{
components.FacetFilterValue{
Value: apiclientgo.Pointer("Spreadsheet"),
RelationType: components.RelationTypeEquals.ToPointer(),
},
components.FacetFilterValue{
Value: apiclientgo.Pointer("Presentation"),
RelationType: components.RelationTypeEquals.ToPointer(),
},
},
},
},
ID: 416110,
Items: []components.CollectionItem{
components.CollectionItem{
CollectionID: 959645,
Shortcut: &components.Shortcut{
InputAlias: "<value>",
},
ItemType: components.CollectionItemItemTypeText,
},
components.CollectionItem{
CollectionID: 959645,
Shortcut: &components.Shortcut{
InputAlias: "<value>",
},
ItemType: components.CollectionItemItemTypeText,
},
components.CollectionItem{
CollectionID: 959645,
Shortcut: &components.Shortcut{
InputAlias: "<value>",
},
ItemType: components.CollectionItemItemTypeText,
},
},
},
},
Interactions: &components.DocumentInteractions{
Reacts: []components.Reaction{
components.Reaction{},
components.Reaction{},
components.Reaction{},
},
Shares: []components.Share{
components.Share{
NumDaysAgo: 927933,
},
components.Share{
NumDaysAgo: 927933,
},
components.Share{
NumDaysAgo: 927933,
},
},
},
Verification: &components.Verification{
State: components.StateUnverified,
Metadata: &components.VerificationMetadata{
Reminders: []components.Reminder{
components.Reminder{
Assignee: components.Person{
Name: "George Clooney",
ObfuscatedID: "abc123",
},
RemindAt: 353914,
},
components.Reminder{
Assignee: components.Person{
Name: "George Clooney",
ObfuscatedID: "abc123",
},
RemindAt: 353914,
},
},
LastReminder: &components.Reminder{
Assignee: components.Person{
Name: "George Clooney",
ObfuscatedID: "abc123",
},
RemindAt: 314497,
},
},
},
Shortcuts: []components.Shortcut{
components.Shortcut{
InputAlias: "<value>",
},
components.Shortcut{
InputAlias: "<value>",
},
},
CustomData: map[string]components.CustomDataValue{
"someCustomField": components.CustomDataValue{},
},
},
},
},
},
InputDetails: &components.SearchRequestInputDetails{
HasCopyPaste: apiclientgo.Pointer(true),
},
},
Results: []components.SearchResult{
components.SearchResult{
Title: apiclientgo.Pointer("title"),
URL: "https://example.com/foo/bar",
NativeAppURL: apiclientgo.Pointer("slack://foo/bar"),
Snippets: []components.SearchResultSnippet{
components.SearchResultSnippet{
MimeType: apiclientgo.Pointer("mimeType"),
Snippet: apiclientgo.Pointer("snippet"),
},
},
},
},
},
},
Metadata: &components.PersonMetadata{
Type: components.PersonMetadataTypeFullTime.ToPointer(),
Title: apiclientgo.Pointer("Actor"),
Department: apiclientgo.Pointer("Movies"),
Email: apiclientgo.Pointer("george@example.com"),
Location: apiclientgo.Pointer("Hollywood, CA"),
Phone: apiclientgo.Pointer("6505551234"),
PhotoURL: apiclientgo.Pointer("https://example.com/george.jpg"),
StartDate: types.MustNewDateFromString("2000-01-23"),
DatasourceProfile: []components.DatasourceProfile{
components.DatasourceProfile{
Datasource: "github",
Handle: "<value>",
},
components.DatasourceProfile{
Datasource: "github",
Handle: "<value>",
},
components.DatasourceProfile{
Datasource: "github",
Handle: "<value>",
},
},
QuerySuggestions: &components.QuerySuggestionList{
Suggestions: []components.QuerySuggestion{
components.QuerySuggestion{
Query: "app:github type:pull author:mortimer",
Label: apiclientgo.Pointer("Mortimer's PRs"),
Datasource: apiclientgo.Pointer("github"),
},
},
},
InviteInfo: &components.InviteInfo{
Invites: []components.ChannelInviteInfo{
components.ChannelInviteInfo{},
components.ChannelInviteInfo{},
components.ChannelInviteInfo{},
},
},
CustomFields: []components.CustomFieldData{
components.CustomFieldData{
Label: "<value>",
Values: []components.CustomFieldValue{
components.CreateCustomFieldValueCustomFieldValueStr(
components.CustomFieldValueStr{},
),
components.CreateCustomFieldValueCustomFieldValueStr(
components.CustomFieldValueStr{},
),
components.CreateCustomFieldValueCustomFieldValueStr(
components.CustomFieldValueStr{},
),
},
},
},
Badges: []components.Badge{
components.Badge{
Key: apiclientgo.Pointer("deployment_name_new_hire"),
DisplayName: apiclientgo.Pointer("New hire"),
IconConfig: &components.IconConfig{
Color: apiclientgo.Pointer("#343CED"),
Key: apiclientgo.Pointer("person_icon"),
IconType: components.IconTypeGlyph.ToPointer(),
Name: apiclientgo.Pointer("user"),
},
},
},
},
},
Role: components.UserRoleOwner,
},
},
RemovedRoles: []components.UserRoleSpecification{
components.UserRoleSpecification{
Person: &components.Person{
Name: "George Clooney",
ObfuscatedID: "abc123",
Metadata: &components.PersonMetadata{
Type: components.PersonMetadataTypeFullTime.ToPointer(),
Title: apiclientgo.Pointer("Actor"),
Department: apiclientgo.Pointer("Movies"),
Email: apiclientgo.Pointer("george@example.com"),
Location: apiclientgo.Pointer("Hollywood, CA"),
Phone: apiclientgo.Pointer("6505551234"),
PhotoURL: apiclientgo.Pointer("https://example.com/george.jpg"),
StartDate: types.MustNewDateFromString("2000-01-23"),
DatasourceProfile: []components.DatasourceProfile{
components.DatasourceProfile{
Datasource: "github",
Handle: "<value>",
},
components.DatasourceProfile{
Datasource: "github",
Handle: "<value>",
},
components.DatasourceProfile{
Datasource: "github",
Handle: "<value>",
},
},
QuerySuggestions: &components.QuerySuggestionList{
Suggestions: []components.QuerySuggestion{
components.QuerySuggestion{
Query: "app:github type:pull author:mortimer",
Label: apiclientgo.Pointer("Mortimer's PRs"),
Datasource: apiclientgo.Pointer("github"),
},
},
},
InviteInfo: &components.InviteInfo{
Invites: []components.ChannelInviteInfo{
components.ChannelInviteInfo{},
components.ChannelInviteInfo{},
components.ChannelInviteInfo{},
},
},
Badges: []components.Badge{
components.Badge{
Key: apiclientgo.Pointer("deployment_name_new_hire"),
DisplayName: apiclientgo.Pointer("New hire"),
IconConfig: &components.IconConfig{
Color: apiclientgo.Pointer("#343CED"),
Key: apiclientgo.Pointer("person_icon"),
IconType: components.IconTypeGlyph.ToPointer(),
Name: apiclientgo.Pointer("user"),
},
},
},
},
},
Role: components.UserRoleAnswerModerator,
},
},
AudienceFilters: []components.FacetFilter{
components.FacetFilter{
FieldName: apiclientgo.Pointer("type"),
Values: []components.FacetFilterValue{
components.FacetFilterValue{
Value: apiclientgo.Pointer("Spreadsheet"),
RelationType: components.RelationTypeEquals.ToPointer(),
},
components.FacetFilterValue{
Value: apiclientgo.Pointer("Presentation"),
RelationType: components.RelationTypeEquals.ToPointer(),
},
},
},
},
ID: 671264,
}, nil)
if err != nil {
log.Fatal(err)
}
if res.EditCollectionResponse != nil {
// handle response
}
}| Parameter | Type | Required | Description |
|---|---|---|---|
ctx |
context.Context | ✔️ | The context to use for the request. |
editCollectionRequest |
components.EditCollectionRequest | ✔️ | Collection content plus any additional metadata for the request. |
locale |
*string |
➖ | The client's preferred locale in rfc5646 format (e.g. en, ja, pt-BR). If omitted, the Accept-Language will be used. If not present or not supported, defaults to the closest match or en. |
opts |
[]operations.Option | ➖ | The options for this request. |
*operations.EditcollectionResponse, error
| Error Type | Status Code | Content Type |
|---|---|---|
| apierrors.CollectionError | 422 | application/json |
| apierrors.APIError | 4XX, 5XX | */* |
Update the URL, Glean Document ID, description of an item within a Collection given its ID.
package main
import(
"context"
"os"
apiclientgo "github.com/gleanwork/api-client-go"
"github.com/gleanwork/api-client-go/models/components"
"log"
)
func main() {
ctx := context.Background()
s := apiclientgo.New(
apiclientgo.WithSecurity(os.Getenv("GLEAN_API_TOKEN")),
)
res, err := s.Client.Collections.UpdateItem(ctx, components.EditCollectionItemRequest{
CollectionID: 142375,
ItemID: "<id>",
}, nil)
if err != nil {
log.Fatal(err)
}
if res.EditCollectionItemResponse != nil {
// handle response
}
}| Parameter | Type | Required | Description |
|---|---|---|---|
ctx |
context.Context | ✔️ | The context to use for the request. |
editCollectionItemRequest |
components.EditCollectionItemRequest | ✔️ | Edit Collection Items request |
locale |
*string |
➖ | The client's preferred locale in rfc5646 format (e.g. en, ja, pt-BR). If omitted, the Accept-Language will be used. If not present or not supported, defaults to the closest match or en. |
opts |
[]operations.Option | ➖ | The options for this request. |
*operations.EditcollectionitemResponse, error
| Error Type | Status Code | Content Type |
|---|---|---|
| apierrors.APIError | 4XX, 5XX | */* |
Read the details of a Collection given its ID. Does not fetch items in this Collection.
package main
import(
"context"
"os"
apiclientgo "github.com/gleanwork/api-client-go"
"github.com/gleanwork/api-client-go/models/components"
"log"
)
func main() {
ctx := context.Background()
s := apiclientgo.New(
apiclientgo.WithSecurity(os.Getenv("GLEAN_API_TOKEN")),
)
res, err := s.Client.Collections.Retrieve(ctx, components.GetCollectionRequest{
ID: 425335,
}, nil)
if err != nil {
log.Fatal(err)
}
if res.GetCollectionResponse != nil {
// handle response
}
}| Parameter | Type | Required | Description |
|---|---|---|---|
ctx |
context.Context | ✔️ | The context to use for the request. |
getCollectionRequest |
components.GetCollectionRequest | ✔️ | GetCollection request |
locale |
*string |
➖ | The client's preferred locale in rfc5646 format (e.g. en, ja, pt-BR). If omitted, the Accept-Language will be used. If not present or not supported, defaults to the closest match or en. |
opts |
[]operations.Option | ➖ | The options for this request. |
*operations.GetcollectionResponse, error
| Error Type | Status Code | Content Type |
|---|---|---|
| apierrors.APIError | 4XX, 5XX | */* |
List all existing Collections.
package main
import(
"context"
"os"
apiclientgo "github.com/gleanwork/api-client-go"
"github.com/gleanwork/api-client-go/models/components"
"log"
)
func main() {
ctx := context.Background()
s := apiclientgo.New(
apiclientgo.WithSecurity(os.Getenv("GLEAN_API_TOKEN")),
)
res, err := s.Client.Collections.List(ctx, components.ListCollectionsRequest{}, nil)
if err != nil {
log.Fatal(err)
}
if res.ListCollectionsResponse != nil {
// handle response
}
}| Parameter | Type | Required | Description |
|---|---|---|---|
ctx |
context.Context | ✔️ | The context to use for the request. |
listCollectionsRequest |
components.ListCollectionsRequest | ✔️ | ListCollections request |
locale |
*string |
➖ | The client's preferred locale in rfc5646 format (e.g. en, ja, pt-BR). If omitted, the Accept-Language will be used. If not present or not supported, defaults to the closest match or en. |
opts |
[]operations.Option | ➖ | The options for this request. |
*operations.ListcollectionsResponse, error
| Error Type | Status Code | Content Type |
|---|---|---|
| apierrors.APIError | 4XX, 5XX | */* |