kalshi-typescript 3.0.0 → 3.3.0

package/docs/PortfolioApi.md

@@ -1,189 +0,0 @@
-# PortfolioApi
-
-All URIs are relative to *https://api.elections.kalshi.com/trade-api/v2*
-
-|Method | HTTP request | Description|
-|------------- | ------------- | -------------|
-|[**getBalance**](#getbalance) | **GET** /portfolio/balance | Get Balance|
-|[**getFills**](#getfills) | **GET** /portfolio/fills | Get Fills|
-|[**getPortfolioRestingOrderTotalValue**](#getportfoliorestingordertotalvalue) | **GET** /portfolio/summary/total_resting_order_value | Get Total Resting Order Value|
-|[**getPositions**](#getpositions) | **GET** /portfolio/positions | Get Positions|
-|[**getSettlements**](#getsettlements) | **GET** /portfolio/settlements | Get Settlements|
-
-# **getBalance**
-> GetBalanceResponse getBalance()
-
- Endpoint for getting the balance and portfolio value of a member. Both values are returned in cents.
-
-### Parameters
-This endpoint does not have any parameters.
-
-
-### Return type
-
-**GetBalanceResponse**
-
-### Authorization
-
-[kalshiAccessSignature](../README.md#kalshiAccessSignature), [kalshiAccessKey](../README.md#kalshiAccessKey), [kalshiAccessTimestamp](../README.md#kalshiAccessTimestamp)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Balance retrieved successfully |  -  |
-|**401** | Unauthorized - authentication required |  -  |
-|**500** | Internal server error |  -  |
-
-# **getFills**
-> GetFillsResponse getFills()
-
- Endpoint for getting all fills for the member. A fill is when a trade you have is matched.
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **ticker** | [**string**] | Filter by market ticker | (optional) defaults to undefined|
-| **orderId** | [**string**] | Filter by order ID | (optional) defaults to undefined|
-| **minTs** | [**number**] | Filter items after this Unix timestamp | (optional) defaults to undefined|
-| **maxTs** | [**number**] | Filter items before this Unix timestamp | (optional) defaults to undefined|
-| **limit** | [**number**] | Number of results per page. Defaults to 100. Maximum value is 200. | (optional) defaults to 100|
-| **cursor** | [**string**] | Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page. | (optional) defaults to undefined|
-
-
-### Return type
-
-**GetFillsResponse**
-
-### Authorization
-
-[kalshiAccessSignature](../README.md#kalshiAccessSignature), [kalshiAccessKey](../README.md#kalshiAccessKey), [kalshiAccessTimestamp](../README.md#kalshiAccessTimestamp)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Fills retrieved successfully |  -  |
-|**400** | Bad request |  -  |
-|**401** | Unauthorized |  -  |
-|**500** | Internal server error |  -  |
-
-# **getPortfolioRestingOrderTotalValue**
-> GetPortfolioRestingOrderTotalValueResponse getPortfolioRestingOrderTotalValue()
-
- Endpoint for getting the total value, in cents, of resting orders. This endpoint is only intended for use by FCM members (rare). Note: If you\'re uncertain about this endpoint, it likely does not apply to you.
-
-### Parameters
-This endpoint does not have any parameters.
-
-
-### Return type
-
-**GetPortfolioRestingOrderTotalValueResponse**
-
-### Authorization
-
-[kalshiAccessSignature](../README.md#kalshiAccessSignature), [kalshiAccessKey](../README.md#kalshiAccessKey), [kalshiAccessTimestamp](../README.md#kalshiAccessTimestamp)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Total resting order value retrieved successfully |  -  |
-|**401** | Unauthorized - authentication required |  -  |
-|**500** | Internal server error |  -  |
-
-# **getPositions**
-> GetPositionsResponse getPositions()
-
-Restricts the positions to those with any of following fields with non-zero values, as a comma separated list. The following values are accepted: position, total_traded
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **cursor** | [**string**] | The Cursor represents a pointer to the next page of records in the pagination. Use the value returned from the previous response to get the next page. | (optional) defaults to undefined|
-| **limit** | [**number**] | Parameter to specify the number of results per page. Defaults to 100. | (optional) defaults to 100|
-| **countFilter** | [**string**] | Restricts the positions to those with any of following fields with non-zero values, as a comma separated list. The following values are accepted - position, total_traded | (optional) defaults to undefined|
-| **settlementStatus** | [**&#39;all&#39; | &#39;unsettled&#39; | &#39;settled&#39;**]**Array<&#39;all&#39; &#124; &#39;unsettled&#39; &#124; &#39;settled&#39;>** | Settlement status of the markets to return. Defaults to unsettled. | (optional) defaults to 'unsettled'|
-| **ticker** | [**string**] | Filter by market ticker | (optional) defaults to undefined|
-| **eventTicker** | [**string**] | Event ticker of desired positions. Multiple event tickers can be provided as a comma-separated list (maximum 10). | (optional) defaults to undefined|
-
-
-### Return type
-
-**GetPositionsResponse**
-
-### Authorization
-
-[kalshiAccessSignature](../README.md#kalshiAccessSignature), [kalshiAccessKey](../README.md#kalshiAccessKey), [kalshiAccessTimestamp](../README.md#kalshiAccessTimestamp)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Positions retrieved successfully |  -  |
-|**400** | Bad request - invalid input |  -  |
-|**401** | Unauthorized - authentication required |  -  |
-|**500** | Internal server error |  -  |
-
-# **getSettlements**
-> GetSettlementsResponse getSettlements()
-
- Endpoint for getting the member\'s settlements historical track.
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **limit** | [**number**] | Number of results per page. Defaults to 100. Maximum value is 200. | (optional) defaults to 100|
-| **cursor** | [**string**] | Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page. | (optional) defaults to undefined|
-| **ticker** | [**string**] | Filter by market ticker | (optional) defaults to undefined|
-| **eventTicker** | [**string**] | Event ticker of desired positions. Multiple event tickers can be provided as a comma-separated list (maximum 10). | (optional) defaults to undefined|
-| **minTs** | [**number**] | Filter items after this Unix timestamp | (optional) defaults to undefined|
-| **maxTs** | [**number**] | Filter items before this Unix timestamp | (optional) defaults to undefined|
-
-
-### Return type
-
-**GetSettlementsResponse**
-
-### Authorization
-
-[kalshiAccessSignature](../README.md#kalshiAccessSignature), [kalshiAccessKey](../README.md#kalshiAccessKey), [kalshiAccessTimestamp](../README.md#kalshiAccessTimestamp)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Settlements retrieved successfully |  -  |
-|**400** | Bad request - invalid input |  -  |
-|**401** | Unauthorized - authentication required |  -  |
-|**500** | Internal server error |  -  |
-

package/docs/Position.md

@@ -1,34 +0,0 @@
-# Position
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**ticker** | **string** |  | [optional] [default to undefined]
-**event_ticker** | **string** |  | [optional] [default to undefined]
-**market_result** | **string** |  | [optional] [default to undefined]
-**realized_pnl** | **number** |  | [optional] [default to undefined]
-**resting_order_count** | **number** |  | [optional] [default to undefined]
-**position** | **number** |  | [optional] [default to undefined]
-**fees_paid** | **number** |  | [optional] [default to undefined]
-**total_cost** | **number** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { Position } from 'kalshi-typescript';
-
-const instance: Position = {
-    ticker,
-    event_ticker,
-    market_result,
-    realized_pnl,
-    resting_order_count,
-    position,
-    fees_paid,
-    total_cost,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/PriceDistribution.md

@@ -1,50 +0,0 @@
-# PriceDistribution
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**open** | **number** | First traded YES contract price on the market during the candlestick period (in cents). May be null if there was no trade during the period. | [optional] [default to undefined]
-**open_dollars** | **string** | US dollar amount as a fixed-point decimal string with exactly 4 decimal places | [optional] [default to undefined]
-**low** | **number** | Lowest traded YES contract price on the market during the candlestick period (in cents). May be null if there was no trade during the period. | [optional] [default to undefined]
-**low_dollars** | **string** | US dollar amount as a fixed-point decimal string with exactly 4 decimal places | [optional] [default to undefined]
-**high** | **number** | Highest traded YES contract price on the market during the candlestick period (in cents). May be null if there was no trade during the period. | [optional] [default to undefined]
-**high_dollars** | **string** | US dollar amount as a fixed-point decimal string with exactly 4 decimal places | [optional] [default to undefined]
-**close** | **number** | Last traded YES contract price on the market during the candlestick period (in cents). May be null if there was no trade during the period. | [optional] [default to undefined]
-**close_dollars** | **string** | US dollar amount as a fixed-point decimal string with exactly 4 decimal places | [optional] [default to undefined]
-**mean** | **number** | Mean traded YES contract price on the market during the candlestick period (in cents). May be null if there was no trade during the period. | [optional] [default to undefined]
-**mean_dollars** | **string** | US dollar amount as a fixed-point decimal string with exactly 4 decimal places | [optional] [default to undefined]
-**previous** | **number** | Last traded YES contract price on the market before the candlestick period (in cents). May be null if there were no trades before the period. | [optional] [default to undefined]
-**previous_dollars** | **string** | US dollar amount as a fixed-point decimal string with exactly 4 decimal places | [optional] [default to undefined]
-**min** | **number** | Minimum close price of any market during the candlestick period (in cents). | [optional] [default to undefined]
-**min_dollars** | **string** | US dollar amount as a fixed-point decimal string with exactly 4 decimal places | [optional] [default to undefined]
-**max** | **number** | Maximum close price of any market during the candlestick period (in cents). | [optional] [default to undefined]
-**max_dollars** | **string** | US dollar amount as a fixed-point decimal string with exactly 4 decimal places | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { PriceDistribution } from 'kalshi-typescript';
-
-const instance: PriceDistribution = {
-    open,
-    open_dollars,
-    low,
-    low_dollars,
-    high,
-    high_dollars,
-    close,
-    close_dollars,
-    mean,
-    mean_dollars,
-    previous,
-    previous_dollars,
-    min,
-    min_dollars,
-    max,
-    max_dollars,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/PriceRange.md

@@ -1,24 +0,0 @@
-# PriceRange
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**start** | **string** | Starting price for this range in dollars | [default to undefined]
-**end** | **string** | Ending price for this range in dollars | [default to undefined]
-**step** | **string** | Price step/tick size for this range in dollars | [default to undefined]
-
-## Example
-
-```typescript
-import { PriceRange } from 'kalshi-typescript';
-
-const instance: PriceRange = {
-    start,
-    end,
-    step,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/Quote.md

@@ -1,68 +0,0 @@
-# Quote
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **string** | Unique identifier for the quote | [default to undefined]
-**rfq_id** | **string** | ID of the RFQ this quote is responding to | [default to undefined]
-**creator_id** | **string** | Public communications ID of the quote creator | [default to undefined]
-**rfq_creator_id** | **string** | Public communications ID of the RFQ creator | [default to undefined]
-**market_ticker** | **string** | The ticker of the market this quote is for | [default to undefined]
-**contracts** | **number** | Number of contracts in the quote | [default to undefined]
-**yes_bid** | **number** | Bid price for YES contracts, in cents | [default to undefined]
-**no_bid** | **number** | Bid price for NO contracts, in cents | [default to undefined]
-**yes_bid_dollars** | **string** | US dollar amount as a fixed-point decimal string with exactly 4 decimal places | [default to undefined]
-**no_bid_dollars** | **string** | US dollar amount as a fixed-point decimal string with exactly 4 decimal places | [default to undefined]
-**created_ts** | **string** | Timestamp when the quote was created | [default to undefined]
-**updated_ts** | **string** | Timestamp when the quote was last updated | [default to undefined]
-**status** | **string** | Current status of the quote | [default to undefined]
-**accepted_side** | **string** | The side that was accepted (yes or no) | [optional] [default to undefined]
-**accepted_ts** | **string** | Timestamp when the quote was accepted | [optional] [default to undefined]
-**confirmed_ts** | **string** | Timestamp when the quote was confirmed | [optional] [default to undefined]
-**executed_ts** | **string** | Timestamp when the quote was executed | [optional] [default to undefined]
-**cancelled_ts** | **string** | Timestamp when the quote was cancelled | [optional] [default to undefined]
-**rest_remainder** | **boolean** | Whether to rest the remainder of the quote after execution | [optional] [default to undefined]
-**cancellation_reason** | **string** | Reason for quote cancellation if cancelled | [optional] [default to undefined]
-**creator_user_id** | **string** | User ID of the quote creator (private field) | [optional] [default to undefined]
-**rfq_creator_user_id** | **string** | User ID of the RFQ creator (private field) | [optional] [default to undefined]
-**rfq_target_cost_centi_cents** | **number** | Total value requested in the RFQ in centi-cents | [optional] [default to undefined]
-**rfq_creator_order_id** | **string** | Order ID for the RFQ creator (private field) | [optional] [default to undefined]
-**creator_order_id** | **string** | Order ID for the quote creator (private field) | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { Quote } from 'kalshi-typescript';
-
-const instance: Quote = {
-    id,
-    rfq_id,
-    creator_id,
-    rfq_creator_id,
-    market_ticker,
-    contracts,
-    yes_bid,
-    no_bid,
-    yes_bid_dollars,
-    no_bid_dollars,
-    created_ts,
-    updated_ts,
-    status,
-    accepted_side,
-    accepted_ts,
-    confirmed_ts,
-    executed_ts,
-    cancelled_ts,
-    rest_remainder,
-    cancellation_reason,
-    creator_user_id,
-    rfq_creator_user_id,
-    rfq_target_cost_centi_cents,
-    rfq_creator_order_id,
-    creator_order_id,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/RFQ.md

@@ -1,46 +0,0 @@
-# RFQ
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **string** | Unique identifier for the RFQ | [default to undefined]
-**creator_id** | **string** | Public communications ID of the RFQ creator | [default to undefined]
-**market_ticker** | **string** | The ticker of the market this RFQ is for | [default to undefined]
-**contracts** | **number** | Number of contracts requested in the RFQ | [default to undefined]
-**target_cost_centi_cents** | **number** | Total value of the RFQ in centi-cents | [optional] [default to undefined]
-**status** | **string** | Current status of the RFQ (open, closed) | [default to undefined]
-**created_ts** | **string** | Timestamp when the RFQ was created | [default to undefined]
-**mve_collection_ticker** | **string** | Ticker of the MVE collection this market belongs to | [optional] [default to undefined]
-**mve_selected_legs** | [**Array<MveSelectedLeg>**](MveSelectedLeg.md) | Selected legs for the MVE collection | [optional] [default to undefined]
-**rest_remainder** | **boolean** | Whether to rest the remainder of the RFQ after execution | [optional] [default to undefined]
-**cancellation_reason** | **string** | Reason for RFQ cancellation if cancelled | [optional] [default to undefined]
-**creator_user_id** | **string** | User ID of the RFQ creator (private field) | [optional] [default to undefined]
-**cancelled_ts** | **string** | Timestamp when the RFQ was cancelled | [optional] [default to undefined]
-**updated_ts** | **string** | Timestamp when the RFQ was last updated | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { RFQ } from 'kalshi-typescript';
-
-const instance: RFQ = {
-    id,
-    creator_id,
-    market_ticker,
-    contracts,
-    target_cost_centi_cents,
-    status,
-    created_ts,
-    mve_collection_ticker,
-    mve_selected_legs,
-    rest_remainder,
-    cancellation_reason,
-    creator_user_id,
-    cancelled_ts,
-    updated_ts,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/Schedule.md

@@ -1,22 +0,0 @@
-# Schedule
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**standard_hours** | [**Array<WeeklySchedule>**](WeeklySchedule.md) | The standard operating hours of the exchange. All times are expressed in ET. Outside of these times trading will be unavailable. | [default to undefined]
-**maintenance_windows** | [**Array<MaintenanceWindow>**](MaintenanceWindow.md) | Scheduled maintenance windows, during which the exchange may be unavailable. | [default to undefined]
-
-## Example
-
-```typescript
-import { Schedule } from 'kalshi-typescript';
-
-const instance: Schedule = {
-    standard_hours,
-    maintenance_windows,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/ScopeList.md

@@ -1,20 +0,0 @@
-# ScopeList
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**scopes** | **Array<string>** | List of scopes | [default to undefined]
-
-## Example
-
-```typescript
-import { ScopeList } from 'kalshi-typescript';
-
-const instance: ScopeList = {
-    scopes,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/SearchApi.md

@@ -1,69 +0,0 @@
-# SearchApi
-
-All URIs are relative to *https://api.elections.kalshi.com/trade-api/v2*
-
-|Method | HTTP request | Description|
-|------------- | ------------- | -------------|
-|[**getFiltersForSports**](#getfiltersforsports) | **GET** /search/filters_by_sport | Get Filters for Sports|
-|[**getTagsForSeriesCategories**](#gettagsforseriescategories) | **GET** /search/tags_by_categories | Get Tags for Series Categories|
-
-# **getFiltersForSports**
-> GetFiltersBySportsResponse getFiltersForSports()
-
-Retrieve available filters organized by sport.  This endpoint returns filtering options available for each sport, including scopes and competitions. It also provides an ordered list of sports for display purposes. 
-
-### Parameters
-This endpoint does not have any parameters.
-
-
-### Return type
-
-**GetFiltersBySportsResponse**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Filters retrieved successfully |  -  |
-|**401** | Unauthorized |  -  |
-|**500** | Internal server error |  -  |
-
-# **getTagsForSeriesCategories**
-> GetTagsForSeriesCategoriesResponse getTagsForSeriesCategories()
-
-Retrieve tags organized by series categories.  This endpoint returns a mapping of series categories to their associated tags, which can be used for filtering and search functionality. 
-
-### Parameters
-This endpoint does not have any parameters.
-
-
-### Return type
-
-**GetTagsForSeriesCategoriesResponse**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Tags retrieved successfully |  -  |
-|**401** | Unauthorized |  -  |
-|**500** | Internal server error |  -  |
-

package/docs/SelfTradePreventionType.md

@@ -1,11 +0,0 @@
-# SelfTradePreventionType
-
-The self-trade prevention type for orders
-
-## Enum
-
-* `TakerAtCross` (value: `'taker_at_cross'`)
-
-* `Maker` (value: `'maker'`)
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/Series.md

@@ -1,42 +0,0 @@
-# Series
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**ticker** | **string** | Ticker that identifies this series. | [default to undefined]
-**frequency** | **string** | Description of the frequency of the series. There is no fixed value set here, but will be something human-readable like weekly, daily, one-off. | [default to undefined]
-**title** | **string** | Title describing the series. For full context use you should use this field with the title field of the events belonging to this series. | [default to undefined]
-**category** | **string** | Category specifies the category which this series belongs to. | [default to undefined]
-**tags** | **Array<string>** | Tags specifies the subjects that this series relates to, multiple series from different categories can have the same tags. | [default to undefined]
-**settlement_sources** | [**Array<SettlementSource>**](SettlementSource.md) | SettlementSources specifies the official sources used for the determination of markets within the series. Methodology is defined in the rulebook. | [default to undefined]
-**contract_url** | **string** | ContractUrl provides a direct link to the original filing of the contract which underlies the series. | [default to undefined]
-**contract_terms_url** | **string** | ContractTermsUrl is the URL to the current terms of the contract underlying the series. | [default to undefined]
-**product_metadata** | **object** | Internal product metadata of the series. | [optional] [default to undefined]
-**fee_type** | **string** | FeeType is a string representing the series\' fee structure. Fee structures can be found at https://kalshi.com/docs/kalshi-fee-schedule.pdf. \'quadratic\' is described by the General Trading Fees Table, \'quadratic_with_maker_fees\' is described by the General Trading Fees Table with maker fees described in the Maker Fees section, \'flat\' is described by the Specific Trading Fees Table. | [default to undefined]
-**fee_multiplier** | **number** | FeeMultiplier is a floating point multiplier applied to the fee calculations. | [default to undefined]
-**additional_prohibitions** | **Array<string>** | AdditionalProhibitions is a list of additional trading prohibitions for this series. | [default to undefined]
-
-## Example
-
-```typescript
-import { Series } from 'kalshi-typescript';
-
-const instance: Series = {
-    ticker,
-    frequency,
-    title,
-    category,
-    tags,
-    settlement_sources,
-    contract_url,
-    contract_terms_url,
-    product_metadata,
-    fee_type,
-    fee_multiplier,
-    additional_prohibitions,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)