memori-client 0.1.6 → 0.1.9

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.
Files changed (43) hide show
  1. checksums.yaml +4 -4
  2. data/doc/MemoriClient::Backend::V1::Asset.md +117 -0
  3. data/doc/MemoriClient::Backend::V2::ActionLog.md +37 -0
  4. data/doc/MemoriClient::Backend::V2::Analysis.md +39 -0
  5. data/doc/MemoriClient::Backend::V2::Asset.md +102 -0
  6. data/doc/MemoriClient::Backend::V2::Badge.md +64 -0
  7. data/doc/MemoriClient::Backend::V2::CompletionConfig.md +115 -0
  8. data/doc/MemoriClient::Backend::V2::ConsumptionLog.md +57 -0
  9. data/doc/MemoriClient::Backend::V2::ImportExport.md +180 -0
  10. data/doc/MemoriClient::Backend::V2::Integration.md +117 -0
  11. data/doc/MemoriClient::Backend::V2::Invitation.md +179 -0
  12. data/doc/MemoriClient::Backend::V2::Memori.md +394 -0
  13. data/doc/MemoriClient::Backend::V2::MemoriList.md +147 -0
  14. data/doc/MemoriClient::Backend::V2::Notification.md +31 -0
  15. data/doc/MemoriClient::Backend::V2::Process.md +64 -0
  16. data/doc/MemoriClient::Backend::V2::Tenant.md +142 -0
  17. data/doc/MemoriClient::Backend::V2::User.md +647 -0
  18. data/doc/MemoriClient::Engine::V2::ChatLog.md +82 -0
  19. data/doc/MemoriClient::Engine::V2::ContextVar.md +46 -0
  20. data/doc/MemoriClient::Engine::V2::CorrelationPair.md +72 -0
  21. data/doc/MemoriClient::Engine::V2::CustomDictionary.md +108 -0
  22. data/doc/MemoriClient::Engine::V2::Dialog.md +152 -0
  23. data/doc/MemoriClient::Engine::V2::EventLog.md +85 -0
  24. data/doc/MemoriClient::Engine::V2::ExpertReference.md +116 -0
  25. data/doc/MemoriClient::Engine::V2::Function.md +140 -0
  26. data/doc/MemoriClient::Engine::V2::Intent.md +225 -0
  27. data/doc/MemoriClient::Engine::V2::LocalizationKey.md +105 -0
  28. data/doc/MemoriClient::Engine::V2::Medium.md +118 -0
  29. data/doc/MemoriClient::Engine::V2::Memory.md +244 -0
  30. data/doc/MemoriClient::Engine::V2::NLP.md +100 -0
  31. data/doc/MemoriClient::Engine::V2::Person.md +114 -0
  32. data/doc/MemoriClient::Engine::V2::Search.md +151 -0
  33. data/doc/MemoriClient::Engine::V2::Session.md +55 -0
  34. data/doc/MemoriClient::Engine::V2::Stat.md +18 -0
  35. data/doc/MemoriClient::Engine::V2::Topic.md +80 -0
  36. data/doc/MemoriClient::Engine::V2::UnansweredQuestion.md +75 -0
  37. data/doc/MemoriClient::Engine::V2::User.md +140 -0
  38. data/doc/MemoriClient::Engine::V2::WebHook.md +67 -0
  39. data/lib/memori_client/railtie.rb +12 -0
  40. data/lib/memori_client/utils/rails.rb +54 -0
  41. data/lib/memori_client.rb +7 -0
  42. data/lib/tasks/memori_client.rake +15 -0
  43. metadata +42 -2
@@ -0,0 +1,142 @@
1
+ # Module `MemoriClient::Backend::V2::Tenant`
2
+
3
+ ## health_check
4
+
5
+ Summary:
6
+ No operation.
7
+
8
+ Signature: `health_check()`
9
+ Invocation: `MemoriClient::Backend::V2::Tenant.health_check()`
10
+
11
+ HTTP API: GET /api/v2/HealthCheck`
12
+
13
+
14
+ ## list_tenants
15
+
16
+ Summary:
17
+ Gets the list of of all Tenant objects.
18
+
19
+ Signature: `list_tenants(strToken:)`
20
+ Invocation: `MemoriClient::Backend::V2::Tenant.list_tenants(strToken:)`
21
+
22
+ HTTP API: GET /api/v2/Tenants/{strToken}`
23
+
24
+ Parameters:
25
+
26
+ - `strToken`: **string** The login token. required
27
+
28
+ ## get_tenant
29
+
30
+ Summary:
31
+ Gets the details of a Tenant object.
32
+
33
+ Signature: `get_tenant(tenantName:)`
34
+ Invocation: `MemoriClient::Backend::V2::Tenant.get_tenant(tenantName:)`
35
+
36
+ HTTP API: GET /api/v2/Tenant/{tenantName}`
37
+
38
+ Parameters:
39
+
40
+ - `tenantName`: **string** The name of the Tenant. required
41
+
42
+ ## duplicate_tenant
43
+
44
+ Summary:
45
+ Duplicates a Tenant object.
46
+
47
+ Signature: `duplicate_tenant(strToken:, tenantName:, payload: {})`
48
+ Invocation: `MemoriClient::Backend::V2::Tenant.duplicate_tenant(strToken:, tenantName:, payload: {})`
49
+
50
+ HTTP API: POST /api/v2/Tenant/{strToken}/{tenantName}`
51
+
52
+ Parameters:
53
+
54
+ - `strToken`: **string** The login token. required
55
+ - `tenantName`: **string** The name of the Tenant to duplicate. required
56
+ - `payload`: **Hash** request payload. optional
57
+ - `payload.tenantID`: **String** . optional
58
+ - `payload.name`: **String** . optional
59
+ - `payload.aliases`: **Array** . optional
60
+ - `payload.description`: **String** . optional
61
+ - `payload.logoURL`: **String** . optional
62
+ - `payload.adminEmail`: **String** . optional
63
+ - `payload.theme`: **String** . optional
64
+ - `payload.feedbackURL`: **String** . optional
65
+ - `payload.adminCount`: **Integer** . optional
66
+ - `payload.userCount`: **Integer** . optional
67
+ - `payload.memoriCount`: **Integer** . optional
68
+ - `payload.disableRegistration`: **Boolean** . optional
69
+ - `payload.maxMemoriPerAdmin`: **Integer** . optional
70
+ - `payload.maxMemoriPerUser`: **Integer** . optional
71
+ - `payload.maxTotalMemori`: **Integer** . optional
72
+ - `payload.maxAdmins`: **Integer** . optional
73
+ - `payload.maxUsers`: **Integer** . optional
74
+ - `payload.maxFreeSessions`: **Integer** . optional
75
+ - `payload.maxFreeSessionsPerUser`: **Integer** . optional
76
+ - `payload.nonFreeSessionCost`: **Number** . optional
77
+ - `payload.maxCompletions`: **Integer** . optional
78
+ - `payload.maxCompletionsPerUser`: **Integer** . optional
79
+ - `payload.maxImportSize`: **Integer** . optional
80
+ - `payload.maxImportSizePerUser`: **Integer** . optional
81
+ - `payload.paying`: **Boolean** . optional
82
+ - `payload.enableUserMemoriCreation`: **Boolean** . optional
83
+ - `payload.enableBoardOfExperts`: **Boolean** . optional
84
+ - `payload.enableDCMIntegration`: **Boolean** . optional
85
+ - `payload.enableBadges`: **Boolean** . optional
86
+ - `payload.enableDeepThought`: **Boolean** . optional
87
+ - `payload.enableVirtualSpaces`: **Boolean** . optional
88
+ - `payload.billingDelegation`: **Boolean** . optional
89
+ - `payload.creationTimestamp`: **String** . optional
90
+ - `payload.lastChangeTimestamp`: **String** . optional
91
+
92
+ ## update_tenant
93
+
94
+ Summary:
95
+ Updates the details of a Tenant object.
96
+
97
+ Signature: `update_tenant(strToken:, tenantName:, payload: {})`
98
+ Invocation: `MemoriClient::Backend::V2::Tenant.update_tenant(strToken:, tenantName:, payload: {})`
99
+
100
+ HTTP API: PATCH /api/v2/Tenant/{strToken}/{tenantName}`
101
+
102
+ Parameters:
103
+
104
+ - `strToken`: **string** The login token. required
105
+ - `tenantName`: **string** The name of the Tenant to update. required
106
+ - `payload`: **Hash** request payload. optional
107
+ - `payload.tenantID`: **String** . optional
108
+ - `payload.name`: **String** . optional
109
+ - `payload.aliases`: **Array** . optional
110
+ - `payload.description`: **String** . optional
111
+ - `payload.logoURL`: **String** . optional
112
+ - `payload.adminEmail`: **String** . optional
113
+ - `payload.theme`: **String** . optional
114
+ - `payload.feedbackURL`: **String** . optional
115
+ - `payload.adminCount`: **Integer** . optional
116
+ - `payload.userCount`: **Integer** . optional
117
+ - `payload.memoriCount`: **Integer** . optional
118
+ - `payload.disableRegistration`: **Boolean** . optional
119
+ - `payload.maxMemoriPerAdmin`: **Integer** . optional
120
+ - `payload.maxMemoriPerUser`: **Integer** . optional
121
+ - `payload.maxTotalMemori`: **Integer** . optional
122
+ - `payload.maxAdmins`: **Integer** . optional
123
+ - `payload.maxUsers`: **Integer** . optional
124
+ - `payload.maxFreeSessions`: **Integer** . optional
125
+ - `payload.maxFreeSessionsPerUser`: **Integer** . optional
126
+ - `payload.nonFreeSessionCost`: **Number** . optional
127
+ - `payload.maxCompletions`: **Integer** . optional
128
+ - `payload.maxCompletionsPerUser`: **Integer** . optional
129
+ - `payload.maxImportSize`: **Integer** . optional
130
+ - `payload.maxImportSizePerUser`: **Integer** . optional
131
+ - `payload.paying`: **Boolean** . optional
132
+ - `payload.enableUserMemoriCreation`: **Boolean** . optional
133
+ - `payload.enableBoardOfExperts`: **Boolean** . optional
134
+ - `payload.enableDCMIntegration`: **Boolean** . optional
135
+ - `payload.enableBadges`: **Boolean** . optional
136
+ - `payload.enableDeepThought`: **Boolean** . optional
137
+ - `payload.enableVirtualSpaces`: **Boolean** . optional
138
+ - `payload.billingDelegation`: **Boolean** . optional
139
+ - `payload.creationTimestamp`: **String** . optional
140
+ - `payload.lastChangeTimestamp`: **String** . optional
141
+
142
+