Skip to content
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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore: Regenerate interal OpenAPI clients #1750

Merged
merged 1 commit into from
May 9, 2024
Merged

chore: Regenerate interal OpenAPI clients #1750

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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
66 changes: 51 additions & 15 deletions packages/internal/generated-clients/src/mr-openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1210,6 +1210,17 @@
},
"example": "0x8a90cab2b38dba80c64b7734e58ee1db38b8992e"
},
{
"name": "from_updated_at",
"in": "query",
"description": "Datetime to use as the oldest updated timestamp",
"required": false,
"schema": {
"type": "string",
"example": "2022-08-16T17:43:26.991388Z",
"format": "date-time"
}
},
{
"name": "page_cursor",
"in": "query",
Expand Down Expand Up @@ -1525,6 +1536,20 @@
}
}
},
{
"name": "account_address",
"in": "query",
"required": false,
"description": "List of account addresses to filter by",
"schema": {
"type": "array",
"maxItems": 30,
"items": {
"type": "string",
"example": "0xe9b00a87700f660e46b6f5deaa1232836bcc07d3"
}
}
},
{
"name": "from_updated_at",
"in": "query",
Expand Down Expand Up @@ -2918,8 +2943,9 @@
},
"/v1/chains/{chain_name}/passport/users/{user_id}/linked-addresses": {
"get": {
"deprecated": true,
"summary": "Get Ethereum linked addresses for a user",
"description": "Get all the Ethereum linked addresses for a user based on its userId",
"description": "This API has been deprecated, please use https://docs.immutable.com/zkevm/api/reference/#/operations/getUserInfo instead to get a list of linked addresses.",
"tags": [
"passport"
],
Expand Down Expand Up @@ -3609,12 +3635,18 @@
"description": "An `uint256` token id as string",
"type": "string",
"example": "1"
},
"amount": {
"description": "The amount of tokens exchanged",
"type": "string",
"example": "1"
}
},
"required": [
"contract_type",
"contract_address",
"token_id"
"token_id",
"amount"
]
},
"ActivityToken": {
Expand Down Expand Up @@ -5298,10 +5330,17 @@
},
"token_id": {
"type": "string",
"description": "An optional `uint256` token id as string. It is recommended to omit token_id for more efficient minting",
"description": "An optional `uint256` token id as string. Required for ERC1155 collections.",
"example": "1",
"nullable": true
},
"amount": {
"type": "string",
"description": "Optional mount of tokens to mint. Required for ERC1155 collections. ERC712 collections can omit this field or set it to 1",
"example": "1",
"nullable": true,
"minLength": 1
},
"metadata": {
"$ref": "#/components/schemas/NFTMetadataRequest"
}
Expand Down Expand Up @@ -5379,6 +5418,12 @@
"nullable": true,
"description": "An `uint256` token id as string. Only available when the mint request succeeds"
},
"amount": {
"type": "string",
"example": "1",
"nullable": true,
"description": "An `uint256` amount as string. Only relevant for mint requests on ERC1155 contracts"
},
"activity_id": {
"type": "string",
"format": "uuid",
Expand Down Expand Up @@ -6954,7 +6999,7 @@
"properties": {
"order_type": {
"type": "string",
"description": "Seaport order type",
"description": "Seaport order type. Orders containing ERC721 tokens will need to pass in the order type as FULL_RESTRICTED while orders with ERC1155 tokens will need to pass in the order_type as PARTIAL_RESTRICTED",
"example": "FULL_RESTRICTED",
"enum": [
"FULL_RESTRICTED",
Expand Down Expand Up @@ -7031,6 +7076,7 @@
]
},
"FillStatus": {
"description": "The ratio of the order that has been filled, an order that has been fully filled will have the same numerator and denominator values.",
"type": "object",
"properties": {
"numerator": {
Expand Down Expand Up @@ -7872,17 +7918,7 @@
]
},
"sell": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SeaportERC721Item"
},
"example": [
{
"type": "NATIVE",
"amount": "9750000000000000000",
"contract_address": "0x0165878A594ca255338adfa4d48449f69242Eb8F"
}
]
"$ref": "#/components/schemas/SeaportERC721Item"
},
"fees": {
"type": "array",
Expand Down
23 changes: 18 additions & 5 deletions packages/internal/generated-clients/src/multi-rollup/domain/nft-owners-api.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,13 +145,14 @@ export const NftOwnersApiAxiosParamCreator = function (configuration?: Configura
* @summary List owners by contract address
* @param {string} contractAddress The address of contract
* @param {string} chainName The name of chain
* @param {Array<string>} [accountAddress] List of account addresses to filter by
* @param {string} [fromUpdatedAt] Datetime to use as the oldest updated timestamp
* @param {string} [pageCursor] Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
* @param {number} [pageSize] Maximum number of items to return
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listOwnersByContractAddress: async (contractAddress: string, chainName: string, fromUpdatedAt?: string, pageCursor?: string, pageSize?: number, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
listOwnersByContractAddress: async (contractAddress: string, chainName: string, accountAddress?: Array<string>, fromUpdatedAt?: string, pageCursor?: string, pageSize?: number, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
// verify required parameter 'contractAddress' is not null or undefined
assertParamExists('listOwnersByContractAddress', 'contractAddress', contractAddress)
// verify required parameter 'chainName' is not null or undefined
Expand All @@ -170,6 +171,10 @@ export const NftOwnersApiAxiosParamCreator = function (configuration?: Configura
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;

if (accountAddress) {
localVarQueryParameter['account_address'] = accountAddress;
}

if (fromUpdatedAt !== undefined) {
localVarQueryParameter['from_updated_at'] = (fromUpdatedAt as any instanceof Date) ?
(fromUpdatedAt as any).toISOString() :
Expand Down Expand Up @@ -239,14 +244,15 @@ export const NftOwnersApiFp = function(configuration?: Configuration) {
* @summary List owners by contract address
* @param {string} contractAddress The address of contract
* @param {string} chainName The name of chain
* @param {Array<string>} [accountAddress] List of account addresses to filter by
* @param {string} [fromUpdatedAt] Datetime to use as the oldest updated timestamp
* @param {string} [pageCursor] Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
* @param {number} [pageSize] Maximum number of items to return
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async listOwnersByContractAddress(contractAddress: string, chainName: string, fromUpdatedAt?: string, pageCursor?: string, pageSize?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCollectionOwnersResult>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.listOwnersByContractAddress(contractAddress, chainName, fromUpdatedAt, pageCursor, pageSize, options);
async listOwnersByContractAddress(contractAddress: string, chainName: string, accountAddress?: Array<string>, fromUpdatedAt?: string, pageCursor?: string, pageSize?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCollectionOwnersResult>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.listOwnersByContractAddress(contractAddress, chainName, accountAddress, fromUpdatedAt, pageCursor, pageSize, options);
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
},
}
Expand Down Expand Up @@ -287,7 +293,7 @@ export const NftOwnersApiFactory = function (configuration?: Configuration, base
* @throws {RequiredError}
*/
listOwnersByContractAddress(requestParameters: NftOwnersApiListOwnersByContractAddressRequest, options?: AxiosRequestConfig): AxiosPromise<ListCollectionOwnersResult> {
return localVarFp.listOwnersByContractAddress(requestParameters.contractAddress, requestParameters.chainName, requestParameters.fromUpdatedAt, requestParameters.pageCursor, requestParameters.pageSize, options).then((request) => request(axios, basePath));
return localVarFp.listOwnersByContractAddress(requestParameters.contractAddress, requestParameters.chainName, requestParameters.accountAddress, requestParameters.fromUpdatedAt, requestParameters.pageCursor, requestParameters.pageSize, options).then((request) => request(axios, basePath));
},
};
};
Expand Down Expand Up @@ -389,6 +395,13 @@ export interface NftOwnersApiListOwnersByContractAddressRequest {
*/
readonly chainName: string

/**
* List of account addresses to filter by
* @type {Array<string>}
* @memberof NftOwnersApiListOwnersByContractAddress
*/
readonly accountAddress?: Array<string>

/**
* Datetime to use as the oldest updated timestamp
* @type {string}
Expand Down Expand Up @@ -451,7 +464,7 @@ export class NftOwnersApi extends BaseAPI {
* @memberof NftOwnersApi
*/
public listOwnersByContractAddress(requestParameters: NftOwnersApiListOwnersByContractAddressRequest, options?: AxiosRequestConfig) {
return NftOwnersApiFp(this.configuration).listOwnersByContractAddress(requestParameters.contractAddress, requestParameters.chainName, requestParameters.fromUpdatedAt, requestParameters.pageCursor, requestParameters.pageSize, options).then((request) => request(this.axios, this.basePath));
return NftOwnersApiFp(this.configuration).listOwnersByContractAddress(requestParameters.contractAddress, requestParameters.chainName, requestParameters.accountAddress, requestParameters.fromUpdatedAt, requestParameters.pageCursor, requestParameters.pageSize, options).then((request) => request(this.axios, this.basePath));
}
}

25 changes: 20 additions & 5 deletions packages/internal/generated-clients/src/multi-rollup/domain/nfts-api.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -362,12 +362,13 @@ export const NftsApiAxiosParamCreator = function (configuration?: Configuration)
* @param {string} accountAddress Account address
* @param {string} chainName The name of chain
* @param {string} [contractAddress] The address of contract
* @param {string} [fromUpdatedAt] Datetime to use as the oldest updated timestamp
* @param {string} [pageCursor] Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
* @param {number} [pageSize] Maximum number of items to return
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listNFTsByAccountAddress: async (accountAddress: string, chainName: string, contractAddress?: string, pageCursor?: string, pageSize?: number, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
listNFTsByAccountAddress: async (accountAddress: string, chainName: string, contractAddress?: string, fromUpdatedAt?: string, pageCursor?: string, pageSize?: number, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
// verify required parameter 'accountAddress' is not null or undefined
assertParamExists('listNFTsByAccountAddress', 'accountAddress', accountAddress)
// verify required parameter 'chainName' is not null or undefined
Expand All @@ -390,6 +391,12 @@ export const NftsApiAxiosParamCreator = function (configuration?: Configuration)
localVarQueryParameter['contract_address'] = contractAddress;
}

if (fromUpdatedAt !== undefined) {
localVarQueryParameter['from_updated_at'] = (fromUpdatedAt as any instanceof Date) ?
(fromUpdatedAt as any).toISOString() :
fromUpdatedAt;
}

if (pageCursor !== undefined) {
localVarQueryParameter['page_cursor'] = pageCursor;
}
Expand Down Expand Up @@ -509,13 +516,14 @@ export const NftsApiFp = function(configuration?: Configuration) {
* @param {string} accountAddress Account address
* @param {string} chainName The name of chain
* @param {string} [contractAddress] The address of contract
* @param {string} [fromUpdatedAt] Datetime to use as the oldest updated timestamp
* @param {string} [pageCursor] Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
* @param {number} [pageSize] Maximum number of items to return
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async listNFTsByAccountAddress(accountAddress: string, chainName: string, contractAddress?: string, pageCursor?: string, pageSize?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListNFTsByOwnerResult>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.listNFTsByAccountAddress(accountAddress, chainName, contractAddress, pageCursor, pageSize, options);
async listNFTsByAccountAddress(accountAddress: string, chainName: string, contractAddress?: string, fromUpdatedAt?: string, pageCursor?: string, pageSize?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListNFTsByOwnerResult>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.listNFTsByAccountAddress(accountAddress, chainName, contractAddress, fromUpdatedAt, pageCursor, pageSize, options);
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
},
}
Expand Down Expand Up @@ -596,7 +604,7 @@ export const NftsApiFactory = function (configuration?: Configuration, basePath?
* @throws {RequiredError}
*/
listNFTsByAccountAddress(requestParameters: NftsApiListNFTsByAccountAddressRequest, options?: AxiosRequestConfig): AxiosPromise<ListNFTsByOwnerResult> {
return localVarFp.listNFTsByAccountAddress(requestParameters.accountAddress, requestParameters.chainName, requestParameters.contractAddress, requestParameters.pageCursor, requestParameters.pageSize, options).then((request) => request(axios, basePath));
return localVarFp.listNFTsByAccountAddress(requestParameters.accountAddress, requestParameters.chainName, requestParameters.contractAddress, requestParameters.fromUpdatedAt, requestParameters.pageCursor, requestParameters.pageSize, options).then((request) => request(axios, basePath));
},
};
};
Expand Down Expand Up @@ -838,6 +846,13 @@ export interface NftsApiListNFTsByAccountAddressRequest {
*/
readonly contractAddress?: string

/**
* Datetime to use as the oldest updated timestamp
* @type {string}
* @memberof NftsApiListNFTsByAccountAddress
*/
readonly fromUpdatedAt?: string

/**
* Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
* @type {string}
Expand Down Expand Up @@ -941,7 +956,7 @@ export class NftsApi extends BaseAPI {
* @memberof NftsApi
*/
public listNFTsByAccountAddress(requestParameters: NftsApiListNFTsByAccountAddressRequest, options?: AxiosRequestConfig) {
return NftsApiFp(this.configuration).listNFTsByAccountAddress(requestParameters.accountAddress, requestParameters.chainName, requestParameters.contractAddress, requestParameters.pageCursor, requestParameters.pageSize, options).then((request) => request(this.axios, this.basePath));
return NftsApiFp(this.configuration).listNFTsByAccountAddress(requestParameters.accountAddress, requestParameters.chainName, requestParameters.contractAddress, requestParameters.fromUpdatedAt, requestParameters.pageCursor, requestParameters.pageSize, options).then((request) => request(this.axios, this.basePath));
}
}

12 changes: 8 additions & 4 deletions packages/internal/generated-clients/src/multi-rollup/domain/passport-api.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,11 +102,12 @@ export const PassportApiAxiosParamCreator = function (configuration?: Configurat
};
},
/**
* Get all the Ethereum linked addresses for a user based on its userId
* This API has been deprecated, please use https://docs.immutable.com/zkevm/api/reference/#/operations/getUserInfo instead to get a list of linked addresses.
* @summary Get Ethereum linked addresses for a user
* @param {string} userId The user\&#39;s userId
* @param {string} chainName
* @param {*} [options] Override http request option.
* @deprecated
* @throws {RequiredError}
*/
getLinkedAddresses: async (userId: string, chainName: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
Expand Down Expand Up @@ -293,11 +294,12 @@ export const PassportApiFp = function(configuration?: Configuration) {
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
},
/**
* Get all the Ethereum linked addresses for a user based on its userId
* This API has been deprecated, please use https://docs.immutable.com/zkevm/api/reference/#/operations/getUserInfo instead to get a list of linked addresses.
* @summary Get Ethereum linked addresses for a user
* @param {string} userId The user\&#39;s userId
* @param {string} chainName
* @param {*} [options] Override http request option.
* @deprecated
* @throws {RequiredError}
*/
async getLinkedAddresses(userId: string, chainName: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetLinkedAddressesRes>> {
Expand Down Expand Up @@ -361,10 +363,11 @@ export const PassportApiFactory = function (configuration?: Configuration, baseP
return localVarFp.createCounterfactualAddressV2(requestParameters.chainName, requestParameters.createCounterfactualAddressRequest, options).then((request) => request(axios, basePath));
},
/**
* Get all the Ethereum linked addresses for a user based on its userId
* This API has been deprecated, please use https://docs.immutable.com/zkevm/api/reference/#/operations/getUserInfo instead to get a list of linked addresses.
* @summary Get Ethereum linked addresses for a user
* @param {PassportApiGetLinkedAddressesRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @deprecated
* @throws {RequiredError}
*/
getLinkedAddresses(requestParameters: PassportApiGetLinkedAddressesRequest, options?: AxiosRequestConfig): AxiosPromise<GetLinkedAddressesRes> {
Expand Down Expand Up @@ -522,10 +525,11 @@ export class PassportApi extends BaseAPI {
}

/**
* Get all the Ethereum linked addresses for a user based on its userId
* This API has been deprecated, please use https://docs.immutable.com/zkevm/api/reference/#/operations/getUserInfo instead to get a list of linked addresses.
* @summary Get Ethereum linked addresses for a user
* @param {PassportApiGetLinkedAddressesRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @deprecated
* @throws {RequiredError}
* @memberof PassportApi
*/
Expand Down