Skip to content

api.md

Latest commit

 

History

History
885 lines (615 loc) · 50.5 KB

api.md

File metadata and controls

885 lines (615 loc) · 50.5 KB

Shared

Types:

Apps

Types:

Methods:

  • client.apps.create({ ...params }) -> App
  • client.apps.retrieve(id) -> App
  • client.apps.update(id, { ...params }) -> App
  • client.apps.list({ ...params }) -> AppListResponsesCursorPage

Invoices

Types:

Methods:

  • client.invoices.create({ ...params }) -> Invoice
  • client.invoices.retrieve(id) -> Invoice
  • client.invoices.update(id, { ...params }) -> Invoice
  • client.invoices.list({ ...params }) -> InvoiceListItemsCursorPage
  • client.invoices.delete(id) -> InvoiceDeleteResponse
  • client.invoices.markPaid(id) -> InvoiceMarkPaidResponse
  • client.invoices.markUncollectible(id) -> InvoiceMarkUncollectibleResponse
  • client.invoices.void(id) -> InvoiceVoidResponse

CourseLessonInteractions

Methods:

  • client.courseLessonInteractions.retrieve(id) -> CourseLessonInteraction
  • client.courseLessonInteractions.list({ ...params }) -> CourseLessonInteractionListItemsCursorPage

Products

Types:

Methods:

  • client.products.create({ ...params }) -> Product
  • client.products.retrieve(id) -> Product
  • client.products.update(id, { ...params }) -> Product
  • client.products.list({ ...params }) -> ProductListItemsCursorPage
  • client.products.delete(id) -> ProductDeleteResponse

Companies

Types:

Methods:

  • client.companies.create({ ...params }) -> Company
  • client.companies.retrieve(id) -> Company
  • client.companies.update(id, { ...params }) -> Company
  • client.companies.list({ ...params }) -> CompanyListResponsesCursorPage

Webhooks

Types:

Methods:

  • client.webhooks.create({ ...params }) -> WebhookCreateResponse
  • client.webhooks.retrieve(id) -> Webhook
  • client.webhooks.update(id, { ...params }) -> Webhook
  • client.webhooks.list({ ...params }) -> WebhookListResponsesCursorPage
  • client.webhooks.delete(id) -> WebhookDeleteResponse
  • client.webhooks.unwrap(body) -> void

Plans

Types:

Methods:

  • client.plans.create({ ...params }) -> Plan
  • client.plans.retrieve(id) -> Plan
  • client.plans.update(id, { ...params }) -> Plan
  • client.plans.list({ ...params }) -> PlanListResponsesCursorPage
  • client.plans.delete(id) -> PlanDeleteResponse

Entries

Types:

Methods:

  • client.entries.retrieve(id) -> Entry
  • client.entries.list({ ...params }) -> EntryListResponsesCursorPage
  • client.entries.approve(id) -> EntryApproveResponse
  • client.entries.deny(id) -> Entry

ForumPosts

Types:

Methods:

  • client.forumPosts.create({ ...params }) -> ForumPost
  • client.forumPosts.retrieve(id) -> ForumPost
  • client.forumPosts.update(id, { ...params }) -> ForumPost
  • client.forumPosts.list({ ...params }) -> ForumPostListResponsesCursorPage

Transfers

Types:

Methods:

  • client.transfers.create({ ...params }) -> Transfer
  • client.transfers.retrieve(id) -> Transfer
  • client.transfers.list({ ...params }) -> TransferListResponsesCursorPage

LedgerAccounts

Types:

Methods:

  • client.ledgerAccounts.retrieve(id) -> LedgerAccountRetrieveResponse

Memberships

Types:

Methods:

  • client.memberships.retrieve(id) -> Membership
  • client.memberships.update(id, { ...params }) -> Membership
  • client.memberships.list({ ...params }) -> MembershipListResponsesCursorPage
  • client.memberships.addFreeDays(id, { ...params }) -> Membership
  • client.memberships.cancel(id, { ...params }) -> Membership
  • client.memberships.pause(id, { ...params }) -> Membership
  • client.memberships.resume(id) -> Membership
  • client.memberships.uncancel(id) -> Membership

AuthorizedUsers

Types:

Methods:

  • client.authorizedUsers.create({ ...params }) -> AuthorizedUser
  • client.authorizedUsers.retrieve(id) -> AuthorizedUser
  • client.authorizedUsers.list({ ...params }) -> AuthorizedUserListResponsesCursorPage
  • client.authorizedUsers.delete(id, { ...params }) -> AuthorizedUserDeleteResponse

AppBuilds

Types:

Methods:

  • client.appBuilds.create({ ...params }) -> AppBuild
  • client.appBuilds.retrieve(id) -> AppBuild
  • client.appBuilds.list({ ...params }) -> AppBuildListResponsesCursorPage
  • client.appBuilds.promote(id) -> AppBuild

Shipments

Types:

Methods:

  • client.shipments.create({ ...params }) -> Shipment
  • client.shipments.retrieve(id) -> Shipment
  • client.shipments.list({ ...params }) -> ShipmentListResponsesCursorPage

CheckoutConfigurations

Types:

Methods:

  • client.checkoutConfigurations.create({ ...params }) -> CheckoutConfiguration
  • client.checkoutConfigurations.retrieve(id) -> CheckoutConfiguration
  • client.checkoutConfigurations.list({ ...params }) -> CheckoutConfigurationListResponsesCursorPage

Messages

Types:

Methods:

  • client.messages.create({ ...params }) -> Message
  • client.messages.retrieve(id) -> Message
  • client.messages.update(id, { ...params }) -> Message
  • client.messages.list({ ...params }) -> MessageListResponsesCursorPage
  • client.messages.delete(id) -> MessageDeleteResponse

ChatChannels

Types:

Methods:

  • client.chatChannels.retrieve(id) -> ChatChannel
  • client.chatChannels.update(id, { ...params }) -> ChatChannel
  • client.chatChannels.list({ ...params }) -> ChatChannelListResponsesCursorPage

Users

Types:

Methods:

  • client.users.retrieve(id, { ...params }) -> User
  • client.users.update(id, { ...params }) -> User
  • client.users.list({ ...params }) -> UserListResponsesCursorPage
  • client.users.checkAccess(resourceID, { ...params }) -> UserCheckAccessResponse

Payments

Types:

Methods:

  • client.payments.create({ ...params }) -> Payment
  • client.payments.retrieve(id) -> Payment
  • client.payments.list({ ...params }) -> PaymentListResponsesCursorPage
  • client.payments.listFees(id, { ...params }) -> PaymentListFeesResponsesCursorPage
  • client.payments.refund(id, { ...params }) -> Payment
  • client.payments.retry(id) -> Payment
  • client.payments.void(id) -> Payment

SupportChannels

Types:

Methods:

  • client.supportChannels.create({ ...params }) -> SupportChannel
  • client.supportChannels.retrieve(id) -> SupportChannel
  • client.supportChannels.list({ ...params }) -> SupportChannelListResponsesCursorPage

Experiences

Types:

Methods:

  • client.experiences.create({ ...params }) -> Experience
  • client.experiences.retrieve(id) -> Experience
  • client.experiences.update(id, { ...params }) -> Experience
  • client.experiences.list({ ...params }) -> ExperienceListResponsesCursorPage
  • client.experiences.delete(id) -> ExperienceDeleteResponse
  • client.experiences.attach(id, { ...params }) -> Experience
  • client.experiences.detach(id, { ...params }) -> Experience
  • client.experiences.duplicate(id, { ...params }) -> Experience

Reactions

Types:

Methods:

  • client.reactions.create({ ...params }) -> Reaction
  • client.reactions.retrieve(id) -> Reaction
  • client.reactions.list({ ...params }) -> ReactionListResponsesCursorPage
  • client.reactions.delete(id, { ...params }) -> ReactionDeleteResponse

Members

Types:

Methods:

  • client.members.retrieve(id) -> MemberRetrieveResponse
  • client.members.list({ ...params }) -> MemberListResponsesCursorPage

Forums

Types:

Methods:

  • client.forums.retrieve(id) -> Forum
  • client.forums.update(id, { ...params }) -> Forum
  • client.forums.list({ ...params }) -> ForumListResponsesCursorPage

PromoCodes

Types:

Methods:

  • client.promoCodes.create({ ...params }) -> PromoCode
  • client.promoCodes.retrieve(id) -> PromoCode
  • client.promoCodes.list({ ...params }) -> PromoCodeListResponsesCursorPage
  • client.promoCodes.delete(id) -> PromoCodeDeleteResponse

Courses

Types:

Methods:

  • client.courses.create({ ...params }) -> Course
  • client.courses.retrieve(id) -> Course
  • client.courses.update(id, { ...params }) -> Course
  • client.courses.list({ ...params }) -> CourseListResponsesCursorPage
  • client.courses.delete(id) -> CourseDeleteResponse

CourseChapters

Types:

Methods:

  • client.courseChapters.create({ ...params }) -> CourseChapter
  • client.courseChapters.retrieve(id) -> CourseChapter
  • client.courseChapters.update(id, { ...params }) -> CourseChapter
  • client.courseChapters.list({ ...params }) -> CourseChapterListResponsesCursorPage
  • client.courseChapters.delete(id) -> CourseChapterDeleteResponse

CourseLessons

Types:

Methods:

  • client.courseLessons.create({ ...params }) -> Lesson
  • client.courseLessons.retrieve(id) -> Lesson
  • client.courseLessons.update(id, { ...params }) -> Lesson
  • client.courseLessons.list({ ...params }) -> CourseLessonListResponsesCursorPage
  • client.courseLessons.delete(id) -> CourseLessonDeleteResponse
  • client.courseLessons.markAsCompleted(lessonID) -> CourseLessonMarkAsCompletedResponse
  • client.courseLessons.start(lessonID) -> CourseLessonStartResponse
  • client.courseLessons.submitAssessment(lessonID, { ...params }) -> CourseLessonSubmitAssessmentResponse

Reviews

Types:

Methods:

  • client.reviews.retrieve(id) -> ReviewRetrieveResponse
  • client.reviews.list({ ...params }) -> ReviewListResponsesCursorPage

CourseStudents

Types:

Methods:

  • client.courseStudents.retrieve(id) -> CourseStudentRetrieveResponse
  • client.courseStudents.list({ ...params }) -> CourseStudentListResponsesCursorPage

AccessTokens

Types:

Methods:

  • client.accessTokens.create({ ...params }) -> AccessTokenCreateResponse

Notifications

Types:

Methods:

  • client.notifications.create({ ...params }) -> NotificationCreateResponse

Disputes

Types:

Methods:

  • client.disputes.retrieve(id) -> Dispute
  • client.disputes.list({ ...params }) -> DisputeListResponsesCursorPage
  • client.disputes.submitEvidence(id) -> Dispute
  • client.disputes.updateEvidence(id, { ...params }) -> Dispute

Refunds

Types:

Methods:

  • client.refunds.retrieve(id) -> RefundRetrieveResponse
  • client.refunds.list({ ...params }) -> RefundListResponsesCursorPage

Withdrawals

Types:

Methods:

  • client.withdrawals.create({ ...params }) -> Withdrawal
  • client.withdrawals.retrieve(id) -> Withdrawal
  • client.withdrawals.list({ ...params }) -> WithdrawalListResponsesCursorPage

AccountLinks

Types:

Methods:

  • client.accountLinks.create({ ...params }) -> AccountLinkCreateResponse

SetupIntents

Types:

Methods:

  • client.setupIntents.retrieve(id) -> SetupIntent
  • client.setupIntents.list({ ...params }) -> SetupIntentListResponsesCursorPage

PaymentMethods

Types:

Methods:

  • client.paymentMethods.retrieve(id, { ...params }) -> PaymentMethodRetrieveResponse
  • client.paymentMethods.list({ ...params }) -> PaymentMethodListResponsesCursorPage

FeeMarkups

Types:

Methods:

  • client.feeMarkups.create({ ...params }) -> FeeMarkupCreateResponse
  • client.feeMarkups.list({ ...params }) -> FeeMarkupListResponsesCursorPage
  • client.feeMarkups.delete(id) -> FeeMarkupDeleteResponse

PayoutMethods

Types:

Methods:

  • client.payoutMethods.retrieve(id) -> PayoutMethodRetrieveResponse
  • client.payoutMethods.list({ ...params }) -> PayoutMethodListResponsesCursorPage

Verifications

Types:

Methods:

  • client.verifications.retrieve(id) -> VerificationRetrieveResponse
  • client.verifications.list({ ...params }) -> VerificationListResponsesCursorPage

Leads

Types:

Methods:

  • client.leads.create({ ...params }) -> Lead
  • client.leads.retrieve(id) -> Lead
  • client.leads.update(id, { ...params }) -> Lead
  • client.leads.list({ ...params }) -> LeadListResponsesCursorPage

Topups

Types:

Methods:

  • client.topups.create({ ...params }) -> TopupCreateResponse

Files

Types:

Methods:

  • client.files.create({ ...params }) -> FileCreateResponse
  • client.files.retrieve(id) -> FileRetrieveResponse

CompanyTokenTransactions

Types:

Methods:

  • client.companyTokenTransactions.create({ ...params }) -> CompanyTokenTransaction
  • client.companyTokenTransactions.retrieve(id) -> CompanyTokenTransaction
  • client.companyTokenTransactions.list({ ...params }) -> CompanyTokenTransactionListResponsesCursorPage

DmMembers

Types:

Methods:

  • client.dmMembers.create({ ...params }) -> DmMember
  • client.dmMembers.retrieve(id) -> DmMember
  • client.dmMembers.update(id, { ...params }) -> DmMember
  • client.dmMembers.list({ ...params }) -> DmMemberListResponsesCursorPage
  • client.dmMembers.delete(id) -> DmMemberDeleteResponse

AIChats

Types:

Methods:

  • client.aiChats.create({ ...params }) -> AIChat
  • client.aiChats.retrieve(id) -> AIChat
  • client.aiChats.update(id, { ...params }) -> AIChat
  • client.aiChats.list({ ...params }) -> AIChatListResponsesCursorPage
  • client.aiChats.delete(id) -> AIChatDeleteResponse

DmChannels

Types:

Methods:

  • client.dmChannels.create({ ...params }) -> DmChannel
  • client.dmChannels.retrieve(id) -> DmChannel
  • client.dmChannels.update(id, { ...params }) -> DmChannel
  • client.dmChannels.list({ ...params }) -> DmChannelListResponsesCursorPage
  • client.dmChannels.delete(id) -> DmChannelDeleteResponse

DisputeAlerts

Types:

Methods:

  • client.disputeAlerts.retrieve(id) -> DisputeAlertRetrieveResponse
  • client.disputeAlerts.list({ ...params }) -> DisputeAlertListResponsesCursorPage

ResolutionCenterCases

Types:

Methods:

  • client.resolutionCenterCases.retrieve(id) -> ResolutionCenterCaseRetrieveResponse
  • client.resolutionCenterCases.list({ ...params }) -> ResolutionCenterCaseListResponsesCursorPage

PayoutAccounts

Types:

Methods:

  • client.payoutAccounts.retrieve(id) -> PayoutAccountRetrieveResponse

Affiliates

Types:

Methods:

  • client.affiliates.create({ ...params }) -> Affiliate
  • client.affiliates.retrieve(id) -> Affiliate
  • client.affiliates.list({ ...params }) -> AffiliateListResponsesCursorPage
  • client.affiliates.archive(id) -> AffiliateArchiveResponse
  • client.affiliates.unarchive(id) -> AffiliateUnarchiveResponse

Overrides

Types:

Methods:

  • client.affiliates.overrides.create(id, { ...params }) -> OverrideCreateResponse
  • client.affiliates.overrides.retrieve(overrideID, { ...params }) -> OverrideRetrieveResponse
  • client.affiliates.overrides.update(overrideID, { ...params }) -> OverrideUpdateResponse
  • client.affiliates.overrides.list(id, { ...params }) -> OverrideListResponsesCursorPage
  • client.affiliates.overrides.delete(overrideID, { ...params }) -> OverrideDeleteResponse