@iblai/iblai-api 4.288.1-core → 4.289.0-core

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (43) hide show
  1. package/dist/index.cjs.js +10618 -12607
  2. package/dist/index.cjs.js.map +1 -1
  3. package/dist/index.esm.js +10619 -12593
  4. package/dist/index.esm.js.map +1 -1
  5. package/dist/index.umd.js +10618 -12607
  6. package/dist/index.umd.js.map +1 -1
  7. package/dist/types/index.d.ts +0 -15
  8. package/dist/types/services/BillingService.d.ts +215 -4
  9. package/package.json +1 -1
  10. package/sdk_schema.yml +10797 -14096
  11. package/src/core/OpenAPI.ts +1 -1
  12. package/src/index.ts +0 -15
  13. package/src/services/BillingService.ts +468 -6
  14. package/dist/types/services/AccessCheckService.d.ts +0 -17
  15. package/dist/types/services/AccountService.d.ts +0 -36
  16. package/dist/types/services/ActivitiesService.d.ts +0 -126
  17. package/dist/types/services/AutoRechargeService.d.ts +0 -14
  18. package/dist/types/services/CreditsService.d.ts +0 -12
  19. package/dist/types/services/DealsService.d.ts +0 -192
  20. package/dist/types/services/ItemsService.d.ts +0 -13
  21. package/dist/types/services/LeadSourcesService.d.ts +0 -95
  22. package/dist/types/services/OrganizationsService.d.ts +0 -109
  23. package/dist/types/services/PersonsService.d.ts +0 -168
  24. package/dist/types/services/PipelinesService.d.ts +0 -183
  25. package/dist/types/services/PlatformsService.d.ts +0 -332
  26. package/dist/types/services/PricesService.d.ts +0 -15
  27. package/dist/types/services/TagsService.d.ts +0 -96
  28. package/dist/types/services/TransactionsService.d.ts +0 -35
  29. package/src/services/AccessCheckService.ts +0 -39
  30. package/src/services/AccountService.ts +0 -70
  31. package/src/services/ActivitiesService.ts +0 -255
  32. package/src/services/AutoRechargeService.ts +0 -29
  33. package/src/services/CreditsService.ts +0 -23
  34. package/src/services/DealsService.ts +0 -406
  35. package/src/services/ItemsService.ts +0 -29
  36. package/src/services/LeadSourcesService.ts +0 -198
  37. package/src/services/OrganizationsService.ts +0 -249
  38. package/src/services/PersonsService.ts +0 -367
  39. package/src/services/PipelinesService.ts +0 -406
  40. package/src/services/PlatformsService.ts +0 -716
  41. package/src/services/PricesService.ts +0 -34
  42. package/src/services/TagsService.ts +0 -201
  43. package/src/services/TransactionsService.ts +0 -57
@@ -1,168 +0,0 @@
1
- import type { _TagAttachRequest } from '../models/_TagAttachRequest';
2
- import type { PaginatedPersonList } from '../models/PaginatedPersonList';
3
- import type { PatchedPerson } from '../models/PatchedPerson';
4
- import type { Person } from '../models/Person';
5
- import type { PersonInviteRequest } from '../models/PersonInviteRequest';
6
- import type { PersonInviteResponse } from '../models/PersonInviteResponse';
7
- import type { PersonLinkUserRequest } from '../models/PersonLinkUserRequest';
8
- import type { PersonMergeRequest } from '../models/PersonMergeRequest';
9
- import type { PersonMergeResponse } from '../models/PersonMergeResponse';
10
- import type { CancelablePromise } from '../core/CancelablePromise';
11
- export declare class PersonsService {
12
- /**
13
- * List persons
14
- * Returns a paginated list of persons in your Platform. Supports filtering by `lifecycle_stage`, `owner`, `organization`, `created_at__gte`/`created_at__lte`, and `metadata__has_key`.
15
- *
16
- * **Required permission:** `Ibl.CRM/Persons/list`.
17
- * @returns PaginatedPersonList
18
- * @throws ApiError
19
- */
20
- static personsList({ createdAtGte, createdAtLte, lifecycleStage, metadataHasKey, organization, owner, page, pageSize, tags, }: {
21
- createdAtGte?: string;
22
- createdAtLte?: string;
23
- /**
24
- * Funnel position. Transitions are unrestricted — any stage may move to any other.
25
- *
26
- * * `lead` - Lead
27
- * * `qualified` - Qualified
28
- * * `opportunity` - Opportunity
29
- * * `customer` - Customer
30
- * * `churned` - Churned
31
- */
32
- lifecycleStage?: 'churned' | 'customer' | 'lead' | 'opportunity' | 'qualified';
33
- metadataHasKey?: string;
34
- organization?: string;
35
- owner?: number;
36
- /**
37
- * A page number within the paginated result set.
38
- */
39
- page?: number;
40
- /**
41
- * Number of results to return per page.
42
- */
43
- pageSize?: number;
44
- tags?: string;
45
- }): CancelablePromise<PaginatedPersonList>;
46
- /**
47
- * Create a person
48
- * Creates a new person in your Platform. The Platform is inferred from your credentials. If `organization` is supplied, it must reference an organization in your Platform.
49
- *
50
- * **Required permission:** `Ibl.CRM/Persons/action`.
51
- * @returns Person
52
- * @throws ApiError
53
- */
54
- static personsCreate({ requestBody, }: {
55
- requestBody: Person;
56
- }): CancelablePromise<Person>;
57
- /**
58
- * Retrieve a person
59
- * Returns a single person by id.
60
- *
61
- * **Required permission:** `Ibl.CRM/Persons/read`.
62
- * @returns Person
63
- * @throws ApiError
64
- */
65
- static personsRetrieve({ id, }: {
66
- id: string;
67
- }): CancelablePromise<Person>;
68
- /**
69
- * Replace a person
70
- * Replaces all editable fields on the person.
71
- *
72
- * **Required permission:** `Ibl.CRM/Persons/write`.
73
- * @returns Person
74
- * @throws ApiError
75
- */
76
- static personsUpdate({ id, requestBody, }: {
77
- id: string;
78
- requestBody: Person;
79
- }): CancelablePromise<Person>;
80
- /**
81
- * Update a person
82
- * Updates only the supplied fields on the person.
83
- *
84
- * **Required permission:** `Ibl.CRM/Persons/write`.
85
- * @returns Person
86
- * @throws ApiError
87
- */
88
- static personsPartialUpdate({ id, requestBody, }: {
89
- id: string;
90
- requestBody?: PatchedPerson;
91
- }): CancelablePromise<Person>;
92
- /**
93
- * Delete a person
94
- * Deletes the person.
95
- *
96
- * **Required permission:** `Ibl.CRM/Persons/delete`.
97
- * @returns void
98
- * @throws ApiError
99
- */
100
- static personsDestroy({ id, }: {
101
- id: string;
102
- }): CancelablePromise<void>;
103
- /**
104
- * Invite a person to the platform
105
- * Sends a platform invitation to the person's `primary_email`. On acceptance, the invitee joins your Platform with the privileges configured in the request body.
106
- *
107
- * Returns `409 Conflict` if an active invitation already exists for this email in your Platform, and `422 Unprocessable Entity` if the person is already linked to a platform user.
108
- *
109
- * **Required permission:** `Ibl.CRM/Invite/action`.
110
- * @returns PersonInviteResponse
111
- * @throws ApiError
112
- */
113
- static personsInviteCreate({ id, requestBody, }: {
114
- id: string;
115
- requestBody?: PersonInviteRequest;
116
- }): CancelablePromise<PersonInviteResponse>;
117
- /**
118
- * Bind a person to an existing platform user
119
- * Links this person to an existing platform user. The target user must already be a member of your Platform — if they are not, send them an invitation via `POST /persons/{id}/invite/` instead.
120
- *
121
- * This call is idempotent: linking a person that is already bound to the same user is a no-op. Re-linking a person that is already bound to a *different* user is refused; the existing binding is preserved and the unchanged person is returned.
122
- *
123
- * **Required permission:** `Ibl.CRM/Persons/write`.
124
- * @returns Person
125
- * @throws ApiError
126
- */
127
- static personsLinkUserCreate({ id, requestBody, }: {
128
- id: string;
129
- requestBody: PersonLinkUserRequest;
130
- }): CancelablePromise<Person>;
131
- /**
132
- * Attach a tag to this record
133
- * Attaches an existing Tag to this record. Both the Tag and the record must belong to your Platform. Returns `409 Conflict` with the existing `assignment_id` if the tag is already attached.
134
- *
135
- * **Required permission:** `Ibl.CRM/Tags/write`.
136
- * @returns any No response body
137
- * @throws ApiError
138
- */
139
- static personsTagsCreate({ id, requestBody, }: {
140
- id: string;
141
- requestBody: _TagAttachRequest;
142
- }): CancelablePromise<any>;
143
- /**
144
- * Detach a tag from this record
145
- * Removes the Tag with id `tag_id` from this record. Returns `404` if the tag was not attached.
146
- *
147
- * **Required permission:** `Ibl.CRM/Tags/write`.
148
- * @returns void
149
- * @throws ApiError
150
- */
151
- static personsTagsDestroy({ id, tagId, }: {
152
- id: string;
153
- tagId: string;
154
- }): CancelablePromise<void>;
155
- /**
156
- * Merge duplicate persons into a primary
157
- * Marks each person in `duplicate_ids` as inactive and reports how many related records (deals, activities, tags) were re-parented onto `primary_id`.
158
- *
159
- * All ids — both the primary and every duplicate — must belong to your Platform. `primary_id` may not appear in `duplicate_ids`.
160
- *
161
- * **Required permission:** `Ibl.CRM/Persons/write`.
162
- * @returns PersonMergeResponse
163
- * @throws ApiError
164
- */
165
- static personsMergeCreate({ requestBody, }: {
166
- requestBody: PersonMergeRequest;
167
- }): CancelablePromise<PersonMergeResponse>;
168
- }
@@ -1,183 +0,0 @@
1
- import type { PaginatedPipelineList } from '../models/PaginatedPipelineList';
2
- import type { PaginatedPipelineStageList } from '../models/PaginatedPipelineStageList';
3
- import type { PatchedPipeline } from '../models/PatchedPipeline';
4
- import type { PatchedPipelineStage } from '../models/PatchedPipelineStage';
5
- import type { Pipeline } from '../models/Pipeline';
6
- import type { PipelineStage } from '../models/PipelineStage';
7
- import type { CancelablePromise } from '../core/CancelablePromise';
8
- export declare class PipelinesService {
9
- /**
10
- * List pipelines
11
- * Returns a paginated list of Pipelines in your Platform. Each Pipeline includes its ordered `stages` inline.
12
- *
13
- * **Required permission:** `Ibl.CRM/Pipelines/list`.
14
- * @returns PaginatedPipelineList
15
- * @throws ApiError
16
- */
17
- static pipelinesList({ code, isDefault, name, page, pageSize, }: {
18
- code?: string;
19
- isDefault?: boolean;
20
- name?: string;
21
- /**
22
- * A page number within the paginated result set.
23
- */
24
- page?: number;
25
- /**
26
- * Number of results to return per page.
27
- */
28
- pageSize?: number;
29
- }): CancelablePromise<PaginatedPipelineList>;
30
- /**
31
- * Create a pipeline
32
- * Creates a new Pipeline. `code` must be unique within your Platform. Promoting another Pipeline to `is_default=true` while one already exists will fail — unset the existing default first.
33
- *
34
- * **Required permission:** `Ibl.CRM/Pipelines/action`.
35
- * @returns Pipeline
36
- * @throws ApiError
37
- */
38
- static pipelinesCreate({ requestBody, }: {
39
- requestBody: Pipeline;
40
- }): CancelablePromise<Pipeline>;
41
- /**
42
- * List stages for a pipeline
43
- * Returns the ordered list of PipelineStages for the given Pipeline.
44
- *
45
- * **Required permission:** `Ibl.CRM/Pipelines/list`.
46
- * @returns PaginatedPipelineStageList
47
- * @throws ApiError
48
- */
49
- static pipelinesStagesList({ pipelinePk, code, isLost, isWon, page, pageSize, }: {
50
- pipelinePk: number;
51
- code?: string;
52
- isLost?: boolean;
53
- isWon?: boolean;
54
- /**
55
- * A page number within the paginated result set.
56
- */
57
- page?: number;
58
- /**
59
- * Number of results to return per page.
60
- */
61
- pageSize?: number;
62
- }): CancelablePromise<PaginatedPipelineStageList>;
63
- /**
64
- * Create a stage
65
- * Creates a new PipelineStage in the URL Pipeline. `code` must be unique within that Pipeline. At most one of `is_won` / `is_lost` may be true.
66
- *
67
- * **Required permission:** `Ibl.CRM/Pipelines/action`.
68
- * @returns PipelineStage
69
- * @throws ApiError
70
- */
71
- static pipelinesStagesCreate({ pipelinePk, requestBody, }: {
72
- pipelinePk: number;
73
- requestBody: PipelineStage;
74
- }): CancelablePromise<PipelineStage>;
75
- /**
76
- * Retrieve a stage
77
- * Returns a single PipelineStage by id (must belong to the URL Pipeline).
78
- *
79
- * **Required permission:** `Ibl.CRM/Pipelines/read`.
80
- * @returns PipelineStage
81
- * @throws ApiError
82
- */
83
- static pipelinesStagesRetrieve({ id, pipelinePk, }: {
84
- id: number;
85
- pipelinePk: number;
86
- }): CancelablePromise<PipelineStage>;
87
- /**
88
- * Replace a stage
89
- * Replaces all editable fields on the PipelineStage.
90
- *
91
- * **Required permission:** `Ibl.CRM/Pipelines/write`.
92
- * @returns PipelineStage
93
- * @throws ApiError
94
- */
95
- static pipelinesStagesUpdate({ id, pipelinePk, requestBody, }: {
96
- id: number;
97
- pipelinePk: number;
98
- requestBody: PipelineStage;
99
- }): CancelablePromise<PipelineStage>;
100
- /**
101
- * Update a stage
102
- * Updates only the supplied fields on the PipelineStage.
103
- *
104
- * **Required permission:** `Ibl.CRM/Pipelines/write`.
105
- * @returns PipelineStage
106
- * @throws ApiError
107
- */
108
- static pipelinesStagesPartialUpdate({ id, pipelinePk, requestBody, }: {
109
- id: number;
110
- pipelinePk: number;
111
- requestBody?: PatchedPipelineStage;
112
- }): CancelablePromise<PipelineStage>;
113
- /**
114
- * Delete a stage
115
- * Deletes the PipelineStage. Fails with `409 Conflict` if any Deal still references it (FK is PROTECTed).
116
- *
117
- * **Required permission:** `Ibl.CRM/Pipelines/delete`.
118
- * @returns void
119
- * @throws ApiError
120
- */
121
- static pipelinesStagesDestroy({ id, pipelinePk, }: {
122
- id: number;
123
- pipelinePk: number;
124
- }): CancelablePromise<void>;
125
- /**
126
- * Retrieve a pipeline
127
- * Returns a single Pipeline by id, including its ordered `stages`.
128
- *
129
- * **Required permission:** `Ibl.CRM/Pipelines/read`.
130
- * @returns Pipeline
131
- * @throws ApiError
132
- */
133
- static pipelinesRetrieve({ id, }: {
134
- /**
135
- * A unique integer value identifying this pipeline.
136
- */
137
- id: number;
138
- }): CancelablePromise<Pipeline>;
139
- /**
140
- * Replace a pipeline
141
- * Replaces all editable fields on the Pipeline.
142
- *
143
- * **Required permission:** `Ibl.CRM/Pipelines/write`.
144
- * @returns Pipeline
145
- * @throws ApiError
146
- */
147
- static pipelinesUpdate({ id, requestBody, }: {
148
- /**
149
- * A unique integer value identifying this pipeline.
150
- */
151
- id: number;
152
- requestBody: Pipeline;
153
- }): CancelablePromise<Pipeline>;
154
- /**
155
- * Update a pipeline
156
- * Updates only the supplied fields on the Pipeline.
157
- *
158
- * **Required permission:** `Ibl.CRM/Pipelines/write`.
159
- * @returns Pipeline
160
- * @throws ApiError
161
- */
162
- static pipelinesPartialUpdate({ id, requestBody, }: {
163
- /**
164
- * A unique integer value identifying this pipeline.
165
- */
166
- id: number;
167
- requestBody?: PatchedPipeline;
168
- }): CancelablePromise<Pipeline>;
169
- /**
170
- * Delete a pipeline
171
- * Deletes the Pipeline. Fails with `409 Conflict` if any Deal still references it (FK is PROTECTed).
172
- *
173
- * **Required permission:** `Ibl.CRM/Pipelines/delete`.
174
- * @returns void
175
- * @throws ApiError
176
- */
177
- static pipelinesDestroy({ id, }: {
178
- /**
179
- * A unique integer value identifying this pipeline.
180
- */
181
- id: number;
182
- }): CancelablePromise<void>;
183
- }
@@ -1,332 +0,0 @@
1
- import type { CheckoutSessionCreate } from '../models/CheckoutSessionCreate';
2
- import type { CheckoutSessionResponse } from '../models/CheckoutSessionResponse';
3
- import type { ItemAccessCheckResponse } from '../models/ItemAccessCheckResponse';
4
- import type { ItemPaywallConfig } from '../models/ItemPaywallConfig';
5
- import type { ItemPaywallConfigCreate } from '../models/ItemPaywallConfigCreate';
6
- import type { ItemPrice } from '../models/ItemPrice';
7
- import type { ItemPriceCreate } from '../models/ItemPriceCreate';
8
- import type { ItemSubscription } from '../models/ItemSubscription';
9
- import type { PaginatedItemPaywallConfigList } from '../models/PaginatedItemPaywallConfigList';
10
- import type { PaginatedItemSubscriptionList } from '../models/PaginatedItemSubscriptionList';
11
- import type { PaginatedItemSubscriptionListList } from '../models/PaginatedItemSubscriptionListList';
12
- import type { PlatformRevenueSummary } from '../models/PlatformRevenueSummary';
13
- import type { PortalUrlResponse } from '../models/PortalUrlResponse';
14
- import type { PublicItemPricing } from '../models/PublicItemPricing';
15
- import type { CancelablePromise } from '../core/CancelablePromise';
16
- export declare class PlatformsService {
17
- /**
18
- * Check whether the authenticated user has payment access to an item on a scoped platform.
19
- * @returns ItemAccessCheckResponse
20
- * @throws ApiError
21
- */
22
- static platformsItemsAccessCheckRetrieve({ itemId, itemType, platformKey, }: {
23
- itemId: string;
24
- itemType: string;
25
- platformKey: string;
26
- }): CancelablePromise<ItemAccessCheckResponse>;
27
- /**
28
- * Create checkout session
29
- * Create a Stripe checkout session for an authenticated user to purchase or subscribe to an item.
30
- * @returns CheckoutSessionResponse
31
- * @throws ApiError
32
- */
33
- static platformsItemsCheckoutCreate({ itemId, itemType, platformKey, requestBody, }: {
34
- itemId: string;
35
- itemType: string;
36
- platformKey: string;
37
- requestBody?: CheckoutSessionCreate;
38
- }): CancelablePromise<CheckoutSessionResponse>;
39
- /**
40
- * Handle checkout callback
41
- * Stripe redirects here after checkout. Processes the completed session and redirects to the return URL.
42
- * @returns void
43
- * @throws ApiError
44
- */
45
- static platformsItemsCheckoutCallbackRetrieve({ itemId, itemType, platformKey, returnUrl, }: {
46
- itemId: string;
47
- itemType: string;
48
- platformKey: string;
49
- returnUrl?: string | null;
50
- }): CancelablePromise<void>;
51
- /**
52
- * Handle checkout callback
53
- * Stripe redirects here after checkout. Processes the completed session and redirects to the return URL.
54
- * @returns void
55
- * @throws ApiError
56
- */
57
- static platformsItemsCheckoutCallbackRetrieve2({ checkoutSessionId, itemId, itemType, platformKey, returnUrl, }: {
58
- checkoutSessionId: string;
59
- itemId: string;
60
- itemType: string;
61
- platformKey: string;
62
- returnUrl?: string | null;
63
- }): CancelablePromise<void>;
64
- /**
65
- * Create guest checkout session
66
- * Create a Stripe checkout session for a guest user (email required).
67
- * @returns CheckoutSessionResponse
68
- * @throws ApiError
69
- */
70
- static platformsItemsCheckoutGuestCreate({ itemId, itemType, platformKey, requestBody, }: {
71
- itemId: string;
72
- itemType: string;
73
- platformKey: string;
74
- requestBody?: CheckoutSessionCreate;
75
- }): CancelablePromise<CheckoutSessionResponse>;
76
- /**
77
- * Get paywall configuration
78
- * Retrieve the paywall configuration for an item. Returns default (disabled) config if none exists.
79
- * @returns ItemPaywallConfig
80
- * @throws ApiError
81
- */
82
- static platformsItemsPaywallRetrieve({ itemId, itemType, platformKey, }: {
83
- itemId: string;
84
- itemType: string;
85
- platformKey: string;
86
- }): CancelablePromise<ItemPaywallConfig>;
87
- /**
88
- * Create or update paywall configuration
89
- * Enable or configure the paywall for an item. Creates a Stripe product on first enable.
90
- * @returns ItemPaywallConfig
91
- * @throws ApiError
92
- */
93
- static platformsItemsPaywallCreate({ itemId, itemType, platformKey, requestBody, }: {
94
- itemId: string;
95
- itemType: string;
96
- platformKey: string;
97
- requestBody?: ItemPaywallConfigCreate;
98
- }): CancelablePromise<ItemPaywallConfig>;
99
- /**
100
- * Update paywall configuration
101
- * Same as POST. Update the paywall configuration for an item.
102
- * @returns ItemPaywallConfig
103
- * @throws ApiError
104
- */
105
- static platformsItemsPaywallUpdate({ itemId, itemType, platformKey, requestBody, }: {
106
- itemId: string;
107
- itemType: string;
108
- platformKey: string;
109
- requestBody?: ItemPaywallConfigCreate;
110
- }): CancelablePromise<ItemPaywallConfig>;
111
- /**
112
- * Disable paywall configuration
113
- * Disable the paywall for an item. Does not delete the configuration.
114
- * @returns void
115
- * @throws ApiError
116
- */
117
- static platformsItemsPaywallDestroy({ itemId, itemType, platformKey, }: {
118
- itemId: string;
119
- itemType: string;
120
- platformKey: string;
121
- }): CancelablePromise<void>;
122
- /**
123
- * List prices
124
- * List active prices for an item's paywall configuration.
125
- * @returns ItemPrice
126
- * @throws ApiError
127
- */
128
- static platformsItemsPaywallPricesList({ itemId, itemType, platformKey, }: {
129
- itemId: string;
130
- itemType: string;
131
- platformKey: string;
132
- }): CancelablePromise<Array<ItemPrice>>;
133
- /**
134
- * Create a price
135
- * Create a new price tier for an item. Requires paywall to be enabled and Stripe Connect account ready.
136
- * @returns ItemPrice
137
- * @throws ApiError
138
- */
139
- static platformsItemsPaywallPricesCreate({ itemId, itemType, platformKey, requestBody, }: {
140
- itemId: string;
141
- itemType: string;
142
- platformKey: string;
143
- requestBody: ItemPriceCreate;
144
- }): CancelablePromise<ItemPrice>;
145
- /**
146
- * Get price details
147
- * Retrieve a specific price by ID.
148
- * @returns ItemPrice
149
- * @throws ApiError
150
- */
151
- static platformsItemsPaywallPricesRetrieve({ itemId, itemType, platformKey, priceId, }: {
152
- itemId: string;
153
- itemType: string;
154
- platformKey: string;
155
- priceId: string;
156
- }): CancelablePromise<ItemPrice>;
157
- /**
158
- * Update a price
159
- * Update a price tier. If pricing fields change and a Stripe price exists, a new Stripe price is created and the old one deactivated.
160
- * @returns ItemPrice
161
- * @throws ApiError
162
- */
163
- static platformsItemsPaywallPricesUpdate({ itemId, itemType, platformKey, priceId, requestBody, }: {
164
- itemId: string;
165
- itemType: string;
166
- platformKey: string;
167
- priceId: string;
168
- requestBody: ItemPriceCreate;
169
- }): CancelablePromise<ItemPrice>;
170
- /**
171
- * Delete a price
172
- * Soft-delete a price tier and deactivate the corresponding Stripe price.
173
- * @returns void
174
- * @throws ApiError
175
- */
176
- static platformsItemsPaywallPricesDestroy({ itemId, itemType, platformKey, priceId, }: {
177
- itemId: string;
178
- itemType: string;
179
- platformKey: string;
180
- priceId: string;
181
- }): CancelablePromise<void>;
182
- /**
183
- * Get public pricing
184
- * Retrieve public pricing information for an item. No authentication required.
185
- * @returns PublicItemPricing
186
- * @throws ApiError
187
- */
188
- static platformsItemsPricingRetrieve({ itemId, itemType, platformKey, }: {
189
- itemId: string;
190
- itemType: string;
191
- platformKey: string;
192
- }): CancelablePromise<PublicItemPricing>;
193
- /**
194
- * List item subscribers
195
- * List all subscribers for an item. Optionally filter by subscription status.
196
- * @returns PaginatedItemSubscriptionList
197
- * @throws ApiError
198
- */
199
- static platformsItemsSubscribersList({ itemId, itemType, platformKey, page, pageSize, search, status, }: {
200
- itemId: string;
201
- itemType: string;
202
- platformKey: string;
203
- /**
204
- * A page number within the paginated result set.
205
- */
206
- page?: number;
207
- /**
208
- * Number of results to return per page.
209
- */
210
- pageSize?: number;
211
- search?: string;
212
- /**
213
- * * `active` - Active
214
- * * `free` - Free Tier
215
- * * `grandfathered` - Grandfathered
216
- * * `trialing` - Trialing
217
- * * `past_due` - Past Due
218
- * * `canceled` - Canceled
219
- * * `incomplete` - Incomplete
220
- */
221
- status?: 'active' | 'free' | 'grandfathered' | 'trialing' | 'past_due' | 'canceled' | 'incomplete';
222
- }): CancelablePromise<PaginatedItemSubscriptionList>;
223
- /**
224
- * Get user subscription
225
- * Retrieve the current user's subscription to an item.
226
- * @returns ItemSubscription
227
- * @throws ApiError
228
- */
229
- static platformsItemsSubscriptionRetrieve({ itemId, itemType, platformKey, }: {
230
- itemId: string;
231
- itemType: string;
232
- platformKey: string;
233
- }): CancelablePromise<ItemSubscription>;
234
- /**
235
- * Cancel subscription
236
- * Cancel the current user's subscription. Returns a Stripe customer portal URL for recurring subscriptions, or cancels directly for one-time purchases.
237
- * @returns PortalUrlResponse
238
- * @throws ApiError
239
- */
240
- static platformsItemsSubscriptionCancelCreate({ itemId, itemType, platformKey, }: {
241
- itemId: string;
242
- itemType: string;
243
- platformKey: string;
244
- }): CancelablePromise<PortalUrlResponse>;
245
- /**
246
- * List user subscriptions
247
- * Paginated list of the current user's subscriptions on a platform. Optionally filter by status or item_type.
248
- * @returns PaginatedItemSubscriptionListList
249
- * @throws ApiError
250
- */
251
- static platformsMySubscriptionsList({ platformKey, itemType, page, pageSize, search, status, }: {
252
- platformKey: string;
253
- itemType?: string;
254
- /**
255
- * A page number within the paginated result set.
256
- */
257
- page?: number;
258
- /**
259
- * Number of results to return per page.
260
- */
261
- pageSize?: number;
262
- search?: string;
263
- /**
264
- * * `active` - Active
265
- * * `free` - Free Tier
266
- * * `grandfathered` - Grandfathered
267
- * * `trialing` - Trialing
268
- * * `past_due` - Past Due
269
- * * `canceled` - Canceled
270
- * * `incomplete` - Incomplete
271
- */
272
- status?: 'active' | 'free' | 'grandfathered' | 'trialing' | 'past_due' | 'canceled' | 'incomplete';
273
- }): CancelablePromise<PaginatedItemSubscriptionListList>;
274
- /**
275
- * List all platform paywall configurations
276
- * Paginated list of all item paywall configurations on a platform. Filterable by item_type and is_enabled.
277
- * @returns PaginatedItemPaywallConfigList
278
- * @throws ApiError
279
- */
280
- static platformsPaywallsList({ platformKey, isEnabled, itemType, page, pageSize, search, }: {
281
- platformKey: string;
282
- isEnabled?: boolean | null;
283
- itemType?: string;
284
- /**
285
- * A page number within the paginated result set.
286
- */
287
- page?: number;
288
- /**
289
- * Number of results to return per page.
290
- */
291
- pageSize?: number;
292
- search?: string;
293
- }): CancelablePromise<PaginatedItemPaywallConfigList>;
294
- /**
295
- * Platform sales summary
296
- * Aggregate sales volume and count for a platform across all item types.
297
- * @returns PlatformRevenueSummary
298
- * @throws ApiError
299
- */
300
- static platformsRevenueRetrieve({ platformKey, }: {
301
- platformKey: string;
302
- }): CancelablePromise<PlatformRevenueSummary>;
303
- /**
304
- * List all platform subscribers
305
- * Paginated list of all subscribers across all items on a platform. Filterable by status and item_type.
306
- * @returns PaginatedItemSubscriptionListList
307
- * @throws ApiError
308
- */
309
- static platformsSubscribersList({ platformKey, itemType, page, pageSize, search, status, }: {
310
- platformKey: string;
311
- itemType?: string;
312
- /**
313
- * A page number within the paginated result set.
314
- */
315
- page?: number;
316
- /**
317
- * Number of results to return per page.
318
- */
319
- pageSize?: number;
320
- search?: string;
321
- /**
322
- * * `active` - Active
323
- * * `free` - Free Tier
324
- * * `grandfathered` - Grandfathered
325
- * * `trialing` - Trialing
326
- * * `past_due` - Past Due
327
- * * `canceled` - Canceled
328
- * * `incomplete` - Incomplete
329
- */
330
- status?: 'active' | 'free' | 'grandfathered' | 'trialing' | 'past_due' | 'canceled' | 'incomplete';
331
- }): CancelablePromise<PaginatedItemSubscriptionListList>;
332
- }
@@ -1,15 +0,0 @@
1
- import type { CheckoutSessionCreate } from '../models/CheckoutSessionCreate';
2
- import type { CheckoutSessionResponse } from '../models/CheckoutSessionResponse';
3
- import type { CancelablePromise } from '../core/CancelablePromise';
4
- export declare class PricesService {
5
- /**
6
- * Create guest checkout session by price unique_id
7
- * Looks up the price by its unique_id, derives platform/item_type/item_id, and delegates to the standard guest checkout flow.
8
- * @returns CheckoutSessionResponse
9
- * @throws ApiError
10
- */
11
- static pricesCheckoutGuestCreate({ priceUniqueId, requestBody, }: {
12
- priceUniqueId: string;
13
- requestBody?: CheckoutSessionCreate;
14
- }): CancelablePromise<CheckoutSessionResponse>;
15
- }