-
Notifications
You must be signed in to change notification settings - Fork 38
fix: Add ActorRunPricingInfo type #623
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.
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
Merged
Merged
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
6612efc
fix: Add ActorRunPricingInfo type
janbuchar 5c836cb
Merge remote-tracking branch 'origin/master' into pricing-info-type
janbuchar 0ae3ce1
Add more missing fields
janbuchar 166c68a
Slightly improve jsdoc
janbuchar 757b5cd
interfaces over types
janbuchar d0c3242
Revert weird lint results
janbuchar File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -382,6 +382,8 @@ export interface ActorRun extends ActorRunListItem { | |
gitBranchName?: string; | ||
usage?: ActorRunUsage; | ||
usageUsd?: ActorRunUsage; | ||
pricingInfo?: ActorRunPricingInfo; | ||
chargedEventCounts?: Record<string, number>; | ||
} | ||
|
||
export interface ActorRunUsage { | ||
|
@@ -428,6 +430,7 @@ export interface ActorRunOptions { | |
timeoutSecs: number; | ||
memoryMbytes: number; | ||
diskMbytes: number; | ||
maxTotalChargeUsd?: number; | ||
} | ||
|
||
export interface ActorBuildOptions { | ||
|
@@ -459,3 +462,50 @@ export interface ActorDefinition { | |
maxMemoryMbytes?: number; | ||
usesStandbyMode?: boolean; | ||
} | ||
|
||
type CommonActorPricingInfo = { | ||
/** in [0, 1], fraction of pricePerUnitUsd that goes to Apify */ | ||
apifyMarginPercentage: number; | ||
/** when this pricing info record has been created */ | ||
createdAt: Date; | ||
/** since when is this pricing info record effective for a given Actor */ | ||
startedAt: Date; | ||
notifiedAboutFutureChangeAt?: Date; | ||
notifiedAboutChangeAt?: Date; | ||
reasonForChange?: string; | ||
} | ||
|
||
export type FreeActorPricingInfo = CommonActorPricingInfo & { | ||
pricingModel: 'FREE'; | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Maybe a string enum for the |
||
} | ||
|
||
export type FlatPricePerMonthActorPricingInfo = CommonActorPricingInfo & { | ||
pricingModel: 'FLAT_PRICE_PER_MONTH'; | ||
/** for how many days this Actor can be used for free in trial period */ | ||
trialMinutes?: number; | ||
janbuchar marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
/** monthly flat price in USD */ | ||
pricePerUnitUsd: number; | ||
} | ||
|
||
export type PricePerDatasetItemActorPricingInfo = CommonActorPricingInfo & { | ||
pricingModel: 'PRICE_PER_DATASET_ITEM'; | ||
/** name of the unit that is being charged */ | ||
unitName?: string; | ||
pricePerUnitUsd: number; | ||
} | ||
|
||
export type ActorChargeEvents = Record<string, { | ||
eventPriceUsd: number; | ||
eventTitle: string; | ||
eventDescription?: string; | ||
}> | ||
|
||
export type PricePerEventActorPricingInfo = CommonActorPricingInfo & { | ||
pricingModel: 'PAY_PER_EVENT'; | ||
pricingPerEvent: { | ||
actorChargeEvents: ActorChargeEvents | ||
}; | ||
minimalMaxTotalChargeUsd?: number; | ||
janbuchar marked this conversation as resolved.
Show resolved
Hide resolved
|
||
} | ||
|
||
export type ActorRunPricingInfo = PricePerEventActorPricingInfo | PricePerDatasetItemActorPricingInfo | FlatPricePerMonthActorPricingInfo | FreeActorPricingInfo |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.