strike_api.models package
Submodules
strike_api.models.accounts module
- pydantic model strike_api.models.accounts.Account[source]
Bases:
StrikeAPIModelShow JSON schema
{ "title": "Account", "type": "object", "properties": { "handle": { "title": "Handle", "type": "string" }, "avatarUrl": { "title": "Avatarurl", "type": "string" }, "canReceive": { "title": "Canreceive", "type": "boolean" }, "currencies": { "title": "Currencies", "type": "array", "items": { "$ref": "#/definitions/Currency" } } }, "required": [ "handle", "avatarUrl", "canReceive", "currencies" ], "definitions": { "Currency": { "title": "Currency", "type": "object", "properties": { "currency": { "title": "Currency", "type": "string" }, "isDefaultCurrency": { "title": "Isdefaultcurrency", "type": "boolean" }, "isAvailable": { "title": "Isavailable", "type": "boolean" }, "isInvoiceable": { "title": "Isinvoiceable", "type": "boolean" } }, "required": [ "currency", "isDefaultCurrency", "isAvailable", "isInvoiceable" ] } } }
- Config
alias_generator: function = <function camelize at 0x7f1b13babb80>
- Fields
- field avatar_url: str [Required] (alias 'avatarUrl')
- field can_receive: bool [Required] (alias 'canReceive')
- field handle: str [Required]
- pydantic model strike_api.models.accounts.Currency[source]
Bases:
StrikeAPIModelShow JSON schema
{ "title": "Currency", "type": "object", "properties": { "currency": { "title": "Currency", "type": "string" }, "isDefaultCurrency": { "title": "Isdefaultcurrency", "type": "boolean" }, "isAvailable": { "title": "Isavailable", "type": "boolean" }, "isInvoiceable": { "title": "Isinvoiceable", "type": "boolean" } }, "required": [ "currency", "isDefaultCurrency", "isAvailable", "isInvoiceable" ] }
- Config
alias_generator: function = <function camelize at 0x7f1b13babb80>
- Fields
- field currency: str [Required]
- field is_available: bool [Required] (alias 'isAvailable')
- field is_default_currency: bool [Required] (alias 'isDefaultCurrency')
- field is_invoiceable: bool [Required] (alias 'isInvoiceable')
strike_api.models.errors module
- pydantic model strike_api.models.errors.Data[source]
Bases:
StrikeAPIModelShow JSON schema
{ "title": "Data", "type": "object", "properties": { "status": { "title": "Status", "type": "integer" }, "code": { "title": "Code", "type": "string" }, "message": { "title": "Message", "type": "string" } }, "required": [ "status", "code", "message" ] }
- Config
alias_generator: function = <function camelize at 0x7f1b13babb80>
- Fields
- field code: str [Required]
- field message: str [Required]
- field status: int [Required]
- pydantic model strike_api.models.errors.Error401[source]
Bases:
StrikeAPIModelShow JSON schema
{ "title": "Error401", "type": "object", "properties": { "data": { "$ref": "#/definitions/Data" } }, "required": [ "data" ], "definitions": { "Data": { "title": "Data", "type": "object", "properties": { "status": { "title": "Status", "type": "integer" }, "code": { "title": "Code", "type": "string" }, "message": { "title": "Message", "type": "string" } }, "required": [ "status", "code", "message" ] } } }
- Config
alias_generator: function = <function camelize at 0x7f1b13babb80>
- Fields
- pydantic model strike_api.models.errors.Error404[source]
Bases:
StrikeAPIModelShow JSON schema
{ "title": "Error404", "type": "object", "properties": { "traceId": { "title": "Traceid", "type": "string" }, "data": { "$ref": "#/definitions/Data" } }, "required": [ "traceId", "data" ], "definitions": { "Data": { "title": "Data", "type": "object", "properties": { "status": { "title": "Status", "type": "integer" }, "code": { "title": "Code", "type": "string" }, "message": { "title": "Message", "type": "string" } }, "required": [ "status", "code", "message" ] } } }
- Config
alias_generator: function = <function camelize at 0x7f1b13babb80>
- Fields
- field traceId: str [Required]
strike_api.models.events module
- pydantic model strike_api.models.events.Data[source]
Bases:
StrikeAPIModelShow JSON schema
{ "title": "Data", "type": "object", "properties": { "entityId": { "title": "Entityid", "type": "string" } }, "required": [ "entityId" ] }
- Config
alias_generator: function = <function camelize at 0x7f1b13babb80>
- Fields
- field entityId: str [Required]
- pydantic model strike_api.models.events.Event[source]
Bases:
StrikeAPIModelShow JSON schema
{ "title": "Event", "type": "object", "properties": { "id": { "title": "Id", "type": "string" }, "eventType": { "title": "Eventtype", "type": "string" }, "webhookVersion": { "title": "Webhookversion", "type": "string" }, "data": { "$ref": "#/definitions/Data" }, "created": { "title": "Created", "type": "string" }, "deliverySuccess": { "title": "Deliverysuccess", "type": "boolean" } }, "required": [ "id", "eventType", "webhookVersion", "data", "created", "deliverySuccess" ], "definitions": { "Data": { "title": "Data", "type": "object", "properties": { "entityId": { "title": "Entityid", "type": "string" } }, "required": [ "entityId" ] } } }
- Config
alias_generator: function = <function camelize at 0x7f1b13babb80>
- Fields
- field created: str [Required]
- field delivery_success: bool [Required] (alias 'deliverySuccess')
- field event_type: str [Required] (alias 'eventType')
- field id: str [Required]
- field webhook_version: str [Required] (alias 'webhookVersion')
- pydantic model strike_api.models.events.EventItems[source]
Bases:
ItemsResponseShow JSON schema
{ "title": "EventItems", "type": "object", "properties": { "items": { "title": "Items", "type": "array", "items": { "$ref": "#/definitions/Event" } }, "count": { "title": "Count", "type": "integer" } }, "required": [ "items", "count" ], "definitions": { "Data": { "title": "Data", "type": "object", "properties": { "entityId": { "title": "Entityid", "type": "string" } }, "required": [ "entityId" ] }, "Event": { "title": "Event", "type": "object", "properties": { "id": { "title": "Id", "type": "string" }, "eventType": { "title": "Eventtype", "type": "string" }, "webhookVersion": { "title": "Webhookversion", "type": "string" }, "data": { "$ref": "#/definitions/Data" }, "created": { "title": "Created", "type": "string" }, "deliverySuccess": { "title": "Deliverysuccess", "type": "boolean" } }, "required": [ "id", "eventType", "webhookVersion", "data", "created", "deliverySuccess" ] } } }
- Config
alias_generator: function = <function camelize at 0x7f1b13babb80>
- Fields
- pydantic model strike_api.models.events.Events[source]
Bases:
StrikeAPIModelShow JSON schema
{ "title": "Events", "type": "array", "items": { "$ref": "#/definitions/Event" }, "definitions": { "Data": { "title": "Data", "type": "object", "properties": { "entityId": { "title": "Entityid", "type": "string" } }, "required": [ "entityId" ] }, "Event": { "title": "Event", "type": "object", "properties": { "id": { "title": "Id", "type": "string" }, "eventType": { "title": "Eventtype", "type": "string" }, "webhookVersion": { "title": "Webhookversion", "type": "string" }, "data": { "$ref": "#/definitions/Data" }, "created": { "title": "Created", "type": "string" }, "deliverySuccess": { "title": "Deliverysuccess", "type": "boolean" } }, "required": [ "id", "eventType", "webhookVersion", "data", "created", "deliverySuccess" ] } } }
- Config
alias_generator: function = <function camelize at 0x7f1b13babb80>
- Fields
__root__ (List[strike_api.models.events.Event])
strike_api.models.generic module
- pydantic model strike_api.models.generic.ItemsResponse[source]
Bases:
StrikeAPIModelShow JSON schema
{ "title": "ItemsResponse", "type": "object", "properties": { "items": { "title": "Items", "type": "array", "items": {} }, "count": { "title": "Count", "type": "integer" } }, "required": [ "items", "count" ] }
- Config
alias_generator: function = <function camelize at 0x7f1b13babb80>
- Fields
- field count: int [Required]
- field items: List[Any] [Required]
strike_api.models.invoices module
- pydantic model strike_api.models.invoices.Amount[source]
Bases:
StrikeAPIModelShow JSON schema
{ "title": "Amount", "type": "object", "properties": { "currency": { "title": "Currency", "type": "string" }, "amount": { "title": "Amount", "type": "string" } }, "required": [ "currency", "amount" ] }
- Config
alias_generator: function = <function camelize at 0x7f1b13babb80>
- Fields
- field amount: str [Required]
- field currency: str [Required]
- class strike_api.models.invoices.INVOICE_STATES(value)[source]
Bases:
EnumAn enumeration.
- CANCELLED = 'CANCELLED'
- PAID = 'PAID'
- PENDING = 'PENDING'
- UNPAID = 'UNPAID'
- pydantic model strike_api.models.invoices.Invoice[source]
Bases:
StrikeAPIModelShow JSON schema
{ "title": "Invoice", "type": "object", "properties": { "invoiceId": { "title": "Invoiceid", "type": "string" }, "amount": { "$ref": "#/definitions/Amount" }, "state": { "title": "State", "type": "string" }, "created": { "title": "Created", "type": "string" }, "correlationId": { "title": "Correlationid", "type": "string" }, "description": { "title": "Description", "type": "string" }, "issuerId": { "title": "Issuerid", "type": "string" }, "receiverId": { "title": "Receiverid", "type": "string" } }, "required": [ "invoiceId", "amount", "state", "created", "correlationId", "description", "issuerId", "receiverId" ], "definitions": { "Amount": { "title": "Amount", "type": "object", "properties": { "currency": { "title": "Currency", "type": "string" }, "amount": { "title": "Amount", "type": "string" } }, "required": [ "currency", "amount" ] } } }
- Config
alias_generator: function = <function camelize at 0x7f1b13babb80>
- Fields
- field correlation_id: str [Required] (alias 'correlationId')
- field created: str [Required]
- field description: str [Required]
- field invoiceId: str [Required]
- field issuer_id: str [Required] (alias 'issuerId')
- field receiver_id: str [Required] (alias 'receiverId')
- field state: str [Required]
- pydantic model strike_api.models.invoices.InvoiceItems[source]
Bases:
ItemsResponseShow JSON schema
{ "title": "InvoiceItems", "type": "object", "properties": { "items": { "title": "Items", "type": "array", "items": { "$ref": "#/definitions/Invoice" } }, "count": { "title": "Count", "type": "integer" } }, "required": [ "items", "count" ], "definitions": { "Amount": { "title": "Amount", "type": "object", "properties": { "currency": { "title": "Currency", "type": "string" }, "amount": { "title": "Amount", "type": "string" } }, "required": [ "currency", "amount" ] }, "Invoice": { "title": "Invoice", "type": "object", "properties": { "invoiceId": { "title": "Invoiceid", "type": "string" }, "amount": { "$ref": "#/definitions/Amount" }, "state": { "title": "State", "type": "string" }, "created": { "title": "Created", "type": "string" }, "correlationId": { "title": "Correlationid", "type": "string" }, "description": { "title": "Description", "type": "string" }, "issuerId": { "title": "Issuerid", "type": "string" }, "receiverId": { "title": "Receiverid", "type": "string" } }, "required": [ "invoiceId", "amount", "state", "created", "correlationId", "description", "issuerId", "receiverId" ] } } }
- Config
alias_generator: function = <function camelize at 0x7f1b13babb80>
- Fields
- pydantic model strike_api.models.invoices.Invoices[source]
Bases:
StrikeAPIModelShow JSON schema
{ "title": "Invoices", "type": "array", "items": { "$ref": "#/definitions/Invoice" }, "definitions": { "Amount": { "title": "Amount", "type": "object", "properties": { "currency": { "title": "Currency", "type": "string" }, "amount": { "title": "Amount", "type": "string" } }, "required": [ "currency", "amount" ] }, "Invoice": { "title": "Invoice", "type": "object", "properties": { "invoiceId": { "title": "Invoiceid", "type": "string" }, "amount": { "$ref": "#/definitions/Amount" }, "state": { "title": "State", "type": "string" }, "created": { "title": "Created", "type": "string" }, "correlationId": { "title": "Correlationid", "type": "string" }, "description": { "title": "Description", "type": "string" }, "issuerId": { "title": "Issuerid", "type": "string" }, "receiverId": { "title": "Receiverid", "type": "string" } }, "required": [ "invoiceId", "amount", "state", "created", "correlationId", "description", "issuerId", "receiverId" ] } } }
- Config
alias_generator: function = <function camelize at 0x7f1b13babb80>
- Fields
__root__ (List[strike_api.models.invoices.Invoice])
strike_api.models.quotes module
- pydantic model strike_api.models.quotes.ConversionRate[source]
Bases:
StrikeAPIModelShow JSON schema
{ "title": "ConversionRate", "type": "object", "properties": { "amount": { "title": "Amount", "type": "string" }, "sourceCurrency": { "title": "Sourcecurrency", "type": "string" }, "targetCurrency": { "title": "Targetcurrency", "type": "string" } }, "required": [ "amount", "sourceCurrency", "targetCurrency" ] }
- Config
alias_generator: function = <function camelize at 0x7f1b13babb80>
- Fields
- field amount: str [Required]
- field source_currency: str [Required] (alias 'sourceCurrency')
- field target_currency: str [Required] (alias 'targetCurrency')
- pydantic model strike_api.models.quotes.Quote[source]
Bases:
StrikeAPIModelShow JSON schema
{ "title": "Quote", "type": "object", "properties": { "quoteId": { "title": "Quoteid", "type": "string" }, "description": { "title": "Description", "type": "string" }, "lnInvoice": { "title": "Lninvoice", "type": "string" }, "onchainAddress": { "title": "Onchainaddress", "type": "string" }, "expiration": { "title": "Expiration", "type": "string" }, "expirationInSec": { "title": "Expirationinsec", "type": "integer" }, "targetAmount": { "$ref": "#/definitions/TargetAmount" }, "sourceAmount": { "$ref": "#/definitions/SourceAmount" }, "conversionRate": { "$ref": "#/definitions/ConversionRate" } }, "required": [ "quoteId", "description", "lnInvoice", "onchainAddress", "expiration", "expirationInSec", "targetAmount", "sourceAmount", "conversionRate" ], "definitions": { "TargetAmount": { "title": "TargetAmount", "type": "object", "properties": { "currency": { "title": "Currency", "type": "string" }, "amount": { "title": "Amount", "type": "string" } }, "required": [ "currency", "amount" ] }, "SourceAmount": { "title": "SourceAmount", "type": "object", "properties": { "currency": { "title": "Currency", "type": "string" }, "amount": { "title": "Amount", "type": "string" } }, "required": [ "currency", "amount" ] }, "ConversionRate": { "title": "ConversionRate", "type": "object", "properties": { "amount": { "title": "Amount", "type": "string" }, "sourceCurrency": { "title": "Sourcecurrency", "type": "string" }, "targetCurrency": { "title": "Targetcurrency", "type": "string" } }, "required": [ "amount", "sourceCurrency", "targetCurrency" ] } } }
- Config
alias_generator: function = <function camelize at 0x7f1b13babb80>
- Fields
- field conversion_rate: ConversionRate [Required] (alias 'conversionRate')
- field description: str [Required]
- field expiration: str [Required]
- field expiration_in_sec: int [Required] (alias 'expirationInSec')
- field ln_invoice: str [Required] (alias 'lnInvoice')
- field onchain_address: str [Required] (alias 'onchainAddress')
- field quote_id: str [Required] (alias 'quoteId')
- field source_amount: SourceAmount [Required] (alias 'sourceAmount')
- field target_amount: TargetAmount [Required] (alias 'targetAmount')
- pydantic model strike_api.models.quotes.SourceAmount[source]
Bases:
StrikeAPIModelShow JSON schema
{ "title": "SourceAmount", "type": "object", "properties": { "currency": { "title": "Currency", "type": "string" }, "amount": { "title": "Amount", "type": "string" } }, "required": [ "currency", "amount" ] }
- Config
alias_generator: function = <function camelize at 0x7f1b13babb80>
- Fields
- field amount: str [Required]
- field currency: str [Required]
- pydantic model strike_api.models.quotes.TargetAmount[source]
Bases:
StrikeAPIModelShow JSON schema
{ "title": "TargetAmount", "type": "object", "properties": { "currency": { "title": "Currency", "type": "string" }, "amount": { "title": "Amount", "type": "string" } }, "required": [ "currency", "amount" ] }
- Config
alias_generator: function = <function camelize at 0x7f1b13babb80>
- Fields
- field amount: str [Required]
- field currency: str [Required]
strike_api.models.rates module
- pydantic model strike_api.models.rates.Rate[source]
Bases:
StrikeAPIModelShow JSON schema
{ "title": "Rate", "type": "object", "properties": { "amount": { "title": "Amount", "type": "string" }, "sourceCurrency": { "title": "Sourcecurrency", "type": "string" }, "targetCurrency": { "title": "Targetcurrency", "type": "string" } }, "required": [ "amount", "sourceCurrency", "targetCurrency" ] }
- Config
alias_generator: function = <function camelize at 0x7f1b13babb80>
- Fields
- field amount: str [Required]
- field source_currency: str [Required] (alias 'sourceCurrency')
- field target_currency: str [Required] (alias 'targetCurrency')
- pydantic model strike_api.models.rates.Rates[source]
Bases:
StrikeAPIModelShow JSON schema
{ "title": "Rates", "type": "array", "items": { "$ref": "#/definitions/Rate" }, "definitions": { "Rate": { "title": "Rate", "type": "object", "properties": { "amount": { "title": "Amount", "type": "string" }, "sourceCurrency": { "title": "Sourcecurrency", "type": "string" }, "targetCurrency": { "title": "Targetcurrency", "type": "string" } }, "required": [ "amount", "sourceCurrency", "targetCurrency" ] } } }
- Config
alias_generator: function = <function camelize at 0x7f1b13babb80>
- Fields
__root__ (List[strike_api.models.rates.Rate])
strike_api.models.subscriptions module
- pydantic model strike_api.models.subscriptions.Subscription[source]
Bases:
StrikeAPIModelShow JSON schema
{ "title": "Subscription", "type": "object", "properties": { "id": { "title": "Id", "type": "string" }, "webhookUrl": { "title": "Webhookurl", "type": "string" }, "webhookVersion": { "title": "Webhookversion", "type": "string" }, "enabled": { "title": "Enabled", "type": "boolean" }, "created": { "title": "Created", "type": "string" }, "eventTypes": { "title": "Eventtypes", "type": "array", "items": { "type": "string" } } }, "required": [ "id", "webhookUrl", "webhookVersion", "enabled", "created", "eventTypes" ] }
- Config
alias_generator: function = <function camelize at 0x7f1b13babb80>
- Fields
- field created: str [Required]
- field enabled: bool [Required]
- field event_types: List[str] [Required] (alias 'eventTypes')
- field id: str [Required]
- field webhook_url: str [Required] (alias 'webhookUrl')
- field webhook_version: str [Required] (alias 'webhookVersion')
- pydantic model strike_api.models.subscriptions.Subscriptions[source]
Bases:
StrikeAPIModelShow JSON schema
{ "title": "Subscriptions", "type": "array", "items": { "$ref": "#/definitions/Subscription" }, "definitions": { "Subscription": { "title": "Subscription", "type": "object", "properties": { "id": { "title": "Id", "type": "string" }, "webhookUrl": { "title": "Webhookurl", "type": "string" }, "webhookVersion": { "title": "Webhookversion", "type": "string" }, "enabled": { "title": "Enabled", "type": "boolean" }, "created": { "title": "Created", "type": "string" }, "eventTypes": { "title": "Eventtypes", "type": "array", "items": { "type": "string" } } }, "required": [ "id", "webhookUrl", "webhookVersion", "enabled", "created", "eventTypes" ] } } }
- Config
alias_generator: function = <function camelize at 0x7f1b13babb80>
- Fields
__root__ (List[strike_api.models.subscriptions.Subscription])