@botpress/api 0.43.1 → 0.44.0

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.
@@ -1,5 +1,5 @@
1
1
  import * as opapi from '@bpinternal/opapi';
2
- export type State = opapi.State<'Bot' | 'Integration' | 'Interface' | 'Workspace' | 'WorkspaceMember' | 'Account' | 'Usage' | 'Issue' | 'IssueEvent' | 'Activity' | 'Version' | 'User' | 'Conversation' | 'Event' | 'Message' | 'State' | 'Task' | 'Table' | 'Column' | 'Row' | 'File', never, 'user' | 'conversation' | 'event' | 'message' | 'state' | 'hub' | 'action' | 'task' | 'bot' | 'integration' | 'interface' | 'workspace' | 'workspaceMember' | 'account' | 'usage' | 'quotas' | 'helper' | 'activity' | 'tables' | 'files'>;
2
+ export type State = opapi.State<'Bot' | 'Integration' | 'Interface' | 'Workspace' | 'WorkspaceMember' | 'Account' | 'Usage' | 'Issue' | 'IssueEvent' | 'Activity' | 'Version' | 'User' | 'Conversation' | 'Event' | 'Message' | 'State' | 'Task' | 'Workflow' | 'Table' | 'Column' | 'Row' | 'File', never, 'user' | 'conversation' | 'event' | 'message' | 'state' | 'hub' | 'action' | 'task' | 'workflow' | 'bot' | 'integration' | 'interface' | 'workspace' | 'workspaceMember' | 'account' | 'usage' | 'quotas' | 'helper' | 'activity' | 'tables' | 'files'>;
3
3
  export declare const state: {
4
4
  operations: {
5
5
  createConversation: {
@@ -572,6 +572,7 @@ export declare const state: {
572
572
  status: {
573
573
  in: "query";
574
574
  type: "string";
575
+ enum: string[];
575
576
  description: string;
576
577
  };
577
578
  };
@@ -1854,6 +1855,355 @@ export declare const state: {
1854
1855
  };
1855
1856
  };
1856
1857
  };
1858
+ createWorkflow: {
1859
+ name: string;
1860
+ description: string;
1861
+ method: "post";
1862
+ path: string;
1863
+ requestBody: {
1864
+ description: string;
1865
+ schema: {
1866
+ type: "object";
1867
+ properties: {
1868
+ name: {
1869
+ type: "string";
1870
+ description: string;
1871
+ };
1872
+ input: {
1873
+ type: "object";
1874
+ additionalProperties: true;
1875
+ description: string;
1876
+ };
1877
+ parentWorkflowId: {
1878
+ type: "string";
1879
+ description: string;
1880
+ };
1881
+ conversationId: {
1882
+ type: "string";
1883
+ description: string;
1884
+ };
1885
+ userId: {
1886
+ type: "string";
1887
+ description: string;
1888
+ };
1889
+ timeoutAt: {
1890
+ type: "string";
1891
+ format: string;
1892
+ description: string;
1893
+ };
1894
+ tags: {
1895
+ type: "object";
1896
+ additionalProperties: {
1897
+ type: "string";
1898
+ maxLength: number;
1899
+ };
1900
+ description: string;
1901
+ };
1902
+ status: {
1903
+ type: "string";
1904
+ enum: string[];
1905
+ };
1906
+ eventId: {
1907
+ type: "string";
1908
+ description: string;
1909
+ };
1910
+ };
1911
+ required: string[];
1912
+ title: string;
1913
+ additionalProperties: false;
1914
+ };
1915
+ };
1916
+ section: "workflow";
1917
+ response: {
1918
+ description: string;
1919
+ status: 201;
1920
+ schema: {
1921
+ type: "object";
1922
+ properties: {
1923
+ workflow: {
1924
+ $ref: string;
1925
+ };
1926
+ };
1927
+ required: string[];
1928
+ title: string;
1929
+ additionalProperties: false;
1930
+ };
1931
+ };
1932
+ parameters: {};
1933
+ };
1934
+ getWorkflow: {
1935
+ name: string;
1936
+ description: string;
1937
+ method: "get";
1938
+ path: string;
1939
+ parameters: {
1940
+ id: {
1941
+ in: "path";
1942
+ type: "string";
1943
+ description: string;
1944
+ };
1945
+ };
1946
+ section: "workflow";
1947
+ response: {
1948
+ description: string;
1949
+ schema: {
1950
+ type: "object";
1951
+ properties: {
1952
+ workflow: {
1953
+ $ref: string;
1954
+ };
1955
+ };
1956
+ required: string[];
1957
+ title: string;
1958
+ additionalProperties: false;
1959
+ };
1960
+ };
1961
+ };
1962
+ updateWorkflow: {
1963
+ name: string;
1964
+ description: string;
1965
+ method: "put";
1966
+ path: string;
1967
+ parameters: {
1968
+ id: {
1969
+ in: "path";
1970
+ type: "string";
1971
+ description: string;
1972
+ };
1973
+ };
1974
+ requestBody: {
1975
+ description: string;
1976
+ schema: {
1977
+ type: "object";
1978
+ properties: {
1979
+ output: {
1980
+ type: "object";
1981
+ additionalProperties: true;
1982
+ description: string;
1983
+ };
1984
+ timeoutAt: {
1985
+ type: "string";
1986
+ format: string;
1987
+ description: string;
1988
+ };
1989
+ status: {
1990
+ type: "string";
1991
+ enum: string[];
1992
+ description: string;
1993
+ };
1994
+ failureReason: {
1995
+ type: "string";
1996
+ description: string;
1997
+ };
1998
+ tags: {
1999
+ type: "object";
2000
+ additionalProperties: {
2001
+ type: "string";
2002
+ maxLength: number;
2003
+ };
2004
+ description: string;
2005
+ };
2006
+ userId: {
2007
+ type: "string";
2008
+ description: string;
2009
+ };
2010
+ };
2011
+ title: string;
2012
+ additionalProperties: false;
2013
+ };
2014
+ };
2015
+ section: "workflow";
2016
+ response: {
2017
+ description: string;
2018
+ schema: {
2019
+ type: "object";
2020
+ properties: {
2021
+ workflow: {
2022
+ $ref: string;
2023
+ };
2024
+ };
2025
+ required: string[];
2026
+ title: string;
2027
+ additionalProperties: false;
2028
+ };
2029
+ };
2030
+ };
2031
+ deleteWorkflow: {
2032
+ name: string;
2033
+ description: string;
2034
+ method: "delete";
2035
+ path: string;
2036
+ parameters: {
2037
+ id: {
2038
+ in: "path";
2039
+ type: "string";
2040
+ description: string;
2041
+ };
2042
+ };
2043
+ section: "workflow";
2044
+ response: {
2045
+ description: string;
2046
+ schema: {
2047
+ type: "object";
2048
+ title: string;
2049
+ additionalProperties: false;
2050
+ };
2051
+ };
2052
+ };
2053
+ listWorkflows: {
2054
+ name: string;
2055
+ description: string;
2056
+ method: "get";
2057
+ path: string;
2058
+ parameters: {
2059
+ nextToken: {
2060
+ in: "query";
2061
+ description: string;
2062
+ type: "string";
2063
+ };
2064
+ tags: {
2065
+ in: "query";
2066
+ type: "object";
2067
+ schema: {
2068
+ type: "object";
2069
+ additionalProperties: {
2070
+ type: "string";
2071
+ };
2072
+ };
2073
+ description: string;
2074
+ };
2075
+ conversationId: {
2076
+ in: "query";
2077
+ type: "string";
2078
+ description: string;
2079
+ };
2080
+ userId: {
2081
+ in: "query";
2082
+ type: "string";
2083
+ description: string;
2084
+ };
2085
+ parentWorkflowId: {
2086
+ in: "query";
2087
+ type: "string";
2088
+ description: string;
2089
+ };
2090
+ statuses: {
2091
+ in: "query";
2092
+ type: "string[]";
2093
+ description: string;
2094
+ enum: string[];
2095
+ };
2096
+ name: {
2097
+ in: "query";
2098
+ description: string;
2099
+ type: "string";
2100
+ };
2101
+ };
2102
+ section: "workflow";
2103
+ response: {
2104
+ description: string;
2105
+ schema: {
2106
+ type: "object";
2107
+ properties: {
2108
+ workflows: {
2109
+ type: "array";
2110
+ items: {
2111
+ $ref: string;
2112
+ };
2113
+ };
2114
+ meta: {
2115
+ type: "object";
2116
+ properties: {
2117
+ nextToken: {
2118
+ type: "string";
2119
+ description: string;
2120
+ };
2121
+ };
2122
+ additionalProperties: false;
2123
+ };
2124
+ };
2125
+ required: string[];
2126
+ title: string;
2127
+ additionalProperties: false;
2128
+ };
2129
+ };
2130
+ };
2131
+ getOrCreateWorkflow: {
2132
+ name: string;
2133
+ description: string;
2134
+ method: "post";
2135
+ path: string;
2136
+ requestBody: {
2137
+ description: string;
2138
+ schema: {
2139
+ type: "object";
2140
+ properties: {
2141
+ name: {
2142
+ type: "string";
2143
+ description: string;
2144
+ };
2145
+ input: {
2146
+ type: "object";
2147
+ additionalProperties: true;
2148
+ description: string;
2149
+ };
2150
+ parentWorkflowId: {
2151
+ type: "string";
2152
+ description: string;
2153
+ };
2154
+ conversationId: {
2155
+ type: "string";
2156
+ description: string;
2157
+ };
2158
+ userId: {
2159
+ type: "string";
2160
+ description: string;
2161
+ };
2162
+ timeoutAt: {
2163
+ type: "string";
2164
+ format: string;
2165
+ description: string;
2166
+ };
2167
+ tags: {
2168
+ type: "object";
2169
+ additionalProperties: {
2170
+ type: "string";
2171
+ maxLength: number;
2172
+ };
2173
+ description: string;
2174
+ };
2175
+ status: {
2176
+ type: "string";
2177
+ enum: string[];
2178
+ };
2179
+ eventId: {
2180
+ type: "string";
2181
+ description: string;
2182
+ };
2183
+ };
2184
+ required: string[];
2185
+ title: string;
2186
+ additionalProperties: false;
2187
+ };
2188
+ };
2189
+ section: "workflow";
2190
+ response: {
2191
+ description: string;
2192
+ status: 200;
2193
+ schema: {
2194
+ type: "object";
2195
+ properties: {
2196
+ workflow: {
2197
+ $ref: string;
2198
+ };
2199
+ };
2200
+ required: string[];
2201
+ title: string;
2202
+ additionalProperties: false;
2203
+ };
2204
+ };
2205
+ parameters: {};
2206
+ };
1857
2207
  trackAnalytics: {
1858
2208
  name: string;
1859
2209
  description: string;
@@ -8497,6 +8847,75 @@ export declare const state: {
8497
8847
  };
8498
8848
  };
8499
8849
  };
8850
+ listUsageActivity: {
8851
+ name: string;
8852
+ path: string;
8853
+ method: "get";
8854
+ description: string;
8855
+ parameters: {
8856
+ type: {
8857
+ in: "query";
8858
+ description: string;
8859
+ type: "string";
8860
+ enum: string[];
8861
+ required: true;
8862
+ };
8863
+ id: {
8864
+ type: "string";
8865
+ description: string;
8866
+ in: "path";
8867
+ };
8868
+ nextToken: {
8869
+ in: "query";
8870
+ description: string;
8871
+ type: "string";
8872
+ };
8873
+ };
8874
+ response: {
8875
+ description: string;
8876
+ schema: {
8877
+ type: "object";
8878
+ properties: {
8879
+ data: {
8880
+ type: "array";
8881
+ items: {
8882
+ type: "object";
8883
+ properties: {
8884
+ timestamp: {
8885
+ type: "string";
8886
+ };
8887
+ value: {
8888
+ type: "number";
8889
+ };
8890
+ period: {
8891
+ type: "string";
8892
+ };
8893
+ metadata: {
8894
+ type: "object";
8895
+ additionalProperties: {
8896
+ nullable: true;
8897
+ };
8898
+ };
8899
+ };
8900
+ required: string[];
8901
+ };
8902
+ };
8903
+ meta: {
8904
+ type: "object";
8905
+ properties: {
8906
+ nextToken: {
8907
+ type: "string";
8908
+ };
8909
+ };
8910
+ additionalProperties: false;
8911
+ };
8912
+ };
8913
+ required: string[];
8914
+ title: string;
8915
+ additionalProperties: false;
8916
+ };
8917
+ };
8918
+ };
8500
8919
  changeAISpendQuota: {
8501
8920
  name: string;
8502
8921
  path: string;
@@ -10283,6 +10702,9 @@ export declare const state: {
10283
10702
  configureIntegrationBody: true;
10284
10703
  createTaskBody: true;
10285
10704
  updateTaskBody: true;
10705
+ createWorkflowBody: true;
10706
+ updateWorkflowBody: true;
10707
+ getOrCreateWorkflowBody: true;
10286
10708
  trackAnalyticsBody: true;
10287
10709
  runVrlBody: true;
10288
10710
  updateAccountBody: true;
@@ -10359,6 +10781,12 @@ export declare const state: {
10359
10781
  updateTaskResponse: true;
10360
10782
  deleteTaskResponse: true;
10361
10783
  listTasksResponse: true;
10784
+ createWorkflowResponse: true;
10785
+ getWorkflowResponse: true;
10786
+ updateWorkflowResponse: true;
10787
+ deleteWorkflowResponse: true;
10788
+ listWorkflowsResponse: true;
10789
+ getOrCreateWorkflowResponse: true;
10362
10790
  trackAnalyticsResponse: true;
10363
10791
  runVrlResponse: true;
10364
10792
  getAccountResponse: true;
@@ -10431,6 +10859,7 @@ export declare const state: {
10431
10859
  getUsageResponse: true;
10432
10860
  getMultipleUsagesResponse: true;
10433
10861
  listUsageHistoryResponse: true;
10862
+ listUsageActivityResponse: true;
10434
10863
  changeAISpendQuotaResponse: true;
10435
10864
  listActivitiesResponse: true;
10436
10865
  introspectResponse: true;
@@ -10474,6 +10903,7 @@ export declare const state: {
10474
10903
  Message: true;
10475
10904
  State: true;
10476
10905
  Task: true;
10906
+ Workflow: true;
10477
10907
  Table: true;
10478
10908
  Column: true;
10479
10909
  Row: true;
@@ -11948,6 +12378,12 @@ export declare const state: {
11948
12378
  maxLength: number;
11949
12379
  description: string;
11950
12380
  };
12381
+ currentWorkflowId: {
12382
+ type: "string";
12383
+ minLength: number;
12384
+ maxLength: number;
12385
+ description: string;
12386
+ };
11951
12387
  createdAt: {
11952
12388
  type: "string";
11953
12389
  format: string;
@@ -12241,6 +12677,93 @@ export declare const state: {
12241
12677
  additionalProperties: false;
12242
12678
  };
12243
12679
  };
12680
+ Workflow: {
12681
+ section: "workflow";
12682
+ schema: {
12683
+ type: "object";
12684
+ properties: {
12685
+ id: {
12686
+ type: "string";
12687
+ minLength: number;
12688
+ maxLength: number;
12689
+ description: string;
12690
+ };
12691
+ name: {
12692
+ type: "string";
12693
+ maxLength: number;
12694
+ description: string;
12695
+ };
12696
+ status: {
12697
+ type: "string";
12698
+ enum: string[];
12699
+ description: string;
12700
+ };
12701
+ input: {
12702
+ type: "object";
12703
+ additionalProperties: true;
12704
+ description: string;
12705
+ };
12706
+ output: {
12707
+ type: "object";
12708
+ additionalProperties: true;
12709
+ description: string;
12710
+ };
12711
+ parentWorkflowId: {
12712
+ type: "string";
12713
+ minLength: number;
12714
+ maxLength: number;
12715
+ description: string;
12716
+ };
12717
+ conversationId: {
12718
+ type: "string";
12719
+ minLength: number;
12720
+ maxLength: number;
12721
+ description: string;
12722
+ };
12723
+ userId: {
12724
+ type: "string";
12725
+ minLength: number;
12726
+ maxLength: number;
12727
+ description: string;
12728
+ };
12729
+ createdAt: {
12730
+ type: "string";
12731
+ format: string;
12732
+ description: string;
12733
+ };
12734
+ updatedAt: {
12735
+ type: "string";
12736
+ format: string;
12737
+ description: string;
12738
+ };
12739
+ completedAt: {
12740
+ type: "string";
12741
+ format: string;
12742
+ description: string;
12743
+ };
12744
+ failureReason: {
12745
+ type: "string";
12746
+ maxLength: number;
12747
+ description: string;
12748
+ };
12749
+ timeoutAt: {
12750
+ type: "string";
12751
+ format: string;
12752
+ description: string;
12753
+ };
12754
+ tags: {
12755
+ type: "object";
12756
+ additionalProperties: {
12757
+ type: "string";
12758
+ };
12759
+ description: string;
12760
+ };
12761
+ };
12762
+ required: string[];
12763
+ description: string;
12764
+ additionalProperties: false;
12765
+ };
12766
+ };
12244
12767
  Table: {
12245
12768
  section: "tables";
12246
12769
  schema: {
@@ -12355,6 +12878,10 @@ export declare const state: {
12355
12878
  type: "number";
12356
12879
  description: string;
12357
12880
  };
12881
+ schemaId: {
12882
+ type: "string";
12883
+ description: string;
12884
+ };
12358
12885
  computed: {
12359
12886
  type: "object";
12360
12887
  properties: {
@@ -12718,6 +13245,12 @@ export declare const state: {
12718
13245
  name: "task";
12719
13246
  operations: string[];
12720
13247
  schema: string;
13248
+ } | {
13249
+ description: string;
13250
+ title: string;
13251
+ name: "workflow";
13252
+ operations: string[];
13253
+ schema: string;
12721
13254
  } | {
12722
13255
  title: string;
12723
13256
  description: string;
@@ -1,7 +1,7 @@
1
1
  export * from './gen/state';
2
2
  export declare const api: {
3
- getModelRef: (name: "Bot" | "Integration" | "Interface" | "Workspace" | "WorkspaceMember" | "Account" | "Usage" | "Issue" | "IssueEvent" | "Activity" | "Version" | "User" | "Conversation" | "Event" | "Message" | "State" | "Task" | "Table" | "Column" | "Row" | "File") => import("@bpinternal/opapi").OpenApiZodAny;
4
- addOperation: <Path extends string>(operationProps: import("@bpinternal/opapi").Operation<"x-integration-id" | "x-workspace-id", "user" | "conversation" | "event" | "message" | "state" | "hub" | "action" | "task" | "bot" | "integration" | "interface" | "workspace" | "workspaceMember" | "account" | "usage" | "quotas" | "helper" | "activity" | "tables" | "files", Path, "zod-schema">) => void;
3
+ getModelRef: (name: "Bot" | "Integration" | "Interface" | "Workspace" | "WorkspaceMember" | "Account" | "Usage" | "Issue" | "IssueEvent" | "Activity" | "Version" | "User" | "Conversation" | "Event" | "Message" | "State" | "Task" | "Workflow" | "Table" | "Column" | "Row" | "File") => import("@bpinternal/opapi").OpenApiZodAny;
4
+ addOperation: <Path extends string>(operationProps: import("@bpinternal/opapi").Operation<"x-integration-id" | "x-workspace-id", "user" | "conversation" | "event" | "message" | "state" | "hub" | "action" | "task" | "workflow" | "bot" | "integration" | "interface" | "workspace" | "workspaceMember" | "account" | "usage" | "quotas" | "helper" | "activity" | "tables" | "files", Path, "zod-schema">) => void;
5
5
  exportClient: {
6
6
  (dir: string, openapiGeneratorEndpoint: string, postProcessors?: import("@bpinternal/opapi").OpenApiPostProcessors | undefined): Promise<void>;
7
7
  (dir: string, props: import("@bpinternal/opapi").GenerateClientProps): Promise<void>;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@botpress/api",
3
- "version": "0.43.1",
3
+ "version": "0.44.0",
4
4
  "main": "dist/index.js",
5
5
  "types": "dist/src/index.d.ts",
6
6
  "scripts": {