Auto-generate SDK for FinFeedAPI SEC API REST Historical

Author: actions-bot

finfeedapi/sec-api-rest/sdk/ada/src/client/-clients.adb

@@ -163,6 +163,10 @@ package body .Clients is
    --  ### Form Types
    --  Form types can be provided as comma-separated values, e.g.: "10-K,8-K,10-Q"
    --  
+   --  ### Pagination
+   --  Results are always paginated. When `page_size` or `page_number` are omitted, defaults apply
+   --  (`page_size`: 50, `page_number`: 1). Maximum `page_size` is 200. Use `page_number` to fetch additional pages.
+   --  
    --  :::tip
    --  For optimal performance, use date ranges and form types to narrow down your search
    --  :::
@@ -229,6 +233,10 @@ package body .Clients is
    --  ### Date Format
    --  All dates must be provided in YYYY-MM-DD format
    --  
+   --  ### Pagination
+   --  Results are always paginated. When `page_size` or `page_number` are omitted, defaults apply
+   --  (`page_size`: 100, `page_number`: 1). Maximum `page_size` is 200. Use `page_number` to fetch additional pages.
+   --  
    --  :::tip
    --  Use text_contains and text_not_contain with multiple keywords separated by commas for more precise searches
    --  :::

finfeedapi/sec-api-rest/sdk/ada/src/client/-clients.ads

@@ -111,6 +111,10 @@ package .Clients is
    --  ### Form Types
    --  Form types can be provided as comma-separated values, e.g.: "10-K,8-K,10-Q"
    --  
+   --  ### Pagination
+   --  Results are always paginated. When `page_size` or `page_number` are omitted, defaults apply
+   --  (`page_size`: 50, `page_number`: 1). Maximum `page_size` is 200. Use `page_number` to fetch additional pages.
+   --  
    --  :::tip
    --  For optimal performance, use date ranges and form types to narrow down your search
    --  :::
@@ -155,6 +159,10 @@ package .Clients is
    --  ### Date Format
    --  All dates must be provided in YYYY-MM-DD format
    --  
+   --  ### Pagination
+   --  Results are always paginated. When `page_size` or `page_number` are omitted, defaults apply
+   --  (`page_size`: 100, `page_number`: 1). Maximum `page_size` is 200. Use `page_number` to fetch additional pages.
+   --  
    --  :::tip
    --  Use text_contains and text_not_contain with multiple keywords separated by commas for more precise searches
    --  :::

finfeedapi/sec-api-rest/sdk/android/docs/FilingsApi.md

@@ -14,7 +14,7 @@ Method | HTTP request | Description
 
 Query SEC filing metadata
 
-Retrieves metadata for SEC filings based on various filter criteria with pagination and sorting support.  ### Available Sort Fields  Field Name | Description -----------|------------- AccessionNumber | SEC filing accession number FilingDate | Date when filing was submitted AcceptanceDateTime | Date and time of filing acceptance ReportDate | Date of the report Size | Size of the filing document  ### Date Format All dates must be provided in YYYY-MM-DD format  ### Form Types Form types can be provided as comma-separated values, e.g.: \"10-K,8-K,10-Q\"  :::tip For optimal performance, use date ranges and form types to narrow down your search :::
+Retrieves metadata for SEC filings based on various filter criteria with pagination and sorting support.  ### Available Sort Fields  Field Name | Description -----------|------------- AccessionNumber | SEC filing accession number FilingDate | Date when filing was submitted AcceptanceDateTime | Date and time of filing acceptance ReportDate | Date of the report Size | Size of the filing document  ### Date Format All dates must be provided in YYYY-MM-DD format  ### Form Types Form types can be provided as comma-separated values, e.g.: \"10-K,8-K,10-Q\"  ### Pagination Results are always paginated. When `page_size` or `page_number` are omitted, defaults apply (`page_size`: 50, `page_number`: 1). Maximum `page_size` is 200. Use `page_number` to fetch additional pages.  :::tip For optimal performance, use date ranges and form types to narrow down your search :::
 
 ### Example
 
@@ -31,8 +31,8 @@ String fillingDateEnd = null; // String | Filter by filling date end (inclusive)
 String reportDateStart = null; // String | Filter by report date start (inclusive), format YYYY-MM-DD
 String reportDateEnd = null; // String | Filter by report date end (inclusive), format YYYY-MM-DD
 String itemsContain = null; // String | Filter filings where the 'Items' field contains the specified text
-Integer pageSize = null; // Integer | Number of results per page (default: 50, max: 200)
-Integer pageNumber = null; // Integer | Page number to retrieve (default: 1)
+Integer pageSize = null; // Integer | Number of results per page (default: 50, max: 200). Always applied; omit to use defaults.
+Integer pageNumber = null; // Integer | Page number to retrieve (default: 1). Always applied; omit to use defaults.
 DTOFilingSortBy sortBy = null; // DTOFilingSortBy | Field to sort results by (default: AccessionNumber)
 String sortOrder = desc; // String | Sort order (asc or desc, default: desc)
 try {
@@ -57,8 +57,8 @@ Name | Type | Description  | Notes
  **reportDateStart** | **String**| Filter by report date start (inclusive), format YYYY-MM-DD | [optional] [default to null]
  **reportDateEnd** | **String**| Filter by report date end (inclusive), format YYYY-MM-DD | [optional] [default to null]
  **itemsContain** | **String**| Filter filings where the 'Items' field contains the specified text | [optional] [default to null]
- **pageSize** | **Integer**| Number of results per page (default: 50, max: 200) | [optional] [default to null]
- **pageNumber** | **Integer**| Page number to retrieve (default: 1) | [optional] [default to null]
+ **pageSize** | **Integer**| Number of results per page (default: 50, max: 200). Always applied; omit to use defaults. | [optional] [default to null]
+ **pageNumber** | **Integer**| Page number to retrieve (default: 1). Always applied; omit to use defaults. | [optional] [default to null]
  **sortBy** | [**DTOFilingSortBy**](.md)| Field to sort results by (default: AccessionNumber) | [optional] [default to null] [enum: AccessionNumber, FilingDate, ReportDate, AcceptanceDateTime, Size]
  **sortOrder** | **String**| Sort order (asc or desc, default: desc) | [optional] [default to desc]
 

finfeedapi/sec-api-rest/sdk/android/docs/FullTextApi.md

@@ -14,7 +14,7 @@ Method | HTTP request | Description
 
 Full-text search of SEC filing documents
 
-Search across SEC filing documents with advanced filtering and sorting capabilities.  ### Available Sort Fields  Field Name | Description -----------|------------- AccessionNumber | SEC filing accession number FormType | Type of the filing document FilingDate | Date when filing was submitted CompanyName | Name of the company CIK | Central Index Key DocumentFilename | Name of the filing document DocumentDescription | Description of the document  ### Search Options  Option | Description --------|------------- text_contains | Keywords that must appear in the document text_not_contain | Keywords that must not appear in the document  ### Date Format All dates must be provided in YYYY-MM-DD format  :::tip Use text_contains and text_not_contain with multiple keywords separated by commas for more precise searches :::  :::note The search is case-insensitive and supports partial word matches :::
+Search across SEC filing documents with advanced filtering and sorting capabilities.  ### Available Sort Fields  Field Name | Description -----------|------------- AccessionNumber | SEC filing accession number FormType | Type of the filing document FilingDate | Date when filing was submitted CompanyName | Name of the company CIK | Central Index Key DocumentFilename | Name of the filing document DocumentDescription | Description of the document  ### Search Options  Option | Description --------|------------- text_contains | Keywords that must appear in the document text_not_contain | Keywords that must not appear in the document  ### Date Format All dates must be provided in YYYY-MM-DD format  ### Pagination Results are always paginated. When `page_size` or `page_number` are omitted, defaults apply (`page_size`: 100, `page_number`: 1). Maximum `page_size` is 200. Use `page_number` to fetch additional pages.  :::tip Use text_contains and text_not_contain with multiple keywords separated by commas for more precise searches :::  :::note The search is case-insensitive and supports partial word matches :::
 
 ### Example
 
@@ -28,8 +28,8 @@ String fillingDateStart = null; // String | Filter by filling date start (inclus
 String fillingDateEnd = null; // String | Filter by filling date end (inclusive), format YYYY-MM-DD
 String textContains = null; // String | Keywords that the text must contain. Multiple values can be comma-separated
 String textNotContain = null; // String | Keywords that the text must not contain. Multiple values can be comma-separated
-Integer pageSize = null; // Integer | Number of results per page (default: 100)
-Integer pageNumber = null; // Integer | Page number to retrieve (default: 1)
+Integer pageSize = null; // Integer | Number of results per page (default: 100, max: 200). Always applied; omit to use defaults.
+Integer pageNumber = null; // Integer | Page number to retrieve (default: 1). Always applied; omit to use defaults.
 String sortBy = AccessionNumber; // String | Field to sort by (default: AccessionNumber)
 String sortOrder = asc; // String | Sort order (asc or desc). Defaults to asc
 try {
@@ -51,8 +51,8 @@ Name | Type | Description  | Notes
  **fillingDateEnd** | **String**| Filter by filling date end (inclusive), format YYYY-MM-DD | [optional] [default to null]
  **textContains** | **String**| Keywords that the text must contain. Multiple values can be comma-separated | [optional] [default to null]
  **textNotContain** | **String**| Keywords that the text must not contain. Multiple values can be comma-separated | [optional] [default to null]
- **pageSize** | **Integer**| Number of results per page (default: 100) | [optional] [default to null]
- **pageNumber** | **Integer**| Page number to retrieve (default: 1) | [optional] [default to null]
+ **pageSize** | **Integer**| Number of results per page (default: 100, max: 200). Always applied; omit to use defaults. | [optional] [default to null]
+ **pageNumber** | **Integer**| Page number to retrieve (default: 1). Always applied; omit to use defaults. | [optional] [default to null]
  **sortBy** | **String**| Field to sort by (default: AccessionNumber) | [optional] [default to AccessionNumber]
  **sortOrder** | **String**| Sort order (asc or desc). Defaults to asc | [optional] [default to asc]
 

finfeedapi/sec-api-rest/sdk/android/src/main/java/org/openapitools/client/api/FilingsApi.java

@@ -61,7 +61,7 @@ public String getBasePath() {
 
   /**
   * Query SEC filing metadata
-  * Retrieves metadata for SEC filings based on various filter criteria with pagination and sorting support.  ### Available Sort Fields  Field Name | Description -----------|------------- AccessionNumber | SEC filing accession number FilingDate | Date when filing was submitted AcceptanceDateTime | Date and time of filing acceptance ReportDate | Date of the report Size | Size of the filing document  ### Date Format All dates must be provided in YYYY-MM-DD format  ### Form Types Form types can be provided as comma-separated values, e.g.: \"10-K,8-K,10-Q\"  :::tip For optimal performance, use date ranges and form types to narrow down your search :::
+  * Retrieves metadata for SEC filings based on various filter criteria with pagination and sorting support.  ### Available Sort Fields  Field Name | Description -----------|------------- AccessionNumber | SEC filing accession number FilingDate | Date when filing was submitted AcceptanceDateTime | Date and time of filing acceptance ReportDate | Date of the report Size | Size of the filing document  ### Date Format All dates must be provided in YYYY-MM-DD format  ### Form Types Form types can be provided as comma-separated values, e.g.: \"10-K,8-K,10-Q\"  ### Pagination Results are always paginated. When `page_size` or `page_number` are omitted, defaults apply (`page_size`: 50, `page_number`: 1). Maximum `page_size` is 200. Use `page_number` to fetch additional pages.  :::tip For optimal performance, use date ranges and form types to narrow down your search :::
    * @param cik Filter by Central Index Key (CIK)
    * @param ticker Filter by stock ticker symbol
    * @param formType Filter by form type(s) (e.g., \"10-K\", \"8-K\"). Multiple values can be comma-separated
@@ -70,8 +70,8 @@ public String getBasePath() {
    * @param reportDateStart Filter by report date start (inclusive), format YYYY-MM-DD
    * @param reportDateEnd Filter by report date end (inclusive), format YYYY-MM-DD
    * @param itemsContain Filter filings where the 'Items' field contains the specified text
-   * @param pageSize Number of results per page (default: 50, max: 200)
-   * @param pageNumber Page number to retrieve (default: 1)
+   * @param pageSize Number of results per page (default: 50, max: 200). Always applied; omit to use defaults.
+   * @param pageNumber Page number to retrieve (default: 1). Always applied; omit to use defaults.
    * @param sortBy Field to sort results by (default: AccessionNumber)
    * @param sortOrder Sort order (asc or desc, default: desc)
    * @return List<DTOFilingMetadataDto>
@@ -141,8 +141,8 @@ public List<DTOFilingMetadataDto> v1FilingsGet (Long cik, String ticker, String
 
       /**
    * Query SEC filing metadata
-   * Retrieves metadata for SEC filings based on various filter criteria with pagination and sorting support.  ### Available Sort Fields  Field Name | Description -----------|------------- AccessionNumber | SEC filing accession number FilingDate | Date when filing was submitted AcceptanceDateTime | Date and time of filing acceptance ReportDate | Date of the report Size | Size of the filing document  ### Date Format All dates must be provided in YYYY-MM-DD format  ### Form Types Form types can be provided as comma-separated values, e.g.: \&quot;10-K,8-K,10-Q\&quot;  :::tip For optimal performance, use date ranges and form types to narrow down your search :::
-   * @param cik Filter by Central Index Key (CIK)   * @param ticker Filter by stock ticker symbol   * @param formType Filter by form type(s) (e.g., \&quot;10-K\&quot;, \&quot;8-K\&quot;). Multiple values can be comma-separated   * @param fillingDateStart Filter by filling date start (inclusive), format YYYY-MM-DD   * @param fillingDateEnd Filter by filling date end (inclusive), format YYYY-MM-DD   * @param reportDateStart Filter by report date start (inclusive), format YYYY-MM-DD   * @param reportDateEnd Filter by report date end (inclusive), format YYYY-MM-DD   * @param itemsContain Filter filings where the &#39;Items&#39; field contains the specified text   * @param pageSize Number of results per page (default: 50, max: 200)   * @param pageNumber Page number to retrieve (default: 1)   * @param sortBy Field to sort results by (default: AccessionNumber)   * @param sortOrder Sort order (asc or desc, default: desc)
+   * Retrieves metadata for SEC filings based on various filter criteria with pagination and sorting support.  ### Available Sort Fields  Field Name | Description -----------|------------- AccessionNumber | SEC filing accession number FilingDate | Date when filing was submitted AcceptanceDateTime | Date and time of filing acceptance ReportDate | Date of the report Size | Size of the filing document  ### Date Format All dates must be provided in YYYY-MM-DD format  ### Form Types Form types can be provided as comma-separated values, e.g.: \&quot;10-K,8-K,10-Q\&quot;  ### Pagination Results are always paginated. When &#x60;page_size&#x60; or &#x60;page_number&#x60; are omitted, defaults apply (&#x60;page_size&#x60;: 50, &#x60;page_number&#x60;: 1). Maximum &#x60;page_size&#x60; is 200. Use &#x60;page_number&#x60; to fetch additional pages.  :::tip For optimal performance, use date ranges and form types to narrow down your search :::
+   * @param cik Filter by Central Index Key (CIK)   * @param ticker Filter by stock ticker symbol   * @param formType Filter by form type(s) (e.g., \&quot;10-K\&quot;, \&quot;8-K\&quot;). Multiple values can be comma-separated   * @param fillingDateStart Filter by filling date start (inclusive), format YYYY-MM-DD   * @param fillingDateEnd Filter by filling date end (inclusive), format YYYY-MM-DD   * @param reportDateStart Filter by report date start (inclusive), format YYYY-MM-DD   * @param reportDateEnd Filter by report date end (inclusive), format YYYY-MM-DD   * @param itemsContain Filter filings where the &#39;Items&#39; field contains the specified text   * @param pageSize Number of results per page (default: 50, max: 200). Always applied; omit to use defaults.   * @param pageNumber Page number to retrieve (default: 1). Always applied; omit to use defaults.   * @param sortBy Field to sort results by (default: AccessionNumber)   * @param sortOrder Sort order (asc or desc, default: desc)
   */
   public void v1FilingsGet (Long cik, String ticker, String formType, String fillingDateStart, String fillingDateEnd, String reportDateStart, String reportDateEnd, String itemsContain, Integer pageSize, Integer pageNumber, DTOFilingSortBy sortBy, String sortOrder, final Response.Listener<List<DTOFilingMetadataDto>> responseListener, final Response.ErrorListener errorListener) {
     Object postBody = null;