Skip to content

feat(sdk): v4.8.0 - Auto-generated from unified API spec #76

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
quant-sdk wants to merge 1 commit into
base: v4
Choose a base branch
from
Open

feat(sdk): v4.8.0 - Auto-generated from unified API spec #76

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
376 changes: 187 additions & 189 deletions api.ts
View file
Open in desktop

Large diffs are not rendered by default.

21 changes: 10 additions & 11 deletions docs/CrawlersApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ const apiInstance = new CrawlersApi(configuration);

let organization: string; //Organization identifier (default to undefined)
let project: string; //Project identifier (default to undefined)
let crawler: string; // (default to undefined)
let crawler: string; //The UUID of the crawler (default to undefined)

const { status, data } = await apiInstance.crawlersDelete(
organization,
Expand All @@ -104,7 +104,7 @@ const { status, data } = await apiInstance.crawlersDelete(
|------------- | ------------- | ------------- | -------------|
| **organization** | [**string**] | Organization identifier | defaults to undefined|
| **project** | [**string**] | Project identifier | defaults to undefined|
| **crawler** | [**string**] | | defaults to undefined|
| **crawler** | [**string**] | The UUID of the crawler | defaults to undefined|


### Return type
Expand Down Expand Up @@ -254,7 +254,7 @@ const { status, data } = await apiInstance.crawlersGetRuns(
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **crawlersList**
> Array<V2Crawler> crawlersList()
> crawlersList()


### Example
Expand Down Expand Up @@ -287,7 +287,7 @@ const { status, data } = await apiInstance.crawlersList(

### Return type

**Array<V2Crawler>**
void (empty response body)

### Authorization

Expand All @@ -302,7 +302,6 @@ const { status, data } = await apiInstance.crawlersList(
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | The request has succeeded. | - |
|**400** | The server could not understand the request due to invalid syntax. | - |
|**403** | Access is forbidden. | - |

Expand All @@ -325,7 +324,7 @@ const apiInstance = new CrawlersApi(configuration);

let organization: string; //Organization identifier (default to undefined)
let project: string; //Project identifier (default to undefined)
let crawler: string; // (default to undefined)
let crawler: string; //The UUID of the crawler (default to undefined)

const { status, data } = await apiInstance.crawlersRead(
organization,
Expand All @@ -340,7 +339,7 @@ const { status, data } = await apiInstance.crawlersRead(
|------------- | ------------- | ------------- | -------------|
| **organization** | [**string**] | Organization identifier | defaults to undefined|
| **project** | [**string**] | Project identifier | defaults to undefined|
| **crawler** | [**string**] | | defaults to undefined|
| **crawler** | [**string**] | The UUID of the crawler | defaults to undefined|


### Return type
Expand All @@ -367,7 +366,7 @@ const { status, data } = await apiInstance.crawlersRead(
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **crawlersRun**
> CrawlersRun200Response crawlersRun(crawlersRunRequest)
> CrawlersRun200Response crawlersRun()


### Example
Expand All @@ -385,7 +384,7 @@ const apiInstance = new CrawlersApi(configuration);
let organization: string; //Organization identifier (default to undefined)
let project: string; //Project identifier (default to undefined)
let crawler: string; //Crawler identifier (default to undefined)
let crawlersRunRequest: CrawlersRunRequest; //
let crawlersRunRequest: CrawlersRunRequest; // (optional)

const { status, data } = await apiInstance.crawlersRun(
organization,
Expand Down Expand Up @@ -448,7 +447,7 @@ const apiInstance = new CrawlersApi(configuration);

let organization: string; //Organization identifier (default to undefined)
let project: string; //Project identifier (default to undefined)
let crawler: string; // (default to undefined)
let crawler: string; //The UUID of the crawler (default to undefined)
let v2CrawlerRequest: V2CrawlerRequest; //

const { status, data } = await apiInstance.crawlersUpdate(
Expand All @@ -466,7 +465,7 @@ const { status, data } = await apiInstance.crawlersUpdate(
| **v2CrawlerRequest** | **V2CrawlerRequest**| | |
| **organization** | [**string**] | Organization identifier | defaults to undefined|
| **project** | [**string**] | Project identifier | defaults to undefined|
| **crawler** | [**string**] | | defaults to undefined|
| **crawler** | [**string**] | The UUID of the crawler | defaults to undefined|


### Return type
Expand Down
2 changes: 1 addition & 1 deletion docs/CrawlersRunRequest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**urls** | **Array&lt;string&gt;** | URLs to crawl | [optional] [default to undefined]
**urls** | **Array&lt;string&gt;** | Optional URLs to crawl (overrides crawler\&#39;s default URL configuration). If not provided, the crawler will use its configured URLs or perform a full crawl. | [optional] [default to undefined]

## Example

Expand Down
12 changes: 6 additions & 6 deletions docs/DomainsApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ const apiInstance = new DomainsApi(configuration);

let organization: string; //Organization identifier (default to undefined)
let project: string; //Project identifier (default to undefined)
let domain: string; //Domain identifier (default to undefined)
let domain: string; //Domain id (default to undefined)

const { status, data } = await apiInstance.domainsDelete(
organization,
Expand All @@ -101,7 +101,7 @@ const { status, data } = await apiInstance.domainsDelete(
|------------- | ------------- | ------------- | -------------|
| **organization** | [**string**] | Organization identifier | defaults to undefined|
| **project** | [**string**] | Project identifier | defaults to undefined|
| **domain** | [**string**] | Domain identifier | defaults to undefined|
| **domain** | [**string**] | Domain id | defaults to undefined|


### Return type
Expand Down Expand Up @@ -199,7 +199,7 @@ const apiInstance = new DomainsApi(configuration);

let organization: string; //Organization identifier (default to undefined)
let project: string; //Project identifier (default to undefined)
let domain: string; //Domain identifier (default to undefined)
let domain: string; //Domain id (default to undefined)

const { status, data } = await apiInstance.domainsRead(
organization,
Expand All @@ -214,7 +214,7 @@ const { status, data } = await apiInstance.domainsRead(
|------------- | ------------- | ------------- | -------------|
| **organization** | [**string**] | Organization identifier | defaults to undefined|
| **project** | [**string**] | Project identifier | defaults to undefined|
| **domain** | [**string**] | Domain identifier | defaults to undefined|
| **domain** | [**string**] | Domain id | defaults to undefined|


### Return type
Expand Down Expand Up @@ -257,7 +257,7 @@ const apiInstance = new DomainsApi(configuration);

let organization: string; //Organization identifier (default to undefined)
let project: string; //Project identifier (default to undefined)
let domain: string; //Domain identifier (default to undefined)
let domain: string; //Domain id (default to undefined)

const { status, data } = await apiInstance.domainsRenew(
organization,
Expand All @@ -272,7 +272,7 @@ const { status, data } = await apiInstance.domainsRenew(
|------------- | ------------- | ------------- | -------------|
| **organization** | [**string**] | Organization identifier | defaults to undefined|
| **project** | [**string**] | Project identifier | defaults to undefined|
| **domain** | [**string**] | Domain identifier | defaults to undefined|
| **domain** | [**string**] | Domain id | defaults to undefined|


### Return type
Expand Down
24 changes: 12 additions & 12 deletions docs/HeadersApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ import {
const configuration = new Configuration();
const apiInstance = new HeadersApi(configuration);

let organization: string; // (default to undefined)
let project: string; // (default to undefined)
let organization: string; //Organization identifier (default to undefined)
let project: string; //Project identifier (default to undefined)
let v2CustomHeaderRequest: V2CustomHeaderRequest; //

const { status, data } = await apiInstance.headersCreate(
Expand All @@ -40,8 +40,8 @@ const { status, data } = await apiInstance.headersCreate(
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **v2CustomHeaderRequest** | **V2CustomHeaderRequest**| | |
| **organization** | [**string**] | | defaults to undefined|
| **project** | [**string**] | | defaults to undefined|
| **organization** | [**string**] | Organization identifier | defaults to undefined|
| **project** | [**string**] | Project identifier | defaults to undefined|


### Return type
Expand Down Expand Up @@ -83,8 +83,8 @@ import {
const configuration = new Configuration();
const apiInstance = new HeadersApi(configuration);

let organization: string; // (default to undefined)
let project: string; // (default to undefined)
let organization: string; //Organization identifier (default to undefined)
let project: string; //Project identifier (default to undefined)
let v2CustomHeaderRequest: V2CustomHeaderRequest; //

const { status, data } = await apiInstance.headersDelete(
Expand All @@ -99,8 +99,8 @@ const { status, data } = await apiInstance.headersDelete(
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **v2CustomHeaderRequest** | **V2CustomHeaderRequest**| | |
| **organization** | [**string**] | | defaults to undefined|
| **project** | [**string**] | | defaults to undefined|
| **organization** | [**string**] | Organization identifier | defaults to undefined|
| **project** | [**string**] | Project identifier | defaults to undefined|


### Return type
Expand Down Expand Up @@ -141,8 +141,8 @@ import {
const configuration = new Configuration();
const apiInstance = new HeadersApi(configuration);

let organization: string; // (default to undefined)
let project: string; // (default to undefined)
let organization: string; //Organization identifier (default to undefined)
let project: string; //Project identifier (default to undefined)

const { status, data } = await apiInstance.headersList(
organization,
Expand All @@ -154,8 +154,8 @@ const { status, data } = await apiInstance.headersList(

|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **organization** | [**string**] | | defaults to undefined|
| **project** | [**string**] | | defaults to undefined|
| **organization** | [**string**] | Organization identifier | defaults to undefined|
| **project** | [**string**] | Project identifier | defaults to undefined|


### Return type
Expand Down
Loading