Class PortfolioOperation

Hierarchy

Operation
- PortfolioOperation

Index

Constructors

constructor

Methods

createPortfolios getPortfolio getPortfolioExtended listPortfolios listPortfoliosExtended updatePortfolios create

Constructors

constructor

new PortfolioOperation(client: HttpClient): PortfolioOperation
Parameters
- client: HttpClient
Returns PortfolioOperation
Inherited from Operation.constructor
- Defined in src/operations/operation.ts:25

Methods

createPortfolios

createPortfolios(portfolios: ({ name: string; state: "enabled" } & { budget: undefined | ({ amount?: number | undefined; currencyCode?: AmazonMarketplaceAdvertisingCurrency | undefined; policy?: "dateRange" | "MonthlyRecurring" | undefined; startDate?: string | null | undefined; endDate?: string | null | undefined; }) })[]): Promise<({ code: "NOT_FOUND" | "SUCCESS" | "INVALID_ARGUMENT" } & { description: undefined | string; portfolioId: undefined | number })[]>
Create one or more portfolios. Maximum number of portfolios per account is 100.

Returns
Parameters
- portfolios: ({ name: string; state: "enabled" } & { budget: undefined | ({ amount?: number | undefined; currencyCode?: AmazonMarketplaceAdvertisingCurrency | undefined; policy?: "dateRange" | "MonthlyRecurring" | undefined; startDate?: string | null | undefined; endDate?: string | null | undefined; }) })[]
Returns Promise<({ code: "NOT_FOUND" | "SUCCESS" | "INVALID_ARGUMENT" } & { description: undefined | string; portfolioId: undefined | number })[]>
- Defined in src/operations/portfolios/portfolio-operation.ts:66

getPortfolio

getPortfolio(portfolioId: number): Promise<{ inBudget: boolean; name: string; portfolioId: number; state: "enabled" } & { budget: undefined | ({ amount?: number | undefined; currencyCode?: AmazonMarketplaceAdvertisingCurrency | undefined; policy?: "dateRange" | "MonthlyRecurring" | undefined; startDate?: string | null | undefined; endDate?: string | null | undefined; }) }>
Retrieve a portfolio by ID.

Returns
Parameters
- portfolioId: number
Returns Promise<{ inBudget: boolean; name: string; portfolioId: number; state: "enabled" } & { budget: undefined | ({ amount?: number | undefined; currencyCode?: AmazonMarketplaceAdvertisingCurrency | undefined; policy?: "dateRange" | "MonthlyRecurring" | undefined; startDate?: string | null | undefined; endDate?: string | null | undefined; }) }>
- Defined in src/operations/portfolios/portfolio-operation.ts:44

getPortfolioExtended

getPortfolioExtended(portfolioId: number): Promise<{ inBudget: boolean; name: string; portfolioId: number; state: "enabled" } & { budget: undefined | ({ amount?: number | undefined; currencyCode?: AmazonMarketplaceAdvertisingCurrency | undefined; policy?: "dateRange" | "MonthlyRecurring" | undefined; startDate?: string | null | undefined; endDate?: string | null | undefined; }) } & { creationDate: Date; lastUpdatedDate: Date; servingStatus: string }>
Retrieve a portfolio along with additional properties by ID.

Returns
Parameters
- portfolioId: number
Returns Promise<{ inBudget: boolean; name: string; portfolioId: number; state: "enabled" } & { budget: undefined | ({ amount?: number | undefined; currencyCode?: AmazonMarketplaceAdvertisingCurrency | undefined; policy?: "dateRange" | "MonthlyRecurring" | undefined; startDate?: string | null | undefined; endDate?: string | null | undefined; }) } & { creationDate: Date; lastUpdatedDate: Date; servingStatus: string }>
- Defined in src/operations/portfolios/portfolio-operation.ts:55

listPortfolios

listPortfolios(params?: { portfolioIdFilter: undefined | number; portfolioNameFilter: undefined | string; portfolioStateFilter: undefined | "enabled" }): Promise<({ inBudget: boolean; name: string; portfolioId: number; state: "enabled" } & { budget: undefined | ({ amount?: number | undefined; currencyCode?: AmazonMarketplaceAdvertisingCurrency | undefined; policy?: "dateRange" | "MonthlyRecurring" | undefined; startDate?: string | null | undefined; endDate?: string | null | undefined; }) })[]>
Retrieve a list of up to 100 portfolios using the specified filters.

Returns
Parameters
- Optional params: { portfolioIdFilter: undefined | number; portfolioNameFilter: undefined | string; portfolioStateFilter: undefined | "enabled" }
  - portfolioIdFilter: undefined | number
    
    Retrieve the portfolios with the specified IDs.
  - portfolioNameFilter: undefined | string
    
    Retrieve the portfolios with the specified names.
  - portfolioStateFilter: undefined | "enabled"
    
    Retrieve the portfolios with the specified state.
Returns Promise<({ inBudget: boolean; name: string; portfolioId: number; state: "enabled" } & { budget: undefined | ({ amount?: number | undefined; currencyCode?: AmazonMarketplaceAdvertisingCurrency | undefined; policy?: "dateRange" | "MonthlyRecurring" | undefined; startDate?: string | null | undefined; endDate?: string | null | undefined; }) })[]>
- Defined in src/operations/portfolios/portfolio-operation.ts:22

listPortfoliosExtended

listPortfoliosExtended(params?: { portfolioIdFilter: undefined | number; portfolioNameFilter: undefined | string; portfolioStateFilter: undefined | "enabled" }): Promise<({ inBudget: boolean; name: string; portfolioId: number; state: "enabled" } & { budget: undefined | ({ amount?: number | undefined; currencyCode?: AmazonMarketplaceAdvertisingCurrency | undefined; policy?: "dateRange" | "MonthlyRecurring" | undefined; startDate?: string | null | undefined; endDate?: string | null | undefined; }) } & { creationDate: Date; lastUpdatedDate: Date; servingStatus: string })[]>
Retrieve a list of up to 100 portfolios with additional properties using the specified filters.

Returns
Parameters
- Optional params: { portfolioIdFilter: undefined | number; portfolioNameFilter: undefined | string; portfolioStateFilter: undefined | "enabled" }
  - portfolioIdFilter: undefined | number
    
    Retrieve the portfolios with the specified IDs.
  - portfolioNameFilter: undefined | string
    
    Retrieve the portfolios with the specified names.
  - portfolioStateFilter: undefined | "enabled"
    
    Retrieve the portfolios with the specified state.
Returns Promise<({ inBudget: boolean; name: string; portfolioId: number; state: "enabled" } & { budget: undefined | ({ amount?: number | undefined; currencyCode?: AmazonMarketplaceAdvertisingCurrency | undefined; policy?: "dateRange" | "MonthlyRecurring" | undefined; startDate?: string | null | undefined; endDate?: string | null | undefined; }) } & { creationDate: Date; lastUpdatedDate: Date; servingStatus: string })[]>
- Defined in src/operations/portfolios/portfolio-operation.ts:33

updatePortfolios

updatePortfolios(portfolios: ({ portfolioId: number } & { budget: undefined | ({ amount?: number | undefined; currencyCode?: AmazonMarketplaceAdvertisingCurrency | undefined; policy?: "dateRange" | "MonthlyRecurring" | undefined; startDate?: string | null | undefined; endDate?: string | null | undefined; }); name: undefined | string; state: undefined | "enabled" })[]): Promise<({ code: "NOT_FOUND" | "SUCCESS" | "INVALID_ARGUMENT" } & { description: undefined | string; portfolioId: undefined | number })[]>
Update one or more portfolios.

Returns
Parameters
- portfolios: ({ portfolioId: number } & { budget: undefined | ({ amount?: number | undefined; currencyCode?: AmazonMarketplaceAdvertisingCurrency | undefined; policy?: "dateRange" | "MonthlyRecurring" | undefined; startDate?: string | null | undefined; endDate?: string | null | undefined; }); name: undefined | string; state: undefined | "enabled" })[]
Returns Promise<({ code: "NOT_FOUND" | "SUCCESS" | "INVALID_ARGUMENT" } & { description: undefined | string; portfolioId: undefined | number })[]>
- Defined in src/operations/portfolios/portfolio-operation.ts:77

`Static` create

create<T>(this: T, httpClient: HttpClient): InstanceType<T>
Type Parameters
- T extends typeof Operation
Parameters
- this: T
- httpClient: HttpClient
Returns InstanceType<T>
Inherited from Operation.create
- Defined in src/operations/operation.ts:27

Class PortfolioOperation

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

client: HttpClient

Returns PortfolioOperation

Methods

createPortfolios

Returns

Parameters

Returns Promise<({ code: "NOT_FOUND" | "SUCCESS" | "INVALID_ARGUMENT" } & { description: undefined | string; portfolioId: undefined | number })[]>

getPortfolio

Returns

Parameters

portfolioId: number

getPortfolioExtended

Returns

Parameters

portfolioId: number

listPortfolios

Returns

Parameters

Optional params: { portfolioIdFilter: undefined | number; portfolioNameFilter: undefined | string; portfolioStateFilter: undefined | "enabled" }

portfolioIdFilter: undefined | number

portfolioNameFilter: undefined | string

portfolioStateFilter: undefined | "enabled"

listPortfoliosExtended

Returns

Parameters

Optional params: { portfolioIdFilter: undefined | number; portfolioNameFilter: undefined | string; portfolioStateFilter: undefined | "enabled" }

portfolioIdFilter: undefined | number

portfolioNameFilter: undefined | string

portfolioStateFilter: undefined | "enabled"

updatePortfolios

Returns

Parameters

Returns Promise<({ code: "NOT_FOUND" | "SUCCESS" | "INVALID_ARGUMENT" } & { description: undefined | string; portfolioId: undefined | number })[]>

Static create

Type Parameters

T extends typeof Operation

Parameters

this: T

httpClient: HttpClient

Returns InstanceType<T>

Settings

Member Visibility

Theme

`Optional` params: { portfolioIdFilter: undefined | number; portfolioNameFilter: undefined | string; portfolioStateFilter: undefined | "enabled" }

`Optional` params: { portfolioIdFilter: undefined | number; portfolioNameFilter: undefined | string; portfolioStateFilter: undefined | "enabled" }

`Static` create