stigg.generated.client.Client

class documentation

class Client(BaseClient):

Known subclasses: stigg.client.StiggClient

Constructor: Client(url, headers, http_client)

Undocumented

Method	`apply_subscription`	Undocumented
Method	`archive_customer`	Undocumented
Method	`cancel_subscription`	Undocumented
Method	`cancel_subscription_updates`	Undocumented
Method	`create_payment_session`	Undocumented
Method	`create_subscription`	Undocumented
Method	`delegate_subscription_to_customer`	Undocumented
Method	`detach_customer_payment_method`	Undocumented
Method	`estimate_subscription`	Undocumented
Method	`estimate_subscription_update`	Undocumented
Method	`get_active_subscriptions`	Undocumented
Method	`get_active_subscriptions_list`	Undocumented
Method	`get_checkout_state`	Undocumented
Method	`get_coupons`	Undocumented
Method	`get_credit_balance`	Undocumented
Method	`get_credit_grants`	Undocumented
Method	`get_credit_ledger`	Undocumented
Method	`get_credit_usage`	Undocumented
Method	`get_customer_by_id`	Undocumented
Method	`get_customer_portal_by_ref_id`	Undocumented
Method	`get_customer_statistics`	Undocumented
Method	`get_entitlement`	Undocumented
Method	`get_entitlements`	Undocumented
Method	`get_entitlements_state`	Undocumented
Method	`get_mock_paywall`	Undocumented
Method	`get_paywall`	Undocumented
Method	`get_products`	Undocumented
Method	`get_sdk_configuration`	Undocumented
Method	`get_subscription`	Undocumented
Method	`get_subscriptions`	Undocumented
Method	`get_usage_history`	Undocumented
Method	`get_usage_history_v_2`	Undocumented
Method	`grant_credits`	Undocumented
Method	`grant_promotional_entitlements`	Undocumented
Method	`grant_promotional_entitlements_group`	Undocumented
Method	`import_customer`	Undocumented
Method	`import_customer_bulk`	Undocumented
Method	`import_subscriptions_bulk`	Undocumented
Method	`migrate_subscription_to_latest`	Undocumented
Method	`preview_next_invoice`	Undocumented
Method	`preview_subscription`	Undocumented
Method	`provision_customer`	Undocumented
Method	`provision_subscription`	Undocumented
Method	`report_entitlement_check_requested`	Undocumented
Method	`report_event`	Undocumented
Method	`report_usage`	Undocumented
Method	`report_usage_bulk`	Undocumented
Method	`revoke_promotional_entitlement`	Undocumented
Method	`revoke_promotional_entitlements_group`	Undocumented
Method	`transfer_subscription`	Undocumented
Method	`transfer_subscription_to_resource`	Undocumented
Method	`unarchive_customer`	Undocumented
Method	`unlink_promotional_entitlements_group`	Undocumented
Method	`update_customer`	Undocumented
Method	`update_subscription`	Undocumented
Method	`void_credit_grant`	Undocumented

Inherited from BaseClient:

Method	`__enter__`	Undocumented
Method	`__exit__`	Undocumented
Method	`__init__`	Undocumented
Method	`execute`	Undocumented
Method	`get_data`	Undocumented
Instance Variable	`headers`	Undocumented
Instance Variable	`http_client`	Undocumented
Instance Variable	`url`	Undocumented
Method	`_convert_dict_to_json_serializable`	Undocumented
Method	`_convert_value`	Undocumented
Method	`_execute_json`	Undocumented
Method	`_execute_multipart`	Undocumented
Method	`_get_files_from_variables`	Undocumented
Method	`_process_variables`	Undocumented

def apply_subscription(self, input: ApplySubscriptionInput, **kwargs: Any) -> ApplySubscription: ¶

Undocumented

def archive_customer(self, input: ArchiveCustomerInput, **kwargs: Any) -> ArchiveCustomer: ¶

Undocumented

def cancel_subscription(self, input: SubscriptionCancellationInput, **kwargs: Any) -> CancelSubscription: ¶

Undocumented

def cancel_subscription_updates(self, input: SubscriptionUpdateScheduleCancellationInput, **kwargs: Any) -> CancelSubscriptionUpdates: ¶

Undocumented

def create_payment_session(self, input: PaymentSessionInput, **kwargs: Any) -> CreatePaymentSession: ¶

Undocumented

def create_subscription(self, input: SubscriptionInput, **kwargs: Any) -> CreateSubscription: ¶

Undocumented

def delegate_subscription_to_customer(self, input: DelegateSubscriptionToCustomerInput, **kwargs: Any) -> DelegateSubscriptionToCustomer: ¶

Undocumented

def detach_customer_payment_method(self, input: DetachCustomerPaymentMethodInput, **kwargs: Any) -> DetachCustomerPaymentMethod: ¶

Undocumented

def estimate_subscription(self, input: EstimateSubscriptionInput, **kwargs: Any) -> EstimateSubscription: ¶

Undocumented

def estimate_subscription_update(self, input: EstimateSubscriptionUpdateInput, **kwargs: Any) -> EstimateSubscriptionUpdate: ¶

Undocumented

def get_active_subscriptions(self, input: GetActiveSubscriptionsInput, **kwargs: Any) -> GetActiveSubscriptions: ¶

Undocumented

def get_active_subscriptions_list(self, input: GetActiveSubscriptionsInput, **kwargs: Any) -> GetActiveSubscriptionsList: ¶

overridden in stigg.client.StiggClient

Undocumented

def get_checkout_state(self, input: CheckoutStateInput, **kwargs: Any) -> GetCheckoutState: ¶

Undocumented

def get_coupons(self, **kwargs: Any) -> GetCoupons: ¶

Undocumented

def get_credit_balance(self, input: CreditBalanceSummaryInput, **kwargs: Any) -> GetCreditBalance: ¶

Undocumented

def get_credit_grants(self, input: GetCreditGrantsInput, **kwargs: Any) -> GetCreditGrants: ¶

Undocumented

def get_credit_ledger(self, input: CreditLedgerInput, **kwargs: Any) -> GetCreditLedger: ¶

Undocumented

def get_credit_usage(self, input: CreditUsageInput, **kwargs: Any) -> GetCreditUsage: ¶

Undocumented

def get_customer_by_id(self, input: GetCustomerByRefIdInput, **kwargs: Any) -> GetCustomerById: ¶

Undocumented

def get_customer_portal_by_ref_id(self, input: CustomerPortalInput, **kwargs: Any) -> GetCustomerPortalByRefId: ¶

Undocumented

def get_customer_statistics(self, input: GetCustomerByRefIdInput, **kwargs: Any) -> GetCustomerStatistics: ¶

Undocumented

def get_entitlement(self, input: FetchEntitlementQuery, **kwargs: Any) -> GetEntitlement: ¶

overridden in stigg.client.StiggClient

Undocumented

def get_entitlements(self, input: FetchEntitlementsQuery, **kwargs: Any) -> GetEntitlements: ¶

overridden in stigg.client.StiggClient

Undocumented

def get_entitlements_state(self, input: FetchEntitlementsQuery, **kwargs: Any) -> GetEntitlementsState: ¶

Undocumented

def get_mock_paywall(self, input: GetPaywallInput, **kwargs: Any) -> GetMockPaywall: ¶

Undocumented

def get_paywall(self, input: GetPaywallInput, **kwargs: Any) -> GetPaywall: ¶

overridden in stigg.client.StiggClient

Undocumented

def get_products(self, **kwargs: Any) -> GetProducts: ¶

Undocumented

def get_sdk_configuration(self, **kwargs: Any) -> GetSdkConfiguration: ¶

Undocumented

def get_subscription(self, input: GetSubscriptionInput, **kwargs: Any) -> GetSubscription: ¶

Undocumented

Undocumented

def get_usage_history(self, usage_history_input: UsageHistoryInput, **kwargs: Any) -> GetUsageHistory: ¶

Undocumented

def get_usage_history_v_2(self, input: UsageHistoryV2Input, **kwargs: Any) -> GetUsageHistoryV2: ¶

Undocumented

def grant_credits(self, input: CreditGrantInput, **kwargs: Any) -> GrantCredits: ¶

Undocumented

def grant_promotional_entitlements(self, input: GrantPromotionalEntitlementsInput, **kwargs: Any) -> GrantPromotionalEntitlements: ¶

Undocumented

def grant_promotional_entitlements_group(self, input: GrantPromotionalEntitlementsGroupInput, **kwargs: Any) -> GrantPromotionalEntitlementsGroup: ¶

Undocumented

def import_customer(self, input: ImportCustomerInput, **kwargs: Any) -> ImportCustomer: ¶

Undocumented

def import_customer_bulk(self, input: ImportCustomerBulkInput, **kwargs: Any) -> ImportCustomerBulk: ¶

Undocumented

def import_subscriptions_bulk(self, input: ImportSubscriptionsBulkInput, **kwargs: Any) -> ImportSubscriptionsBulk: ¶

Undocumented

def migrate_subscription_to_latest(self, input: SubscriptionMigrationInput, **kwargs: Any) -> MigrateSubscriptionToLatest: ¶

Undocumented

def preview_next_invoice(self, input: PreviewNextInvoiceInput, **kwargs: Any) -> PreviewNextInvoice: ¶

Undocumented

def preview_subscription(self, input: PreviewSubscriptionInput, **kwargs: Any) -> PreviewSubscription: ¶

Undocumented

def provision_customer(self, input: ProvisionCustomerInput, **kwargs: Any) -> ProvisionCustomer: ¶

Undocumented

def provision_subscription(self, input: ProvisionSubscriptionInput, **kwargs: Any) -> ProvisionSubscription: ¶

Undocumented

def report_entitlement_check_requested(self, entitlement_check_requested: EntitlementCheckRequested, **kwargs: Any) -> ReportEntitlementCheckRequested: ¶

Undocumented

def report_event(self, input: UsageEventsReportInput, **kwargs: Any) -> ReportEvent: ¶

Undocumented

def report_usage(self, input: ReportUsageInput, **kwargs: Any) -> ReportUsage: ¶

overridden in stigg.client.StiggClient

Undocumented

def report_usage_bulk(self, input: ReportUsageBulkInput, **kwargs: Any) -> ReportUsageBulk: ¶

Undocumented

def revoke_promotional_entitlement(self, input: RevokePromotionalEntitlementInput, **kwargs: Any) -> RevokePromotionalEntitlement: ¶

Undocumented

def revoke_promotional_entitlements_group(self, input: RevokePromotionalEntitlementsGroupInput, **kwargs: Any) -> RevokePromotionalEntitlementsGroup: ¶

Undocumented

def transfer_subscription(self, input: TransferSubscriptionInput, **kwargs: Any) -> TransferSubscription: ¶

Undocumented

def transfer_subscription_to_resource(self, input: TransferSubscriptionToResourceInput, **kwargs: Any) -> TransferSubscriptionToResource: ¶

Undocumented

def unarchive_customer(self, input: UnarchiveCustomerInput, **kwargs: Any) -> UnarchiveCustomer: ¶

Undocumented

def unlink_promotional_entitlements_group(self, input: UnlinkPromotionalEntitlementsGroupInput, **kwargs: Any) -> UnlinkPromotionalEntitlementsGroup: ¶

Undocumented

def update_customer(self, input: UpdateCustomerInput, **kwargs: Any) -> UpdateCustomer: ¶

Undocumented

def update_subscription(self, input: UpdateSubscriptionInput, **kwargs: Any) -> UpdateSubscription: ¶

Undocumented

def void_credit_grant(self, input: VoidCreditGrantInput, **kwargs: Any) -> VoidCreditGrant: ¶

Undocumented