@censys/platform-sdk 0.9.0 → 0.9.1
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.
- package/README.md +8 -6
- package/docs/sdks/accountmanagement/README.md +100 -6
- package/docs/sdks/collections/README.md +6 -6
- package/docs/sdks/threathunting/README.md +1 -1
- package/examples/package-lock.json +1 -1
- package/funcs/accountManagementGetMemberCreditUsage.d.ts +2 -2
- package/funcs/accountManagementGetMemberCreditUsage.js +5 -2
- package/funcs/accountManagementGetMemberCreditUsage.js.map +1 -1
- package/funcs/accountManagementGetOrganizationCreditUsage.d.ts +1 -1
- package/funcs/accountManagementGetOrganizationCreditUsage.js +5 -1
- package/funcs/accountManagementGetOrganizationCreditUsage.js.map +1 -1
- package/funcs/accountManagementGetOrganizationCredits.d.ts +1 -1
- package/funcs/accountManagementGetOrganizationCredits.js +1 -1
- package/funcs/accountManagementGetUserCredits.d.ts +2 -2
- package/funcs/accountManagementGetUserCredits.js +2 -2
- package/funcs/accountManagementGetUserCreditsUsage.d.ts +18 -0
- package/funcs/accountManagementGetUserCreditsUsage.d.ts.map +1 -0
- package/funcs/accountManagementGetUserCreditsUsage.js +129 -0
- package/funcs/accountManagementGetUserCreditsUsage.js.map +1 -0
- package/funcs/collectionsCreate.d.ts +1 -1
- package/funcs/collectionsCreate.js +1 -1
- package/funcs/collectionsDelete.d.ts +1 -1
- package/funcs/collectionsDelete.js +1 -1
- package/funcs/collectionsGet.d.ts +1 -1
- package/funcs/collectionsGet.js +1 -1
- package/funcs/collectionsList.d.ts +1 -1
- package/funcs/collectionsList.js +1 -1
- package/funcs/collectionsListEvents.d.ts +1 -1
- package/funcs/collectionsListEvents.js +1 -1
- package/funcs/collectionsUpdate.d.ts +1 -1
- package/funcs/collectionsUpdate.js +1 -1
- package/funcs/threatHuntingListThreats.d.ts +1 -1
- package/funcs/threatHuntingListThreats.js +1 -1
- package/jsr.json +1 -1
- package/lib/config.d.ts +4 -4
- package/lib/config.js +4 -4
- package/lib/sdks.js +2 -2
- package/lib/sdks.js.map +1 -1
- package/models/components/alternativequery.d.ts +3 -3
- package/models/components/alternativequery.d.ts.map +1 -1
- package/models/components/alternativequery.js +2 -2
- package/models/components/alternativequery.js.map +1 -1
- package/models/components/attribute.d.ts +4 -3
- package/models/components/attribute.d.ts.map +1 -1
- package/models/components/attribute.js +3 -2
- package/models/components/attribute.js.map +1 -1
- package/models/components/certificate.d.ts +5 -5
- package/models/components/certificate.d.ts.map +1 -1
- package/models/components/certificate.js +3 -3
- package/models/components/certificate.js.map +1 -1
- package/models/components/certificaterevocationrevocationinfo.d.ts +3 -3
- package/models/components/certificaterevocationrevocationinfo.d.ts.map +1 -1
- package/models/components/certificaterevocationrevocationinfo.js +2 -2
- package/models/components/certificaterevocationrevocationinfo.js.map +1 -1
- package/models/components/collection.d.ts +9 -5
- package/models/components/collection.d.ts.map +1 -1
- package/models/components/collection.js +5 -2
- package/models/components/collection.js.map +1 -1
- package/models/components/creditexpiration.d.ts +4 -0
- package/models/components/creditexpiration.d.ts.map +1 -1
- package/models/components/creditexpiration.js +2 -0
- package/models/components/creditexpiration.js.map +1 -1
- package/models/components/creditusagereport.d.ts +44 -5
- package/models/components/creditusagereport.d.ts.map +1 -1
- package/models/components/creditusagereport.js +28 -7
- package/models/components/creditusagereport.js.map +1 -1
- package/models/components/creditusagereportperiod.d.ts +33 -0
- package/models/components/creditusagereportperiod.d.ts.map +1 -0
- package/models/components/creditusagereportperiod.js +65 -0
- package/models/components/creditusagereportperiod.js.map +1 -0
- package/models/components/cvsscomponents.d.ts +17 -17
- package/models/components/cvsscomponents.d.ts.map +1 -1
- package/models/components/cvsscomponents.js +9 -9
- package/models/components/cvsscomponents.js.map +1 -1
- package/models/components/cvssv4components.d.ts +29 -29
- package/models/components/cvssv4components.d.ts.map +1 -1
- package/models/components/cvssv4components.js +15 -17
- package/models/components/cvssv4components.js.map +1 -1
- package/models/components/dns.d.ts +5 -5
- package/models/components/dns.d.ts.map +1 -1
- package/models/components/dns.js +3 -3
- package/models/components/dns.js.map +1 -1
- package/models/components/dnsresourcerecord.d.ts +3 -3
- package/models/components/dnsresourcerecord.d.ts.map +1 -1
- package/models/components/dnsresourcerecord.js +2 -1
- package/models/components/dnsresourcerecord.js.map +1 -1
- package/models/components/endpointscan.d.ts +3 -3
- package/models/components/endpointscan.d.ts.map +1 -1
- package/models/components/endpointscan.js +2 -1
- package/models/components/endpointscan.js.map +1 -1
- package/models/components/endpointscanstate.d.ts +5 -3
- package/models/components/endpointscanstate.d.ts.map +1 -1
- package/models/components/endpointscanstate.js +4 -1
- package/models/components/endpointscanstate.js.map +1 -1
- package/models/components/eventassetchange.d.ts +3 -3
- package/models/components/eventassetchange.d.ts.map +1 -1
- package/models/components/eventassetchange.js +2 -2
- package/models/components/eventassetchange.js.map +1 -1
- package/models/components/eventstatuschange.d.ts +5 -5
- package/models/components/eventstatuschange.d.ts.map +1 -1
- package/models/components/eventstatuschange.js +3 -4
- package/models/components/eventstatuschange.js.map +1 -1
- package/models/components/extractedendpointdata.d.ts +17 -0
- package/models/components/extractedendpointdata.d.ts.map +1 -0
- package/models/components/extractedendpointdata.js +65 -0
- package/models/components/extractedendpointdata.js.map +1 -0
- package/models/components/extractedendpointdataanalyticsservice.d.ts +11 -0
- package/models/components/extractedendpointdataanalyticsservice.d.ts.map +1 -0
- package/models/components/extractedendpointdataanalyticsservice.js +51 -0
- package/models/components/extractedendpointdataanalyticsservice.js.map +1 -0
- package/models/components/extractedendpointdatacopyright.d.ts +13 -0
- package/models/components/extractedendpointdatacopyright.d.ts.map +1 -0
- package/models/components/extractedendpointdatacopyright.js +59 -0
- package/models/components/extractedendpointdatacopyright.js.map +1 -0
- package/models/components/hajime.d.ts +10 -0
- package/models/components/hajime.d.ts.map +1 -0
- package/models/components/hajime.js +56 -0
- package/models/components/hajime.js.map +1 -0
- package/models/components/hostdnsforwardresolution.d.ts +3 -3
- package/models/components/hostdnsforwardresolution.d.ts.map +1 -1
- package/models/components/hostdnsforwardresolution.js +2 -2
- package/models/components/hostdnsforwardresolution.js.map +1 -1
- package/models/components/http.d.ts +7 -0
- package/models/components/http.d.ts.map +1 -1
- package/models/components/http.js +7 -0
- package/models/components/http.js.map +1 -1
- package/models/components/httpredirectchainlink.d.ts +25 -0
- package/models/components/httpredirectchainlink.d.ts.map +1 -0
- package/models/components/httpredirectchainlink.js +70 -0
- package/models/components/httpredirectchainlink.js.map +1 -0
- package/models/components/index.d.ts +8 -0
- package/models/components/index.d.ts.map +1 -1
- package/models/components/index.js +8 -0
- package/models/components/index.js.map +1 -1
- package/models/components/jarmscan.d.ts +3 -3
- package/models/components/jarmscan.d.ts.map +1 -1
- package/models/components/jarmscan.js +2 -1
- package/models/components/jarmscan.js.map +1 -1
- package/models/components/kev.d.ts +3 -3
- package/models/components/kev.d.ts.map +1 -1
- package/models/components/kev.js +2 -2
- package/models/components/kev.js.map +1 -1
- package/models/components/label.d.ts +4 -3
- package/models/components/label.d.ts.map +1 -1
- package/models/components/label.js +3 -2
- package/models/components/label.js.map +1 -1
- package/models/components/matchedservice.d.ts +3 -3
- package/models/components/matchedservice.d.ts.map +1 -1
- package/models/components/matchedservice.js +2 -1
- package/models/components/matchedservice.js.map +1 -1
- package/models/components/networklog.d.ts +18 -0
- package/models/components/networklog.d.ts.map +1 -0
- package/models/components/networklog.js +58 -0
- package/models/components/networklog.js.map +1 -0
- package/models/components/networklogresourceinfo.d.ts +49 -0
- package/models/components/networklogresourceinfo.d.ts.map +1 -0
- package/models/components/networklogresourceinfo.js +64 -0
- package/models/components/networklogresourceinfo.js.map +1 -0
- package/models/components/paginationinfo.d.ts +1 -1
- package/models/components/reject.d.ts +3 -3
- package/models/components/reject.d.ts.map +1 -1
- package/models/components/reject.js +2 -2
- package/models/components/reject.js.map +1 -1
- package/models/components/representativeinfo.d.ts +3 -3
- package/models/components/representativeinfo.d.ts.map +1 -1
- package/models/components/representativeinfo.js +2 -1
- package/models/components/representativeinfo.js.map +1 -1
- package/models/components/risk.d.ts +8 -7
- package/models/components/risk.d.ts.map +1 -1
- package/models/components/risk.js +5 -6
- package/models/components/risk.js.map +1 -1
- package/models/components/rootstore.d.ts +3 -3
- package/models/components/rootstore.d.ts.map +1 -1
- package/models/components/rootstore.js +2 -1
- package/models/components/rootstore.js.map +1 -1
- package/models/components/searchconvertqueryresponse.d.ts +3 -3
- package/models/components/searchconvertqueryresponse.d.ts.map +1 -1
- package/models/components/searchconvertqueryresponse.js +2 -1
- package/models/components/searchconvertqueryresponse.js.map +1 -1
- package/models/components/service.d.ts +5 -3
- package/models/components/service.d.ts.map +1 -1
- package/models/components/service.js +4 -1
- package/models/components/service.js.map +1 -1
- package/models/components/serviceid.d.ts +3 -3
- package/models/components/serviceid.d.ts.map +1 -1
- package/models/components/serviceid.js +2 -1
- package/models/components/serviceid.js.map +1 -1
- package/models/components/servicescan.d.ts +5 -3
- package/models/components/servicescan.d.ts.map +1 -1
- package/models/components/servicescan.js +4 -1
- package/models/components/servicescan.js.map +1 -1
- package/models/components/sourceusagebreakdown.d.ts +9 -1
- package/models/components/sourceusagebreakdown.d.ts.map +1 -1
- package/models/components/sourceusagebreakdown.js +7 -0
- package/models/components/sourceusagebreakdown.js.map +1 -1
- package/models/components/threat.d.ts +4 -3
- package/models/components/threat.d.ts.map +1 -1
- package/models/components/threat.js +3 -1
- package/models/components/threat.js.map +1 -1
- package/models/components/tls.d.ts +3 -3
- package/models/components/tls.d.ts.map +1 -1
- package/models/components/tls.js +2 -1
- package/models/components/tls.js.map +1 -1
- package/models/components/tlsversiondata.d.ts +3 -3
- package/models/components/tlsversiondata.d.ts.map +1 -1
- package/models/components/tlsversiondata.js +2 -2
- package/models/components/tlsversiondata.js.map +1 -1
- package/models/components/trackedscantask.d.ts +3 -3
- package/models/components/trackedscantask.d.ts.map +1 -1
- package/models/components/trackedscantask.js +2 -1
- package/models/components/trackedscantask.js.map +1 -1
- package/models/components/vuln.d.ts +8 -7
- package/models/components/vuln.d.ts.map +1 -1
- package/models/components/vuln.js +5 -4
- package/models/components/vuln.js.map +1 -1
- package/models/operations/index.d.ts +1 -0
- package/models/operations/index.d.ts.map +1 -1
- package/models/operations/index.js +1 -0
- package/models/operations/index.js.map +1 -1
- package/models/operations/v3accountmanagementmembercreditsusage.d.ts +33 -3
- package/models/operations/v3accountmanagementmembercreditsusage.d.ts.map +1 -1
- package/models/operations/v3accountmanagementmembercreditsusage.js +17 -2
- package/models/operations/v3accountmanagementmembercreditsusage.js.map +1 -1
- package/models/operations/v3accountmanagementorgcreditsusage.d.ts +38 -3
- package/models/operations/v3accountmanagementorgcreditsusage.d.ts.map +1 -1
- package/models/operations/v3accountmanagementorgcreditsusage.js +20 -2
- package/models/operations/v3accountmanagementorgcreditsusage.js.map +1 -1
- package/models/operations/v3accountmanagementusercreditsusage.d.ts +57 -0
- package/models/operations/v3accountmanagementusercreditsusage.d.ts.map +1 -0
- package/models/operations/v3accountmanagementusercreditsusage.js +85 -0
- package/models/operations/v3accountmanagementusercreditsusage.js.map +1 -0
- package/package.json +1 -1
- package/sdk/accountmanagement.d.ts +13 -6
- package/sdk/accountmanagement.d.ts.map +1 -1
- package/sdk/accountmanagement.js +16 -6
- package/sdk/accountmanagement.js.map +1 -1
- package/sdk/collections.d.ts +6 -6
- package/sdk/collections.js +6 -6
- package/sdk/threathunting.d.ts +1 -1
- package/sdk/threathunting.js +1 -1
- package/src/funcs/accountManagementGetMemberCreditUsage.ts +5 -2
- package/src/funcs/accountManagementGetOrganizationCreditUsage.ts +5 -1
- package/src/funcs/accountManagementGetOrganizationCredits.ts +1 -1
- package/src/funcs/accountManagementGetUserCredits.ts +2 -2
- package/src/funcs/accountManagementGetUserCreditsUsage.ts +190 -0
- package/src/funcs/collectionsCreate.ts +1 -1
- package/src/funcs/collectionsDelete.ts +1 -1
- package/src/funcs/collectionsGet.ts +1 -1
- package/src/funcs/collectionsList.ts +1 -1
- package/src/funcs/collectionsListEvents.ts +1 -1
- package/src/funcs/collectionsUpdate.ts +1 -1
- package/src/funcs/threatHuntingListThreats.ts +1 -1
- package/src/lib/config.ts +4 -4
- package/src/lib/sdks.ts +2 -2
- package/src/models/components/alternativequery.ts +5 -4
- package/src/models/components/attribute.ts +6 -4
- package/src/models/components/certificate.ts +14 -8
- package/src/models/components/certificaterevocationrevocationinfo.ts +5 -4
- package/src/models/components/collection.ts +20 -8
- package/src/models/components/creditexpiration.ts +6 -0
- package/src/models/components/creditusagereport.ts +70 -11
- package/src/models/components/creditusagereportperiod.ts +69 -0
- package/src/models/components/cvsscomponents.ts +47 -30
- package/src/models/components/cvssv4components.ts +83 -53
- package/src/models/components/dns.ts +11 -8
- package/src/models/components/dnsresourcerecord.ts +8 -5
- package/src/models/components/endpointscan.ts +8 -5
- package/src/models/components/endpointscanstate.ts +14 -5
- package/src/models/components/eventassetchange.ts +8 -4
- package/src/models/components/eventstatuschange.ts +14 -7
- package/src/models/components/extractedendpointdata.ts +62 -0
- package/src/models/components/extractedendpointdataanalyticsservice.ts +34 -0
- package/src/models/components/extractedendpointdatacopyright.ts +43 -0
- package/src/models/components/hajime.ts +33 -0
- package/src/models/components/hostdnsforwardresolution.ts +8 -4
- package/src/models/components/http.ts +15 -0
- package/src/models/components/httpredirectchainlink.ts +65 -0
- package/src/models/components/index.ts +8 -0
- package/src/models/components/jarmscan.ts +8 -5
- package/src/models/components/kev.ts +8 -4
- package/src/models/components/label.ts +9 -4
- package/src/models/components/matchedservice.ts +8 -5
- package/src/models/components/networklog.ts +49 -0
- package/src/models/components/networklogresourceinfo.ts +84 -0
- package/src/models/components/paginationinfo.ts +1 -1
- package/src/models/components/reject.ts +8 -4
- package/src/models/components/representativeinfo.ts +8 -5
- package/src/models/components/risk.ts +21 -10
- package/src/models/components/rootstore.ts +5 -5
- package/src/models/components/searchconvertqueryresponse.ts +8 -5
- package/src/models/components/service.ts +11 -5
- package/src/models/components/serviceid.ts +8 -5
- package/src/models/components/servicescan.ts +11 -5
- package/src/models/components/sourceusagebreakdown.ts +16 -1
- package/src/models/components/threat.ts +9 -4
- package/src/models/components/tls.ts +8 -5
- package/src/models/components/tlsversiondata.ts +5 -4
- package/src/models/components/trackedscantask.ts +8 -5
- package/src/models/components/vuln.ts +21 -11
- package/src/models/operations/index.ts +1 -0
- package/src/models/operations/v3accountmanagementmembercreditsusage.ts +43 -4
- package/src/models/operations/v3accountmanagementorgcreditsusage.ts +49 -4
- package/src/models/operations/v3accountmanagementusercreditsusage.ts +128 -0
- package/src/sdk/accountmanagement.ts +24 -6
- package/src/sdk/collections.ts +6 -6
- package/src/sdk/threathunting.ts +1 -1
package/README.md
CHANGED
|
@@ -114,14 +114,15 @@ run();
|
|
|
114
114
|
### [AccountManagement](docs/sdks/accountmanagement/README.md)
|
|
115
115
|
|
|
116
116
|
* [getOrganizationDetails](docs/sdks/accountmanagement/README.md#getorganizationdetails) - Get organization details
|
|
117
|
-
* [getOrganizationCredits](docs/sdks/accountmanagement/README.md#getorganizationcredits) - Get organization credit
|
|
117
|
+
* [getOrganizationCredits](docs/sdks/accountmanagement/README.md#getorganizationcredits) - Get organization credit balance
|
|
118
118
|
* [getOrganizationCreditUsage](docs/sdks/accountmanagement/README.md#getorganizationcreditusage) - Get organization credit usage
|
|
119
119
|
* [inviteUserToOrganization](docs/sdks/accountmanagement/README.md#inviteusertoorganization) - Invite user to organization
|
|
120
120
|
* [listOrganizationMembers](docs/sdks/accountmanagement/README.md#listorganizationmembers) - List organization members
|
|
121
121
|
* [removeOrganizationMember](docs/sdks/accountmanagement/README.md#removeorganizationmember) - Remove member from organization
|
|
122
122
|
* [updateOrganizationMember](docs/sdks/accountmanagement/README.md#updateorganizationmember) - Update a member's roles in an organization
|
|
123
|
-
* [getMemberCreditUsage](docs/sdks/accountmanagement/README.md#getmembercreditusage) - Get member credit usage
|
|
124
|
-
* [getUserCredits](docs/sdks/accountmanagement/README.md#getusercredits) - Get Free user credit
|
|
123
|
+
* [getMemberCreditUsage](docs/sdks/accountmanagement/README.md#getmembercreditusage) - Get organization member credit usage
|
|
124
|
+
* [getUserCredits](docs/sdks/accountmanagement/README.md#getusercredits) - Get Free user credit balance
|
|
125
|
+
* [getUserCreditsUsage](docs/sdks/accountmanagement/README.md#getusercreditsusage) - Get Free user credit usage
|
|
125
126
|
|
|
126
127
|
### [Collections](docs/sdks/collections/README.md)
|
|
127
128
|
|
|
@@ -177,11 +178,12 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
|
|
177
178
|
|
|
178
179
|
<summary>Available standalone functions</summary>
|
|
179
180
|
|
|
180
|
-
- [`accountManagementGetMemberCreditUsage`](docs/sdks/accountmanagement/README.md#getmembercreditusage) - Get member credit usage
|
|
181
|
-
- [`accountManagementGetOrganizationCredits`](docs/sdks/accountmanagement/README.md#getorganizationcredits) - Get organization credit
|
|
181
|
+
- [`accountManagementGetMemberCreditUsage`](docs/sdks/accountmanagement/README.md#getmembercreditusage) - Get organization member credit usage
|
|
182
|
+
- [`accountManagementGetOrganizationCredits`](docs/sdks/accountmanagement/README.md#getorganizationcredits) - Get organization credit balance
|
|
182
183
|
- [`accountManagementGetOrganizationCreditUsage`](docs/sdks/accountmanagement/README.md#getorganizationcreditusage) - Get organization credit usage
|
|
183
184
|
- [`accountManagementGetOrganizationDetails`](docs/sdks/accountmanagement/README.md#getorganizationdetails) - Get organization details
|
|
184
|
-
- [`accountManagementGetUserCredits`](docs/sdks/accountmanagement/README.md#getusercredits) - Get Free user credit
|
|
185
|
+
- [`accountManagementGetUserCredits`](docs/sdks/accountmanagement/README.md#getusercredits) - Get Free user credit balance
|
|
186
|
+
- [`accountManagementGetUserCreditsUsage`](docs/sdks/accountmanagement/README.md#getusercreditsusage) - Get Free user credit usage
|
|
185
187
|
- [`accountManagementInviteUserToOrganization`](docs/sdks/accountmanagement/README.md#inviteusertoorganization) - Invite user to organization
|
|
186
188
|
- [`accountManagementListOrganizationMembers`](docs/sdks/accountmanagement/README.md#listorganizationmembers) - List organization members
|
|
187
189
|
- [`accountManagementRemoveOrganizationMember`](docs/sdks/accountmanagement/README.md#removeorganizationmember) - Remove member from organization
|
|
@@ -7,14 +7,15 @@ Endpoints related to the Account Management product
|
|
|
7
7
|
### Available Operations
|
|
8
8
|
|
|
9
9
|
* [getOrganizationDetails](#getorganizationdetails) - Get organization details
|
|
10
|
-
* [getOrganizationCredits](#getorganizationcredits) - Get organization credit
|
|
10
|
+
* [getOrganizationCredits](#getorganizationcredits) - Get organization credit balance
|
|
11
11
|
* [getOrganizationCreditUsage](#getorganizationcreditusage) - Get organization credit usage
|
|
12
12
|
* [inviteUserToOrganization](#inviteusertoorganization) - Invite user to organization
|
|
13
13
|
* [listOrganizationMembers](#listorganizationmembers) - List organization members
|
|
14
14
|
* [removeOrganizationMember](#removeorganizationmember) - Remove member from organization
|
|
15
15
|
* [updateOrganizationMember](#updateorganizationmember) - Update a member's roles in an organization
|
|
16
|
-
* [getMemberCreditUsage](#getmembercreditusage) - Get member credit usage
|
|
17
|
-
* [getUserCredits](#getusercredits) - Get Free user credit
|
|
16
|
+
* [getMemberCreditUsage](#getmembercreditusage) - Get organization member credit usage
|
|
17
|
+
* [getUserCredits](#getusercredits) - Get Free user credit balance
|
|
18
|
+
* [getUserCreditsUsage](#getusercreditsusage) - Get Free user credit usage
|
|
18
19
|
|
|
19
20
|
## getOrganizationDetails
|
|
20
21
|
|
|
@@ -168,13 +169,14 @@ run();
|
|
|
168
169
|
|
|
169
170
|
## getOrganizationCreditUsage
|
|
170
171
|
|
|
171
|
-
Retrieve credit
|
|
172
|
+
Retrieve credit information for an organization over a specific date range. You must include a start date in your request.<br><br>Admins can obtain credit usage information for all users in their organization. Members may only retrieve usage information for their own account.<br><br>This endpoint does not cost any credits to execute.
|
|
172
173
|
|
|
173
174
|
### Example Usage
|
|
174
175
|
|
|
175
176
|
<!-- UsageSnippet language="typescript" operationID="v3-accountmanagement-org-credits-usage" method="get" path="/v3/accounts/organizations/{organization_id}/credits/usage" -->
|
|
176
177
|
```typescript
|
|
177
178
|
import { SDK } from "@censys/platform-sdk";
|
|
179
|
+
import { RFCDate } from "@censys/platform-sdk/types";
|
|
178
180
|
|
|
179
181
|
const sdk = new SDK({
|
|
180
182
|
personalAccessToken: "<YOUR_BEARER_TOKEN_HERE>",
|
|
@@ -184,6 +186,8 @@ async function run() {
|
|
|
184
186
|
const result = await sdk.accountManagement.getOrganizationCreditUsage({
|
|
185
187
|
organizationId: "11111111-2222-3333-4444-555555555555",
|
|
186
188
|
date: "2025-11-01",
|
|
189
|
+
startDate: new RFCDate("2025-11-01"),
|
|
190
|
+
endDate: new RFCDate("2025-12-01"),
|
|
187
191
|
});
|
|
188
192
|
|
|
189
193
|
console.log(result);
|
|
@@ -199,6 +203,7 @@ The standalone function version of this method:
|
|
|
199
203
|
```typescript
|
|
200
204
|
import { SDKCore } from "@censys/platform-sdk/core.js";
|
|
201
205
|
import { accountManagementGetOrganizationCreditUsage } from "@censys/platform-sdk/funcs/accountManagementGetOrganizationCreditUsage.js";
|
|
206
|
+
import { RFCDate } from "@censys/platform-sdk/types";
|
|
202
207
|
|
|
203
208
|
// Use `SDKCore` for best tree-shaking performance.
|
|
204
209
|
// You can create one instance of it to use across an application.
|
|
@@ -210,6 +215,8 @@ async function run() {
|
|
|
210
215
|
const res = await accountManagementGetOrganizationCreditUsage(sdk, {
|
|
211
216
|
organizationId: "11111111-2222-3333-4444-555555555555",
|
|
212
217
|
date: "2025-11-01",
|
|
218
|
+
startDate: new RFCDate("2025-11-01"),
|
|
219
|
+
endDate: new RFCDate("2025-12-01"),
|
|
213
220
|
});
|
|
214
221
|
if (res.ok) {
|
|
215
222
|
const { value: result } = res;
|
|
@@ -561,13 +568,14 @@ run();
|
|
|
561
568
|
|
|
562
569
|
## getMemberCreditUsage
|
|
563
570
|
|
|
564
|
-
Retrieve credit consumption information for an organization member
|
|
571
|
+
Retrieve credit consumption information for an organization member over a specific date range. You must include a start date in your request.<br><br>This endpoint does not cost any credits to execute.
|
|
565
572
|
|
|
566
573
|
### Example Usage
|
|
567
574
|
|
|
568
575
|
<!-- UsageSnippet language="typescript" operationID="v3-accountmanagement-member-credits-usage" method="get" path="/v3/accounts/organizations/{organization_id}/members/{user_id}/credits/usage" -->
|
|
569
576
|
```typescript
|
|
570
577
|
import { SDK } from "@censys/platform-sdk";
|
|
578
|
+
import { RFCDate } from "@censys/platform-sdk/types";
|
|
571
579
|
|
|
572
580
|
const sdk = new SDK({
|
|
573
581
|
personalAccessToken: "<YOUR_BEARER_TOKEN_HERE>",
|
|
@@ -578,6 +586,8 @@ async function run() {
|
|
|
578
586
|
organizationId: "11111111-2222-3333-4444-555555555555",
|
|
579
587
|
userId: "11111111-2222-3333-4444-555555555555",
|
|
580
588
|
date: "2025-11-01",
|
|
589
|
+
startDate: new RFCDate("2025-11-01"),
|
|
590
|
+
endDate: new RFCDate("2025-12-01"),
|
|
581
591
|
});
|
|
582
592
|
|
|
583
593
|
console.log(result);
|
|
@@ -593,6 +603,7 @@ The standalone function version of this method:
|
|
|
593
603
|
```typescript
|
|
594
604
|
import { SDKCore } from "@censys/platform-sdk/core.js";
|
|
595
605
|
import { accountManagementGetMemberCreditUsage } from "@censys/platform-sdk/funcs/accountManagementGetMemberCreditUsage.js";
|
|
606
|
+
import { RFCDate } from "@censys/platform-sdk/types";
|
|
596
607
|
|
|
597
608
|
// Use `SDKCore` for best tree-shaking performance.
|
|
598
609
|
// You can create one instance of it to use across an application.
|
|
@@ -605,6 +616,8 @@ async function run() {
|
|
|
605
616
|
organizationId: "11111111-2222-3333-4444-555555555555",
|
|
606
617
|
userId: "11111111-2222-3333-4444-555555555555",
|
|
607
618
|
date: "2025-11-01",
|
|
619
|
+
startDate: new RFCDate("2025-11-01"),
|
|
620
|
+
endDate: new RFCDate("2025-12-01"),
|
|
608
621
|
});
|
|
609
622
|
if (res.ok) {
|
|
610
623
|
const { value: result } = res;
|
|
@@ -640,7 +653,7 @@ run();
|
|
|
640
653
|
|
|
641
654
|
## getUserCredits
|
|
642
655
|
|
|
643
|
-
Retrieve your Free user account credit balance and refresh information. To retrieve the credit balance for a Starter or Enterprise account, use the [get organization credit
|
|
656
|
+
Retrieve your Free user account credit balance and refresh information. To retrieve the credit balance for a Starter or Enterprise account, use the [get organization credit balance endpoint](https://docs.censys.com/reference/v3-accountmanagement-org-credits).<br><br>This endpoint does not cost any credits to execute.
|
|
644
657
|
|
|
645
658
|
### Example Usage
|
|
646
659
|
|
|
@@ -702,6 +715,87 @@ run();
|
|
|
702
715
|
|
|
703
716
|
### Errors
|
|
704
717
|
|
|
718
|
+
| Error Type | Status Code | Content Type |
|
|
719
|
+
| -------------------------- | -------------------------- | -------------------------- |
|
|
720
|
+
| errors.AuthenticationError | 401 | application/json |
|
|
721
|
+
| errors.ErrorModel | 404 | application/problem+json |
|
|
722
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
723
|
+
|
|
724
|
+
## getUserCreditsUsage
|
|
725
|
+
|
|
726
|
+
Retrieve your Free user account credit consumption information over a specific date range. You must include a start date in your request.<br><br>This endpoint does not cost any credits to execute.
|
|
727
|
+
|
|
728
|
+
### Example Usage
|
|
729
|
+
|
|
730
|
+
<!-- UsageSnippet language="typescript" operationID="v3-accountmanagement-user-credits-usage" method="get" path="/v3/accounts/users/credits/usage" -->
|
|
731
|
+
```typescript
|
|
732
|
+
import { SDK } from "@censys/platform-sdk";
|
|
733
|
+
import { RFCDate } from "@censys/platform-sdk/types";
|
|
734
|
+
|
|
735
|
+
const sdk = new SDK({
|
|
736
|
+
personalAccessToken: "<YOUR_BEARER_TOKEN_HERE>",
|
|
737
|
+
});
|
|
738
|
+
|
|
739
|
+
async function run() {
|
|
740
|
+
const result = await sdk.accountManagement.getUserCreditsUsage({
|
|
741
|
+
date: "2025-11-01",
|
|
742
|
+
startDate: new RFCDate("2025-11-01"),
|
|
743
|
+
endDate: new RFCDate("2025-12-01"),
|
|
744
|
+
});
|
|
745
|
+
|
|
746
|
+
console.log(result);
|
|
747
|
+
}
|
|
748
|
+
|
|
749
|
+
run();
|
|
750
|
+
```
|
|
751
|
+
|
|
752
|
+
### Standalone function
|
|
753
|
+
|
|
754
|
+
The standalone function version of this method:
|
|
755
|
+
|
|
756
|
+
```typescript
|
|
757
|
+
import { SDKCore } from "@censys/platform-sdk/core.js";
|
|
758
|
+
import { accountManagementGetUserCreditsUsage } from "@censys/platform-sdk/funcs/accountManagementGetUserCreditsUsage.js";
|
|
759
|
+
import { RFCDate } from "@censys/platform-sdk/types";
|
|
760
|
+
|
|
761
|
+
// Use `SDKCore` for best tree-shaking performance.
|
|
762
|
+
// You can create one instance of it to use across an application.
|
|
763
|
+
const sdk = new SDKCore({
|
|
764
|
+
personalAccessToken: "<YOUR_BEARER_TOKEN_HERE>",
|
|
765
|
+
});
|
|
766
|
+
|
|
767
|
+
async function run() {
|
|
768
|
+
const res = await accountManagementGetUserCreditsUsage(sdk, {
|
|
769
|
+
date: "2025-11-01",
|
|
770
|
+
startDate: new RFCDate("2025-11-01"),
|
|
771
|
+
endDate: new RFCDate("2025-12-01"),
|
|
772
|
+
});
|
|
773
|
+
if (res.ok) {
|
|
774
|
+
const { value: result } = res;
|
|
775
|
+
console.log(result);
|
|
776
|
+
} else {
|
|
777
|
+
console.log("accountManagementGetUserCreditsUsage failed:", res.error);
|
|
778
|
+
}
|
|
779
|
+
}
|
|
780
|
+
|
|
781
|
+
run();
|
|
782
|
+
```
|
|
783
|
+
|
|
784
|
+
### Parameters
|
|
785
|
+
|
|
786
|
+
| Parameter | Type | Required | Description |
|
|
787
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
788
|
+
| `request` | [operations.V3AccountmanagementUserCreditsUsageRequest](../../models/operations/v3accountmanagementusercreditsusagerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
789
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
790
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
791
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
792
|
+
|
|
793
|
+
### Response
|
|
794
|
+
|
|
795
|
+
**Promise\<[operations.V3AccountmanagementUserCreditsUsageResponse](../../models/operations/v3accountmanagementusercreditsusageresponse.md)\>**
|
|
796
|
+
|
|
797
|
+
### Errors
|
|
798
|
+
|
|
705
799
|
| Error Type | Status Code | Content Type |
|
|
706
800
|
| -------------------------- | -------------------------- | -------------------------- |
|
|
707
801
|
| errors.AuthenticationError | 401 | application/json |
|
|
@@ -17,7 +17,7 @@ Endpoints related to the Collections product
|
|
|
17
17
|
|
|
18
18
|
## list
|
|
19
19
|
|
|
20
|
-
List all collections for an organization. Retrieved information includes collection ID, name, query, description, status, and asset count.
|
|
20
|
+
List all collections for an organization. Retrieved information includes collection ID, name, query, description, status, and asset count.<br><br>This endpoint does not cost credits to execute.
|
|
21
21
|
|
|
22
22
|
### Example Usage
|
|
23
23
|
|
|
@@ -96,7 +96,7 @@ run();
|
|
|
96
96
|
|
|
97
97
|
## create
|
|
98
98
|
|
|
99
|
-
Create a new collection.
|
|
99
|
+
Create a new collection.<br><br>This endpoint does not cost credits to execute.
|
|
100
100
|
|
|
101
101
|
### Example Usage
|
|
102
102
|
|
|
@@ -181,7 +181,7 @@ run();
|
|
|
181
181
|
|
|
182
182
|
## delete
|
|
183
183
|
|
|
184
|
-
Delete a collection.
|
|
184
|
+
Delete a collection.<br><br>This endpoint does not cost credits to execute.
|
|
185
185
|
|
|
186
186
|
### Example Usage
|
|
187
187
|
|
|
@@ -258,7 +258,7 @@ run();
|
|
|
258
258
|
|
|
259
259
|
## get
|
|
260
260
|
|
|
261
|
-
Retrieve information about a collection. Retrieved information includes its name, query, description, status, and asset count.
|
|
261
|
+
Retrieve information about a collection. Retrieved information includes its name, query, description, status, and asset count.<br><br>This endpoint does not cost credits to execute.
|
|
262
262
|
|
|
263
263
|
### Example Usage
|
|
264
264
|
|
|
@@ -335,7 +335,7 @@ run();
|
|
|
335
335
|
|
|
336
336
|
## update
|
|
337
337
|
|
|
338
|
-
Update a collection's name, description, and/or query.
|
|
338
|
+
Update a collection's name, description, and/or query.<br><br>This endpoint does not cost credits to execute.
|
|
339
339
|
|
|
340
340
|
### Example Usage
|
|
341
341
|
|
|
@@ -422,7 +422,7 @@ run();
|
|
|
422
422
|
|
|
423
423
|
## listEvents
|
|
424
424
|
|
|
425
|
-
Retrieve the event history for a collection. This includes the addition or removal of assets as well as collection status changes.
|
|
425
|
+
Retrieve the event history for a collection. This includes the addition or removal of assets as well as collection status changes.<br><br>This endpoint does not cost credits to execute.
|
|
426
426
|
|
|
427
427
|
### Example Usage
|
|
428
428
|
|
|
@@ -269,7 +269,7 @@ run();
|
|
|
269
269
|
|
|
270
270
|
## listThreats
|
|
271
271
|
|
|
272
|
-
Retrieve a list of active threats observed by Censys by aggregating threat IDs across hosts and web properties. Threats are active if their fingerprint has been identified on hosts or web properties by Censys scans. This information is also available on the [Explore Threats page in the Platform web UI](https://platform.censys.io/threats).
|
|
272
|
+
Retrieve a list of active threats observed by Censys by aggregating threat IDs across hosts and web properties. Threats are active if their fingerprint has been identified on hosts or web properties by Censys scans. This information is also available on the [Explore Threats page in the Platform web UI](https://platform.censys.io/threats).<br><br>This endpoint is available to organizations that have access to the Threat Hunting module.
|
|
273
273
|
|
|
274
274
|
### Example Usage
|
|
275
275
|
|
|
@@ -9,10 +9,10 @@ import * as operations from "../models/operations/index.js";
|
|
|
9
9
|
import { APIPromise } from "../types/async.js";
|
|
10
10
|
import { Result } from "../types/fp.js";
|
|
11
11
|
/**
|
|
12
|
-
* Get member credit usage
|
|
12
|
+
* Get organization member credit usage
|
|
13
13
|
*
|
|
14
14
|
* @remarks
|
|
15
|
-
* Retrieve credit consumption information for an organization member
|
|
15
|
+
* Retrieve credit consumption information for an organization member over a specific date range. You must include a start date in your request.<br><br>This endpoint does not cost any credits to execute.
|
|
16
16
|
*/
|
|
17
17
|
export declare function accountManagementGetMemberCreditUsage(client: SDKCore, request: operations.V3AccountmanagementMemberCreditsUsageRequest, options?: RequestOptions): APIPromise<Result<operations.V3AccountmanagementMemberCreditsUsageResponse, errors.AuthenticationError | errors.ErrorModel | SDKBaseError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
|
|
18
18
|
//# sourceMappingURL=accountManagementGetMemberCreditUsage.d.ts.map
|
|
@@ -47,10 +47,10 @@ const errors = __importStar(require("../models/errors/index.js"));
|
|
|
47
47
|
const operations = __importStar(require("../models/operations/index.js"));
|
|
48
48
|
const async_js_1 = require("../types/async.js");
|
|
49
49
|
/**
|
|
50
|
-
* Get member credit usage
|
|
50
|
+
* Get organization member credit usage
|
|
51
51
|
*
|
|
52
52
|
* @remarks
|
|
53
|
-
* Retrieve credit consumption information for an organization member
|
|
53
|
+
* Retrieve credit consumption information for an organization member over a specific date range. You must include a start date in your request.<br><br>This endpoint does not cost any credits to execute.
|
|
54
54
|
*/
|
|
55
55
|
function accountManagementGetMemberCreditUsage(client, request, options) {
|
|
56
56
|
return new async_js_1.APIPromise($do(client, request, options));
|
|
@@ -76,6 +76,9 @@ async function $do(client, request, options) {
|
|
|
76
76
|
const path = (0, url_js_1.pathToFunc)("/v3/accounts/organizations/{organization_id}/members/{user_id}/credits/usage")(pathParams);
|
|
77
77
|
const query = (0, encodings_js_1.encodeFormQuery)({
|
|
78
78
|
"date": payload.date,
|
|
79
|
+
"end_date": payload.end_date,
|
|
80
|
+
"granularity": payload.granularity,
|
|
81
|
+
"start_date": payload.start_date,
|
|
79
82
|
}, { explode: false });
|
|
80
83
|
const headers = new Headers((0, primitives_js_1.compactMap)({
|
|
81
84
|
Accept: "application/json",
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"accountManagementGetMemberCreditUsage.js","sourceRoot":"","sources":["../src/funcs/accountManagementGetMemberCreditUsage.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+BH,sFAwBC;AApDD,sDAAoE;AACpE,sDAAwC;AACxC,wDAAkD;AAClD,kDAA8C;AAE9C,oDAA4E;AAC5E,0CAA2C;AAQ3C,kEAAoD;AAIpD,0EAA4D;AAC5D,gDAAwD;AAGxD;;;;;GAKG;AACH,SAAgB,qCAAqC,CACnD,MAAe,EACf,OAAgE,EAChE,OAAwB;IAgBxB,OAAO,IAAI,qBAAU,CAAC,GAAG,CACvB,MAAM,EACN,OAAO,EACP,OAAO,CACR,CAAC,CAAC;AACL,CAAC;AAED,KAAK,UAAU,GAAG,CAChB,MAAe,EACf,OAAgE,EAChE,OAAwB;IAmBxB,MAAM,MAAM,GAAG,IAAA,sBAAS,EACtB,OAAO,EACP,CAAC,KAAK,EAAE,EAAE,CACR,UAAU,CAAC,2DAA2D;SACnE,KAAK,CAAC,KAAK,CAAC,EACjB,yBAAyB,CAC1B,CAAC;IACF,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;QACf,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;IACzC,CAAC;IACD,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC;IAC7B,MAAM,IAAI,GAAG,IAAI,CAAC;IAElB,MAAM,UAAU,GAAG;QACjB,eAAe,EAAE,IAAA,2BAAY,EAAC,iBAAiB,EAAE,OAAO,CAAC,eAAe,EAAE;YACxE,OAAO,EAAE,KAAK;YACd,YAAY,EAAE,SAAS;SACxB,CAAC;QACF,OAAO,EAAE,IAAA,2BAAY,EAAC,SAAS,EAAE,OAAO,CAAC,OAAO,EAAE;YAChD,OAAO,EAAE,KAAK;YACd,YAAY,EAAE,SAAS;SACxB,CAAC;KACH,CAAC;IAEF,MAAM,IAAI,GAAG,IAAA,mBAAU,EACrB,8EAA8E,CAC/E,CAAC,UAAU,CAAC,CAAC;IAEd,MAAM,KAAK,GAAG,IAAA,8BAAe,EAAC;QAC5B,MAAM,EAAE,OAAO,CAAC,IAAI;
|
|
1
|
+
{"version":3,"file":"accountManagementGetMemberCreditUsage.js","sourceRoot":"","sources":["../src/funcs/accountManagementGetMemberCreditUsage.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+BH,sFAwBC;AApDD,sDAAoE;AACpE,sDAAwC;AACxC,wDAAkD;AAClD,kDAA8C;AAE9C,oDAA4E;AAC5E,0CAA2C;AAQ3C,kEAAoD;AAIpD,0EAA4D;AAC5D,gDAAwD;AAGxD;;;;;GAKG;AACH,SAAgB,qCAAqC,CACnD,MAAe,EACf,OAAgE,EAChE,OAAwB;IAgBxB,OAAO,IAAI,qBAAU,CAAC,GAAG,CACvB,MAAM,EACN,OAAO,EACP,OAAO,CACR,CAAC,CAAC;AACL,CAAC;AAED,KAAK,UAAU,GAAG,CAChB,MAAe,EACf,OAAgE,EAChE,OAAwB;IAmBxB,MAAM,MAAM,GAAG,IAAA,sBAAS,EACtB,OAAO,EACP,CAAC,KAAK,EAAE,EAAE,CACR,UAAU,CAAC,2DAA2D;SACnE,KAAK,CAAC,KAAK,CAAC,EACjB,yBAAyB,CAC1B,CAAC;IACF,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;QACf,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;IACzC,CAAC;IACD,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC;IAC7B,MAAM,IAAI,GAAG,IAAI,CAAC;IAElB,MAAM,UAAU,GAAG;QACjB,eAAe,EAAE,IAAA,2BAAY,EAAC,iBAAiB,EAAE,OAAO,CAAC,eAAe,EAAE;YACxE,OAAO,EAAE,KAAK;YACd,YAAY,EAAE,SAAS;SACxB,CAAC;QACF,OAAO,EAAE,IAAA,2BAAY,EAAC,SAAS,EAAE,OAAO,CAAC,OAAO,EAAE;YAChD,OAAO,EAAE,KAAK;YACd,YAAY,EAAE,SAAS;SACxB,CAAC;KACH,CAAC;IAEF,MAAM,IAAI,GAAG,IAAA,mBAAU,EACrB,8EAA8E,CAC/E,CAAC,UAAU,CAAC,CAAC;IAEd,MAAM,KAAK,GAAG,IAAA,8BAAe,EAAC;QAC5B,MAAM,EAAE,OAAO,CAAC,IAAI;QACpB,UAAU,EAAE,OAAO,CAAC,QAAQ;QAC5B,aAAa,EAAE,OAAO,CAAC,WAAW;QAClC,YAAY,EAAE,OAAO,CAAC,UAAU;KACjC,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;IAEvB,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,IAAA,0BAAU,EAAC;QACrC,MAAM,EAAE,kBAAkB;KAC3B,CAAC,CAAC,CAAC;IAEJ,MAAM,SAAS,GAAG,MAAM,IAAA,6BAAe,EAAC,MAAM,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAC;IAC7E,MAAM,aAAa,GAAG,SAAS,IAAI,IAAI;QACrC,CAAC,CAAC,EAAE;QACJ,CAAC,CAAC,EAAE,mBAAmB,EAAE,SAAS,EAAE,CAAC;IACvC,MAAM,eAAe,GAAG,IAAA,mCAAqB,EAAC,aAAa,CAAC,CAAC;IAE7D,MAAM,OAAO,GAAG;QACd,OAAO,EAAE,MAAM,CAAC,QAAQ;QACxB,OAAO,EAAE,OAAO,EAAE,SAAS,IAAI,MAAM,CAAC,QAAQ,IAAI,EAAE;QACpD,WAAW,EAAE,2CAA2C;QACxD,YAAY,EAAE,IAAI;QAElB,gBAAgB,EAAE,eAAe;QAEjC,cAAc,EAAE,MAAM,CAAC,QAAQ,CAAC,mBAAmB;QACnD,WAAW,EAAE,OAAO,EAAE,OAAO;eACxB,MAAM,CAAC,QAAQ,CAAC,WAAW;eAC3B,EAAE,QAAQ,EAAE,MAAM,EAAE;QACzB,UAAU,EAAE,OAAO,EAAE,UAAU,IAAI,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC;KACvE,CAAC;IAEF,MAAM,UAAU,GAAG,MAAM,CAAC,cAAc,CAAC,OAAO,EAAE;QAChD,QAAQ,EAAE,eAAe;QACzB,MAAM,EAAE,KAAK;QACb,OAAO,EAAE,OAAO,EAAE,SAAS;QAC3B,IAAI,EAAE,IAAI;QACV,OAAO,EAAE,OAAO;QAChB,KAAK,EAAE,KAAK;QACZ,IAAI,EAAE,IAAI;QACV,SAAS,EAAE,MAAM,CAAC,QAAQ,CAAC,SAAS;QACpC,SAAS,EAAE,OAAO,EAAE,SAAS,IAAI,MAAM,CAAC,QAAQ,CAAC,SAAS,IAAI,CAAC,CAAC;KACjE,EAAE,OAAO,CAAC,CAAC;IACZ,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,CAAC;QACnB,OAAO,CAAC,UAAU,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;IAC7C,CAAC;IACD,MAAM,GAAG,GAAG,UAAU,CAAC,KAAK,CAAC;IAE7B,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE;QACrC,OAAO;QACP,UAAU,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC;QAC7D,WAAW,EAAE,OAAO,CAAC,WAAW;QAChC,UAAU,EAAE,OAAO,CAAC,UAAU;KAC/B,CAAC,CAAC;IACH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;QACjB,OAAO,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,eAAe,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,CAAC;IAC/D,CAAC;IACD,MAAM,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC;IAEhC,MAAM,cAAc,GAAG;QACrB,QAAQ,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,EAAE;KAC/C,CAAC;IAEF,MAAM,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,KAAK,CAa5B,CAAC,CAAC,IAAI,CACJ,GAAG,EACH,UAAU,CAAC,2DAA2D,EACtE,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,QAAQ,EAAE,CAC9B,EACD,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,iCAAiC,CAAC,EACxD,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,MAAM,CAAC,wBAAwB,EAAE;QAC/D,KAAK,EAAE,0BAA0B;KAClC,CAAC,EACF,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,EACb,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CACd,CAAC,QAAQ,EAAE,GAAG,EAAE,EAAE,WAAW,EAAE,cAAc,EAAE,CAAC,CAAC;IAClD,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;QACf,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,CAAC,CAAC;IAClE,CAAC;IAED,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,CAAC,CAAC;AAClE,CAAC"}
|
|
@@ -12,7 +12,7 @@ import { Result } from "../types/fp.js";
|
|
|
12
12
|
* Get organization credit usage
|
|
13
13
|
*
|
|
14
14
|
* @remarks
|
|
15
|
-
* Retrieve credit
|
|
15
|
+
* Retrieve credit information for an organization over a specific date range. You must include a start date in your request.<br><br>Admins can obtain credit usage information for all users in their organization. Members may only retrieve usage information for their own account.<br><br>This endpoint does not cost any credits to execute.
|
|
16
16
|
*/
|
|
17
17
|
export declare function accountManagementGetOrganizationCreditUsage(client: SDKCore, request: operations.V3AccountmanagementOrgCreditsUsageRequest, options?: RequestOptions): APIPromise<Result<operations.V3AccountmanagementOrgCreditsUsageResponse, errors.AuthenticationError | errors.ErrorModel | SDKBaseError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
|
|
18
18
|
//# sourceMappingURL=accountManagementGetOrganizationCreditUsage.d.ts.map
|
|
@@ -50,7 +50,7 @@ const async_js_1 = require("../types/async.js");
|
|
|
50
50
|
* Get organization credit usage
|
|
51
51
|
*
|
|
52
52
|
* @remarks
|
|
53
|
-
* Retrieve credit
|
|
53
|
+
* Retrieve credit information for an organization over a specific date range. You must include a start date in your request.<br><br>Admins can obtain credit usage information for all users in their organization. Members may only retrieve usage information for their own account.<br><br>This endpoint does not cost any credits to execute.
|
|
54
54
|
*/
|
|
55
55
|
function accountManagementGetOrganizationCreditUsage(client, request, options) {
|
|
56
56
|
return new async_js_1.APIPromise($do(client, request, options));
|
|
@@ -71,6 +71,10 @@ async function $do(client, request, options) {
|
|
|
71
71
|
const path = (0, url_js_1.pathToFunc)("/v3/accounts/organizations/{organization_id}/credits/usage")(pathParams);
|
|
72
72
|
const query = (0, encodings_js_1.encodeFormQuery)({
|
|
73
73
|
"date": payload.date,
|
|
74
|
+
"end_date": payload.end_date,
|
|
75
|
+
"granularity": payload.granularity,
|
|
76
|
+
"include_consumer_breakdown": payload.include_consumer_breakdown,
|
|
77
|
+
"start_date": payload.start_date,
|
|
74
78
|
}, { explode: false });
|
|
75
79
|
const headers = new Headers((0, primitives_js_1.compactMap)({
|
|
76
80
|
Accept: "application/json",
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"accountManagementGetOrganizationCreditUsage.js","sourceRoot":"","sources":["../src/funcs/accountManagementGetOrganizationCreditUsage.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+BH,kGAwBC;AApDD,sDAAoE;AACpE,sDAAwC;AACxC,wDAAkD;AAClD,kDAA8C;AAE9C,oDAA4E;AAC5E,0CAA2C;AAQ3C,kEAAoD;AAIpD,0EAA4D;AAC5D,gDAAwD;AAGxD;;;;;GAKG;AACH,SAAgB,2CAA2C,CACzD,MAAe,EACf,OAA6D,EAC7D,OAAwB;IAgBxB,OAAO,IAAI,qBAAU,CAAC,GAAG,CACvB,MAAM,EACN,OAAO,EACP,OAAO,CACR,CAAC,CAAC;AACL,CAAC;AAED,KAAK,UAAU,GAAG,CAChB,MAAe,EACf,OAA6D,EAC7D,OAAwB;IAmBxB,MAAM,MAAM,GAAG,IAAA,sBAAS,EACtB,OAAO,EACP,CAAC,KAAK,EAAE,EAAE,CACR,UAAU,CAAC,wDAAwD,CAAC,KAAK,CACvE,KAAK,CACN,EACH,yBAAyB,CAC1B,CAAC;IACF,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;QACf,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;IACzC,CAAC;IACD,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC;IAC7B,MAAM,IAAI,GAAG,IAAI,CAAC;IAElB,MAAM,UAAU,GAAG;QACjB,eAAe,EAAE,IAAA,2BAAY,EAAC,iBAAiB,EAAE,OAAO,CAAC,eAAe,EAAE;YACxE,OAAO,EAAE,KAAK;YACd,YAAY,EAAE,SAAS;SACxB,CAAC;KACH,CAAC;IAEF,MAAM,IAAI,GAAG,IAAA,mBAAU,EACrB,4DAA4D,CAC7D,CAAC,UAAU,CAAC,CAAC;IAEd,MAAM,KAAK,GAAG,IAAA,8BAAe,EAAC;QAC5B,MAAM,EAAE,OAAO,CAAC,IAAI;
|
|
1
|
+
{"version":3,"file":"accountManagementGetOrganizationCreditUsage.js","sourceRoot":"","sources":["../src/funcs/accountManagementGetOrganizationCreditUsage.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+BH,kGAwBC;AApDD,sDAAoE;AACpE,sDAAwC;AACxC,wDAAkD;AAClD,kDAA8C;AAE9C,oDAA4E;AAC5E,0CAA2C;AAQ3C,kEAAoD;AAIpD,0EAA4D;AAC5D,gDAAwD;AAGxD;;;;;GAKG;AACH,SAAgB,2CAA2C,CACzD,MAAe,EACf,OAA6D,EAC7D,OAAwB;IAgBxB,OAAO,IAAI,qBAAU,CAAC,GAAG,CACvB,MAAM,EACN,OAAO,EACP,OAAO,CACR,CAAC,CAAC;AACL,CAAC;AAED,KAAK,UAAU,GAAG,CAChB,MAAe,EACf,OAA6D,EAC7D,OAAwB;IAmBxB,MAAM,MAAM,GAAG,IAAA,sBAAS,EACtB,OAAO,EACP,CAAC,KAAK,EAAE,EAAE,CACR,UAAU,CAAC,wDAAwD,CAAC,KAAK,CACvE,KAAK,CACN,EACH,yBAAyB,CAC1B,CAAC;IACF,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;QACf,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;IACzC,CAAC;IACD,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC;IAC7B,MAAM,IAAI,GAAG,IAAI,CAAC;IAElB,MAAM,UAAU,GAAG;QACjB,eAAe,EAAE,IAAA,2BAAY,EAAC,iBAAiB,EAAE,OAAO,CAAC,eAAe,EAAE;YACxE,OAAO,EAAE,KAAK;YACd,YAAY,EAAE,SAAS;SACxB,CAAC;KACH,CAAC;IAEF,MAAM,IAAI,GAAG,IAAA,mBAAU,EACrB,4DAA4D,CAC7D,CAAC,UAAU,CAAC,CAAC;IAEd,MAAM,KAAK,GAAG,IAAA,8BAAe,EAAC;QAC5B,MAAM,EAAE,OAAO,CAAC,IAAI;QACpB,UAAU,EAAE,OAAO,CAAC,QAAQ;QAC5B,aAAa,EAAE,OAAO,CAAC,WAAW;QAClC,4BAA4B,EAAE,OAAO,CAAC,0BAA0B;QAChE,YAAY,EAAE,OAAO,CAAC,UAAU;KACjC,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;IAEvB,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,IAAA,0BAAU,EAAC;QACrC,MAAM,EAAE,kBAAkB;KAC3B,CAAC,CAAC,CAAC;IAEJ,MAAM,SAAS,GAAG,MAAM,IAAA,6BAAe,EAAC,MAAM,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAC;IAC7E,MAAM,aAAa,GAAG,SAAS,IAAI,IAAI;QACrC,CAAC,CAAC,EAAE;QACJ,CAAC,CAAC,EAAE,mBAAmB,EAAE,SAAS,EAAE,CAAC;IACvC,MAAM,eAAe,GAAG,IAAA,mCAAqB,EAAC,aAAa,CAAC,CAAC;IAE7D,MAAM,OAAO,GAAG;QACd,OAAO,EAAE,MAAM,CAAC,QAAQ;QACxB,OAAO,EAAE,OAAO,EAAE,SAAS,IAAI,MAAM,CAAC,QAAQ,IAAI,EAAE;QACpD,WAAW,EAAE,wCAAwC;QACrD,YAAY,EAAE,IAAI;QAElB,gBAAgB,EAAE,eAAe;QAEjC,cAAc,EAAE,MAAM,CAAC,QAAQ,CAAC,mBAAmB;QACnD,WAAW,EAAE,OAAO,EAAE,OAAO;eACxB,MAAM,CAAC,QAAQ,CAAC,WAAW;eAC3B,EAAE,QAAQ,EAAE,MAAM,EAAE;QACzB,UAAU,EAAE,OAAO,EAAE,UAAU,IAAI,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC;KACvE,CAAC;IAEF,MAAM,UAAU,GAAG,MAAM,CAAC,cAAc,CAAC,OAAO,EAAE;QAChD,QAAQ,EAAE,eAAe;QACzB,MAAM,EAAE,KAAK;QACb,OAAO,EAAE,OAAO,EAAE,SAAS;QAC3B,IAAI,EAAE,IAAI;QACV,OAAO,EAAE,OAAO;QAChB,KAAK,EAAE,KAAK;QACZ,IAAI,EAAE,IAAI;QACV,SAAS,EAAE,MAAM,CAAC,QAAQ,CAAC,SAAS;QACpC,SAAS,EAAE,OAAO,EAAE,SAAS,IAAI,MAAM,CAAC,QAAQ,CAAC,SAAS,IAAI,CAAC,CAAC;KACjE,EAAE,OAAO,CAAC,CAAC;IACZ,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,CAAC;QACnB,OAAO,CAAC,UAAU,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;IAC7C,CAAC;IACD,MAAM,GAAG,GAAG,UAAU,CAAC,KAAK,CAAC;IAE7B,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE;QACrC,OAAO;QACP,UAAU,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC;QAC7D,WAAW,EAAE,OAAO,CAAC,WAAW;QAChC,UAAU,EAAE,OAAO,CAAC,UAAU;KAC/B,CAAC,CAAC;IACH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;QACjB,OAAO,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,eAAe,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,CAAC;IAC/D,CAAC;IACD,MAAM,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC;IAEhC,MAAM,cAAc,GAAG;QACrB,QAAQ,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,EAAE;KAC/C,CAAC;IAEF,MAAM,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,KAAK,CAa5B,CAAC,CAAC,IAAI,CACJ,GAAG,EACH,UAAU,CAAC,wDAAwD,EACnE,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,QAAQ,EAAE,CAC9B,EACD,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,iCAAiC,CAAC,EACxD,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,MAAM,CAAC,wBAAwB,EAAE;QAC/D,KAAK,EAAE,0BAA0B;KAClC,CAAC,EACF,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,EACb,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CACd,CAAC,QAAQ,EAAE,GAAG,EAAE,EAAE,WAAW,EAAE,cAAc,EAAE,CAAC,CAAC;IAClD,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;QACf,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,CAAC,CAAC;IAClE,CAAC;IAED,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,CAAC,CAAC;AAClE,CAAC"}
|
|
@@ -9,7 +9,7 @@ import * as operations from "../models/operations/index.js";
|
|
|
9
9
|
import { APIPromise } from "../types/async.js";
|
|
10
10
|
import { Result } from "../types/fp.js";
|
|
11
11
|
/**
|
|
12
|
-
* Get organization credit
|
|
12
|
+
* Get organization credit balance
|
|
13
13
|
*
|
|
14
14
|
* @remarks
|
|
15
15
|
* Retrieve credit balance and expiration information for an organization. <br><br>Credits expire 12 months after they are acquired.<br><br>This endpoint does not cost any credits to execute.
|
|
@@ -47,7 +47,7 @@ const errors = __importStar(require("../models/errors/index.js"));
|
|
|
47
47
|
const operations = __importStar(require("../models/operations/index.js"));
|
|
48
48
|
const async_js_1 = require("../types/async.js");
|
|
49
49
|
/**
|
|
50
|
-
* Get organization credit
|
|
50
|
+
* Get organization credit balance
|
|
51
51
|
*
|
|
52
52
|
* @remarks
|
|
53
53
|
* Retrieve credit balance and expiration information for an organization. <br><br>Credits expire 12 months after they are acquired.<br><br>This endpoint does not cost any credits to execute.
|
|
@@ -9,10 +9,10 @@ import * as operations from "../models/operations/index.js";
|
|
|
9
9
|
import { APIPromise } from "../types/async.js";
|
|
10
10
|
import { Result } from "../types/fp.js";
|
|
11
11
|
/**
|
|
12
|
-
* Get Free user credit
|
|
12
|
+
* Get Free user credit balance
|
|
13
13
|
*
|
|
14
14
|
* @remarks
|
|
15
|
-
* Retrieve your Free user account credit balance and refresh information. To retrieve the credit balance for a Starter or Enterprise account, use the [get organization credit
|
|
15
|
+
* Retrieve your Free user account credit balance and refresh information. To retrieve the credit balance for a Starter or Enterprise account, use the [get organization credit balance endpoint](https://docs.censys.com/reference/v3-accountmanagement-org-credits).<br><br>This endpoint does not cost any credits to execute.
|
|
16
16
|
*/
|
|
17
17
|
export declare function accountManagementGetUserCredits(client: SDKCore, options?: RequestOptions): APIPromise<Result<operations.V3AccountmanagementUserCreditsResponse, errors.AuthenticationError | errors.ErrorModel | SDKBaseError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
|
|
18
18
|
//# sourceMappingURL=accountManagementGetUserCredits.d.ts.map
|
|
@@ -45,10 +45,10 @@ const errors = __importStar(require("../models/errors/index.js"));
|
|
|
45
45
|
const operations = __importStar(require("../models/operations/index.js"));
|
|
46
46
|
const async_js_1 = require("../types/async.js");
|
|
47
47
|
/**
|
|
48
|
-
* Get Free user credit
|
|
48
|
+
* Get Free user credit balance
|
|
49
49
|
*
|
|
50
50
|
* @remarks
|
|
51
|
-
* Retrieve your Free user account credit balance and refresh information. To retrieve the credit balance for a Starter or Enterprise account, use the [get organization credit
|
|
51
|
+
* Retrieve your Free user account credit balance and refresh information. To retrieve the credit balance for a Starter or Enterprise account, use the [get organization credit balance endpoint](https://docs.censys.com/reference/v3-accountmanagement-org-credits).<br><br>This endpoint does not cost any credits to execute.
|
|
52
52
|
*/
|
|
53
53
|
function accountManagementGetUserCredits(client, options) {
|
|
54
54
|
return new async_js_1.APIPromise($do(client, options));
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import { SDKCore } from "../core.js";
|
|
2
|
+
import { RequestOptions } from "../lib/sdks.js";
|
|
3
|
+
import { ConnectionError, InvalidRequestError, RequestAbortedError, RequestTimeoutError, UnexpectedClientError } from "../models/errors/httpclienterrors.js";
|
|
4
|
+
import * as errors from "../models/errors/index.js";
|
|
5
|
+
import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
|
|
6
|
+
import { SDKBaseError } from "../models/errors/sdkbaseerror.js";
|
|
7
|
+
import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
|
|
8
|
+
import * as operations from "../models/operations/index.js";
|
|
9
|
+
import { APIPromise } from "../types/async.js";
|
|
10
|
+
import { Result } from "../types/fp.js";
|
|
11
|
+
/**
|
|
12
|
+
* Get Free user credit usage
|
|
13
|
+
*
|
|
14
|
+
* @remarks
|
|
15
|
+
* Retrieve your Free user account credit consumption information over a specific date range. You must include a start date in your request.<br><br>This endpoint does not cost any credits to execute.
|
|
16
|
+
*/
|
|
17
|
+
export declare function accountManagementGetUserCreditsUsage(client: SDKCore, request: operations.V3AccountmanagementUserCreditsUsageRequest, options?: RequestOptions): APIPromise<Result<operations.V3AccountmanagementUserCreditsUsageResponse, errors.AuthenticationError | errors.ErrorModel | SDKBaseError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
|
|
18
|
+
//# sourceMappingURL=accountManagementGetUserCreditsUsage.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"accountManagementGetUserCreditsUsage.d.ts","sourceRoot":"","sources":["../src/funcs/accountManagementGetUserCreditsUsage.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAKrC,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,KAAK,MAAM,MAAM,2BAA2B,CAAC;AACpD,OAAO,EAAE,uBAAuB,EAAE,MAAM,6CAA6C,CAAC;AACtF,OAAO,EAAE,YAAY,EAAE,MAAM,kCAAkC,CAAC;AAChE,OAAO,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AAC5E,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EAAW,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC;;;;;GAKG;AACH,wBAAgB,oCAAoC,CAClD,MAAM,EAAE,OAAO,EACf,OAAO,EAAE,UAAU,CAAC,0CAA0C,EAC9D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CACX,MAAM,CACJ,UAAU,CAAC,2CAA2C,EACpD,MAAM,CAAC,mBAAmB,GAC1B,MAAM,CAAC,UAAU,GACjB,YAAY,GACZ,uBAAuB,GACvB,eAAe,GACf,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,qBAAqB,GACrB,kBAAkB,CACrB,CACF,CAMA"}
|
|
@@ -0,0 +1,129 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/*
|
|
3
|
+
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
|
4
|
+
*/
|
|
5
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
6
|
+
if (k2 === undefined) k2 = k;
|
|
7
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
8
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
9
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
10
|
+
}
|
|
11
|
+
Object.defineProperty(o, k2, desc);
|
|
12
|
+
}) : (function(o, m, k, k2) {
|
|
13
|
+
if (k2 === undefined) k2 = k;
|
|
14
|
+
o[k2] = m[k];
|
|
15
|
+
}));
|
|
16
|
+
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
17
|
+
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
18
|
+
}) : function(o, v) {
|
|
19
|
+
o["default"] = v;
|
|
20
|
+
});
|
|
21
|
+
var __importStar = (this && this.__importStar) || (function () {
|
|
22
|
+
var ownKeys = function(o) {
|
|
23
|
+
ownKeys = Object.getOwnPropertyNames || function (o) {
|
|
24
|
+
var ar = [];
|
|
25
|
+
for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
|
|
26
|
+
return ar;
|
|
27
|
+
};
|
|
28
|
+
return ownKeys(o);
|
|
29
|
+
};
|
|
30
|
+
return function (mod) {
|
|
31
|
+
if (mod && mod.__esModule) return mod;
|
|
32
|
+
var result = {};
|
|
33
|
+
if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
|
|
34
|
+
__setModuleDefault(result, mod);
|
|
35
|
+
return result;
|
|
36
|
+
};
|
|
37
|
+
})();
|
|
38
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
39
|
+
exports.accountManagementGetUserCreditsUsage = accountManagementGetUserCreditsUsage;
|
|
40
|
+
const encodings_js_1 = require("../lib/encodings.js");
|
|
41
|
+
const M = __importStar(require("../lib/matchers.js"));
|
|
42
|
+
const primitives_js_1 = require("../lib/primitives.js");
|
|
43
|
+
const schemas_js_1 = require("../lib/schemas.js");
|
|
44
|
+
const security_js_1 = require("../lib/security.js");
|
|
45
|
+
const url_js_1 = require("../lib/url.js");
|
|
46
|
+
const errors = __importStar(require("../models/errors/index.js"));
|
|
47
|
+
const operations = __importStar(require("../models/operations/index.js"));
|
|
48
|
+
const async_js_1 = require("../types/async.js");
|
|
49
|
+
/**
|
|
50
|
+
* Get Free user credit usage
|
|
51
|
+
*
|
|
52
|
+
* @remarks
|
|
53
|
+
* Retrieve your Free user account credit consumption information over a specific date range. You must include a start date in your request.<br><br>This endpoint does not cost any credits to execute.
|
|
54
|
+
*/
|
|
55
|
+
function accountManagementGetUserCreditsUsage(client, request, options) {
|
|
56
|
+
return new async_js_1.APIPromise($do(client, request, options));
|
|
57
|
+
}
|
|
58
|
+
async function $do(client, request, options) {
|
|
59
|
+
const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.V3AccountmanagementUserCreditsUsageRequest$outboundSchema
|
|
60
|
+
.parse(value), "Input validation failed");
|
|
61
|
+
if (!parsed.ok) {
|
|
62
|
+
return [parsed, { status: "invalid" }];
|
|
63
|
+
}
|
|
64
|
+
const payload = parsed.value;
|
|
65
|
+
const body = null;
|
|
66
|
+
const path = (0, url_js_1.pathToFunc)("/v3/accounts/users/credits/usage")();
|
|
67
|
+
const query = (0, encodings_js_1.encodeFormQuery)({
|
|
68
|
+
"date": payload.date,
|
|
69
|
+
"end_date": payload.end_date,
|
|
70
|
+
"granularity": payload.granularity,
|
|
71
|
+
"start_date": payload.start_date,
|
|
72
|
+
}, { explode: false });
|
|
73
|
+
const headers = new Headers((0, primitives_js_1.compactMap)({
|
|
74
|
+
Accept: "application/json",
|
|
75
|
+
}));
|
|
76
|
+
const secConfig = await (0, security_js_1.extractSecurity)(client._options.personalAccessToken);
|
|
77
|
+
const securityInput = secConfig == null
|
|
78
|
+
? {}
|
|
79
|
+
: { personalAccessToken: secConfig };
|
|
80
|
+
const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput);
|
|
81
|
+
const context = {
|
|
82
|
+
options: client._options,
|
|
83
|
+
baseURL: options?.serverURL ?? client._baseURL ?? "",
|
|
84
|
+
operationID: "v3-accountmanagement-user-credits-usage",
|
|
85
|
+
oAuth2Scopes: null,
|
|
86
|
+
resolvedSecurity: requestSecurity,
|
|
87
|
+
securitySource: client._options.personalAccessToken,
|
|
88
|
+
retryConfig: options?.retries
|
|
89
|
+
|| client._options.retryConfig
|
|
90
|
+
|| { strategy: "none" },
|
|
91
|
+
retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
|
|
92
|
+
};
|
|
93
|
+
const requestRes = client._createRequest(context, {
|
|
94
|
+
security: requestSecurity,
|
|
95
|
+
method: "GET",
|
|
96
|
+
baseURL: options?.serverURL,
|
|
97
|
+
path: path,
|
|
98
|
+
headers: headers,
|
|
99
|
+
query: query,
|
|
100
|
+
body: body,
|
|
101
|
+
userAgent: client._options.userAgent,
|
|
102
|
+
timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
|
|
103
|
+
}, options);
|
|
104
|
+
if (!requestRes.ok) {
|
|
105
|
+
return [requestRes, { status: "invalid" }];
|
|
106
|
+
}
|
|
107
|
+
const req = requestRes.value;
|
|
108
|
+
const doResult = await client._do(req, {
|
|
109
|
+
context,
|
|
110
|
+
errorCodes: ["401", "404", "4XX", "5XX"],
|
|
111
|
+
retryConfig: context.retryConfig,
|
|
112
|
+
retryCodes: context.retryCodes,
|
|
113
|
+
});
|
|
114
|
+
if (!doResult.ok) {
|
|
115
|
+
return [doResult, { status: "request-error", request: req }];
|
|
116
|
+
}
|
|
117
|
+
const response = doResult.value;
|
|
118
|
+
const responseFields = {
|
|
119
|
+
HttpMeta: { Response: response, Request: req },
|
|
120
|
+
};
|
|
121
|
+
const [result] = await M.match(M.json(200, operations.V3AccountmanagementUserCreditsUsageResponse$inboundSchema, { hdrs: true, key: "Result" }), M.jsonErr(401, errors.AuthenticationError$inboundSchema), M.jsonErr(404, errors.ErrorModel$inboundSchema, {
|
|
122
|
+
ctype: "application/problem+json",
|
|
123
|
+
}), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields });
|
|
124
|
+
if (!result.ok) {
|
|
125
|
+
return [result, { status: "complete", request: req, response }];
|
|
126
|
+
}
|
|
127
|
+
return [result, { status: "complete", request: req, response }];
|
|
128
|
+
}
|
|
129
|
+
//# sourceMappingURL=accountManagementGetUserCreditsUsage.js.map
|