stigg 0.1.0.pre.beta.60 → 0.1.0.pre.beta.62
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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +26 -0
- data/README.md +1 -1
- data/lib/stigg/client.rb +1 -1
- data/lib/stigg/models/v1/customer_list_response.rb +9 -1
- data/lib/stigg/models/v1/customer_provision_params.rb +9 -1
- data/lib/stigg/models/v1/customer_response.rb +9 -1
- data/lib/stigg/models/v1/customer_update_params.rb +9 -1
- data/lib/stigg/models/v1_beta/entity_type_list_params.rb +20 -1
- data/lib/stigg/models/v1_beta/entity_type_list_response.rb +9 -1
- data/lib/stigg/models/v1_beta/entity_type_upsert_response.rb +9 -1
- data/lib/stigg/resources/v1/customers.rb +6 -2
- data/lib/stigg/resources/v1_beta/customers/entities.rb +6 -2
- data/lib/stigg/resources/v1_beta/entity_types.rb +8 -5
- data/lib/stigg/version.rb +1 -1
- data/rbi/stigg/models/v1/customer_list_response.rbi +8 -0
- data/rbi/stigg/models/v1/customer_provision_params.rbi +8 -0
- data/rbi/stigg/models/v1/customer_response.rbi +8 -0
- data/rbi/stigg/models/v1/customer_update_params.rbi +8 -0
- data/rbi/stigg/models/v1_beta/entity_type_list_params.rbi +59 -0
- data/rbi/stigg/models/v1_beta/entity_type_list_response.rbi +8 -0
- data/rbi/stigg/models/v1_beta/entity_type_upsert_response.rbi +8 -0
- data/rbi/stigg/resources/v1/customers.rbi +6 -0
- data/rbi/stigg/resources/v1_beta/customers/entities.rbi +4 -2
- data/rbi/stigg/resources/v1_beta/entity_types.rbi +7 -2
- data/sig/stigg/models/v1/customer_list_response.rbs +5 -0
- data/sig/stigg/models/v1/customer_provision_params.rbs +5 -0
- data/sig/stigg/models/v1/customer_response.rbs +5 -0
- data/sig/stigg/models/v1/customer_update_params.rbs +5 -0
- data/sig/stigg/models/v1_beta/entity_type_list_params.rbs +20 -0
- data/sig/stigg/models/v1_beta/entity_type_list_response.rbs +5 -0
- data/sig/stigg/models/v1_beta/entity_type_upsert_response.rbs +5 -0
- data/sig/stigg/resources/v1/customers.rbs +2 -0
- data/sig/stigg/resources/v1_beta/entity_types.rbs +1 -0
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 46d996faf77838a7270f65e36183022bf9967e5c097e911a942261ca082cdd9d
|
|
4
|
+
data.tar.gz: bc985e5c0c934cc3ae392435311b76c0eb74bf426f2c2a75a2a09db92bf5df48
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: dc2b51e86b366ba00337400477ec5a5209e27157d041de0472ebdbe334252de062f312f3d9bfc818f87695d734271cc3a4499fe56d629e0d53a57f3c8103a782
|
|
7
|
+
data.tar.gz: dd59b1ae13e0ad4edc6cdf4503e0fc8f8e36f766ffed0dd5434bea4a7af06c66c0cdeb1a5a363ac651d285f23a70240e71ed4e8b73932313742eec858289dfa3
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,31 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [0.1.0-beta.62](https://github.com/stiggio/stigg-ruby/compare/v0.1.0-beta.61...v0.1.0-beta.62) (2026-10-29)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Bug Fixes
|
|
7
|
+
|
|
8
|
+
* sync OpenAPI spec from stigg-api ([e878bee](https://github.com/stiggio/stigg-ruby/commit/e878beec1f2c5495d17e56b44725cf61d97938e6))
|
|
9
|
+
* sync OpenAPI spec from stigg-api ([fec3f5a](https://github.com/stiggio/stigg-ruby/commit/fec3f5a1f1316311fe2d653493f335f21bedd7b4))
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
### Chores
|
|
13
|
+
|
|
14
|
+
* normalize version.rb to gem prerelease format for stlc codegen ([c610c8a](https://github.com/stiggio/stigg-ruby/commit/c610c8a60136a8fb7dc36e3ca47ed172f90f77fe))
|
|
15
|
+
|
|
16
|
+
## [0.1.0-beta.61](https://github.com/stiggio/stigg-ruby/compare/v0.1.0-beta.60...v0.1.0-beta.61) (2026-10-28)
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
### Bug Fixes
|
|
20
|
+
|
|
21
|
+
* **stainless:** restore edge.api.stigg.io as the production server ([d0c44ea](https://github.com/stiggio/stigg-ruby/commit/d0c44eadad52a1f458eee8176aa33e88952e1dd4))
|
|
22
|
+
* sync OpenAPI spec from stigg-api ([847d6bb](https://github.com/stiggio/stigg-ruby/commit/847d6bbc0e8426b1ae9559fbd35ffc712d0d54f6))
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
### Chores
|
|
26
|
+
|
|
27
|
+
* normalize version.rb to gem prerelease format for stlc codegen ([45c00b0](https://github.com/stiggio/stigg-ruby/commit/45c00b079035295798e8b2e7e44e296e1d67dcd4))
|
|
28
|
+
|
|
3
29
|
## [0.1.0-beta.60](https://github.com/stiggio/stigg-ruby/compare/v0.1.0-beta.59...v0.1.0-beta.60) (2026-10-28)
|
|
4
30
|
|
|
5
31
|
|
data/README.md
CHANGED
data/lib/stigg/client.rb
CHANGED
|
@@ -56,7 +56,7 @@ module Stigg
|
|
|
56
56
|
initial_retry_delay: self.class::DEFAULT_INITIAL_RETRY_DELAY,
|
|
57
57
|
max_retry_delay: self.class::DEFAULT_MAX_RETRY_DELAY
|
|
58
58
|
)
|
|
59
|
-
base_url ||= "https://api.stigg.io"
|
|
59
|
+
base_url ||= "https://edge.api.stigg.io"
|
|
60
60
|
|
|
61
61
|
if api_key.nil?
|
|
62
62
|
raise ArgumentError.new("api_key is required, and can be set via environ: \"STIGG_API_KEY\"")
|
|
@@ -103,13 +103,19 @@ module Stigg
|
|
|
103
103
|
# @return [Stigg::Models::V1::CustomerListResponse::Passthrough, nil]
|
|
104
104
|
optional :passthrough, -> { Stigg::Models::V1::CustomerListResponse::Passthrough }
|
|
105
105
|
|
|
106
|
+
# @!attribute salesforce_id
|
|
107
|
+
# The unique identifier for the customer in Salesforce integration
|
|
108
|
+
#
|
|
109
|
+
# @return [String, nil]
|
|
110
|
+
optional :salesforce_id, String, api_name: :salesforceId, nil?: true
|
|
111
|
+
|
|
106
112
|
# @!attribute timezone
|
|
107
113
|
# Timezone to use for this customer
|
|
108
114
|
#
|
|
109
115
|
# @return [String, nil]
|
|
110
116
|
optional :timezone, String, nil?: true
|
|
111
117
|
|
|
112
|
-
# @!method initialize(id:, archived_at:, created_at:, updated_at:, billing_currency: nil, billing_id: nil, coupon_id: nil, default_payment_method: nil, email: nil, integrations: nil, language: nil, metadata: nil, name: nil, passthrough: nil, timezone: nil)
|
|
118
|
+
# @!method initialize(id:, archived_at:, created_at:, updated_at:, billing_currency: nil, billing_id: nil, coupon_id: nil, default_payment_method: nil, email: nil, integrations: nil, language: nil, metadata: nil, name: nil, passthrough: nil, salesforce_id: nil, timezone: nil)
|
|
113
119
|
# Some parameter documentations has been truncated, see
|
|
114
120
|
# {Stigg::Models::V1::CustomerListResponse} for more details.
|
|
115
121
|
#
|
|
@@ -143,6 +149,8 @@ module Stigg
|
|
|
143
149
|
#
|
|
144
150
|
# @param passthrough [Stigg::Models::V1::CustomerListResponse::Passthrough] Vendor-specific billing passthrough fields.
|
|
145
151
|
#
|
|
152
|
+
# @param salesforce_id [String, nil] The unique identifier for the customer in Salesforce integration
|
|
153
|
+
#
|
|
146
154
|
# @param timezone [String, nil] Timezone to use for this customer
|
|
147
155
|
|
|
148
156
|
# The billing currency of the customer
|
|
@@ -88,6 +88,12 @@ module Stigg
|
|
|
88
88
|
# @return [Stigg::Models::V1::CustomerProvisionParams::Passthrough, nil]
|
|
89
89
|
optional :passthrough, -> { Stigg::V1::CustomerProvisionParams::Passthrough }
|
|
90
90
|
|
|
91
|
+
# @!attribute salesforce_id
|
|
92
|
+
# The unique identifier for the customer in Salesforce integration
|
|
93
|
+
#
|
|
94
|
+
# @return [String, nil]
|
|
95
|
+
optional :salesforce_id, String, api_name: :salesforceId, nil?: true
|
|
96
|
+
|
|
91
97
|
# @!attribute timezone
|
|
92
98
|
# Timezone to use for this customer
|
|
93
99
|
#
|
|
@@ -104,7 +110,7 @@ module Stigg
|
|
|
104
110
|
# @return [String, nil]
|
|
105
111
|
optional :x_environment_id, String
|
|
106
112
|
|
|
107
|
-
# @!method initialize(id:, billing_currency: nil, billing_id: nil, coupon_id: nil, default_payment_method: nil, email: nil, integrations: nil, language: nil, metadata: nil, name: nil, passthrough: nil, timezone: nil, x_account_id: nil, x_environment_id: nil, request_options: {})
|
|
113
|
+
# @!method initialize(id:, billing_currency: nil, billing_id: nil, coupon_id: nil, default_payment_method: nil, email: nil, integrations: nil, language: nil, metadata: nil, name: nil, passthrough: nil, salesforce_id: nil, timezone: nil, x_account_id: nil, x_environment_id: nil, request_options: {})
|
|
108
114
|
# Some parameter documentations has been truncated, see
|
|
109
115
|
# {Stigg::Models::V1::CustomerProvisionParams} for more details.
|
|
110
116
|
#
|
|
@@ -130,6 +136,8 @@ module Stigg
|
|
|
130
136
|
#
|
|
131
137
|
# @param passthrough [Stigg::Models::V1::CustomerProvisionParams::Passthrough] Vendor-specific billing passthrough fields.
|
|
132
138
|
#
|
|
139
|
+
# @param salesforce_id [String, nil] The unique identifier for the customer in Salesforce integration
|
|
140
|
+
#
|
|
133
141
|
# @param timezone [String, nil] Timezone to use for this customer
|
|
134
142
|
#
|
|
135
143
|
# @param x_account_id [String]
|
|
@@ -116,13 +116,19 @@ module Stigg
|
|
|
116
116
|
# @return [Stigg::Models::V1::CustomerResponse::Data::Passthrough, nil]
|
|
117
117
|
optional :passthrough, -> { Stigg::V1::CustomerResponse::Data::Passthrough }
|
|
118
118
|
|
|
119
|
+
# @!attribute salesforce_id
|
|
120
|
+
# The unique identifier for the customer in Salesforce integration
|
|
121
|
+
#
|
|
122
|
+
# @return [String, nil]
|
|
123
|
+
optional :salesforce_id, String, api_name: :salesforceId, nil?: true
|
|
124
|
+
|
|
119
125
|
# @!attribute timezone
|
|
120
126
|
# Timezone to use for this customer
|
|
121
127
|
#
|
|
122
128
|
# @return [String, nil]
|
|
123
129
|
optional :timezone, String, nil?: true
|
|
124
130
|
|
|
125
|
-
# @!method initialize(id:, archived_at:, created_at:, updated_at:, billing_currency: nil, billing_id: nil, coupon_id: nil, default_payment_method: nil, email: nil, integrations: nil, language: nil, metadata: nil, name: nil, passthrough: nil, timezone: nil)
|
|
131
|
+
# @!method initialize(id:, archived_at:, created_at:, updated_at:, billing_currency: nil, billing_id: nil, coupon_id: nil, default_payment_method: nil, email: nil, integrations: nil, language: nil, metadata: nil, name: nil, passthrough: nil, salesforce_id: nil, timezone: nil)
|
|
126
132
|
# Some parameter documentations has been truncated, see
|
|
127
133
|
# {Stigg::Models::V1::CustomerResponse::Data} for more details.
|
|
128
134
|
#
|
|
@@ -156,6 +162,8 @@ module Stigg
|
|
|
156
162
|
#
|
|
157
163
|
# @param passthrough [Stigg::Models::V1::CustomerResponse::Data::Passthrough] Vendor-specific billing passthrough fields.
|
|
158
164
|
#
|
|
165
|
+
# @param salesforce_id [String, nil] The unique identifier for the customer in Salesforce integration
|
|
166
|
+
#
|
|
159
167
|
# @param timezone [String, nil] Timezone to use for this customer
|
|
160
168
|
|
|
161
169
|
# The billing currency of the customer
|
|
@@ -78,6 +78,12 @@ module Stigg
|
|
|
78
78
|
# @return [Stigg::Models::V1::CustomerUpdateParams::Passthrough, nil]
|
|
79
79
|
optional :passthrough, -> { Stigg::V1::CustomerUpdateParams::Passthrough }
|
|
80
80
|
|
|
81
|
+
# @!attribute salesforce_id
|
|
82
|
+
# The unique identifier for the customer in Salesforce integration
|
|
83
|
+
#
|
|
84
|
+
# @return [String, nil]
|
|
85
|
+
optional :salesforce_id, String, api_name: :salesforceId, nil?: true
|
|
86
|
+
|
|
81
87
|
# @!attribute timezone
|
|
82
88
|
# Timezone to use for this customer
|
|
83
89
|
#
|
|
@@ -94,7 +100,7 @@ module Stigg
|
|
|
94
100
|
# @return [String, nil]
|
|
95
101
|
optional :x_environment_id, String
|
|
96
102
|
|
|
97
|
-
# @!method initialize(id:, billing_currency: nil, billing_id: nil, coupon_id: nil, email: nil, integrations: nil, language: nil, metadata: nil, name: nil, passthrough: nil, timezone: nil, x_account_id: nil, x_environment_id: nil, request_options: {})
|
|
103
|
+
# @!method initialize(id:, billing_currency: nil, billing_id: nil, coupon_id: nil, email: nil, integrations: nil, language: nil, metadata: nil, name: nil, passthrough: nil, salesforce_id: nil, timezone: nil, x_account_id: nil, x_environment_id: nil, request_options: {})
|
|
98
104
|
# Some parameter documentations has been truncated, see
|
|
99
105
|
# {Stigg::Models::V1::CustomerUpdateParams} for more details.
|
|
100
106
|
#
|
|
@@ -118,6 +124,8 @@ module Stigg
|
|
|
118
124
|
#
|
|
119
125
|
# @param passthrough [Stigg::Models::V1::CustomerUpdateParams::Passthrough] Vendor-specific billing passthrough fields.
|
|
120
126
|
#
|
|
127
|
+
# @param salesforce_id [String, nil] The unique identifier for the customer in Salesforce integration
|
|
128
|
+
#
|
|
121
129
|
# @param timezone [String, nil] Timezone to use for this customer
|
|
122
130
|
#
|
|
123
131
|
# @param x_account_id [String]
|
|
@@ -20,6 +20,12 @@ module Stigg
|
|
|
20
20
|
# @return [String, nil]
|
|
21
21
|
optional :before, String
|
|
22
22
|
|
|
23
|
+
# @!attribute include_archived
|
|
24
|
+
# Whether to include archived entity types. One of: true, false
|
|
25
|
+
#
|
|
26
|
+
# @return [Symbol, Stigg::Models::V1Beta::EntityTypeListParams::IncludeArchived, nil]
|
|
27
|
+
optional :include_archived, enum: -> { Stigg::V1Beta::EntityTypeListParams::IncludeArchived }
|
|
28
|
+
|
|
23
29
|
# @!attribute limit
|
|
24
30
|
# Maximum number of items to return
|
|
25
31
|
#
|
|
@@ -36,11 +42,13 @@ module Stigg
|
|
|
36
42
|
# @return [String, nil]
|
|
37
43
|
optional :x_environment_id, String
|
|
38
44
|
|
|
39
|
-
# @!method initialize(after: nil, before: nil, limit: nil, x_account_id: nil, x_environment_id: nil, request_options: {})
|
|
45
|
+
# @!method initialize(after: nil, before: nil, include_archived: nil, limit: nil, x_account_id: nil, x_environment_id: nil, request_options: {})
|
|
40
46
|
# @param after [String] Return items that come after this cursor
|
|
41
47
|
#
|
|
42
48
|
# @param before [String] Return items that come before this cursor
|
|
43
49
|
#
|
|
50
|
+
# @param include_archived [Symbol, Stigg::Models::V1Beta::EntityTypeListParams::IncludeArchived] Whether to include archived entity types. One of: true, false
|
|
51
|
+
#
|
|
44
52
|
# @param limit [Integer] Maximum number of items to return
|
|
45
53
|
#
|
|
46
54
|
# @param x_account_id [String]
|
|
@@ -48,6 +56,17 @@ module Stigg
|
|
|
48
56
|
# @param x_environment_id [String]
|
|
49
57
|
#
|
|
50
58
|
# @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}]
|
|
59
|
+
|
|
60
|
+
# Whether to include archived entity types. One of: true, false
|
|
61
|
+
module IncludeArchived
|
|
62
|
+
extend Stigg::Internal::Type::Enum
|
|
63
|
+
|
|
64
|
+
TRUE = :true
|
|
65
|
+
FALSE = :false
|
|
66
|
+
|
|
67
|
+
# @!method self.values
|
|
68
|
+
# @return [Array<Symbol>]
|
|
69
|
+
end
|
|
51
70
|
end
|
|
52
71
|
end
|
|
53
72
|
end
|
|
@@ -11,6 +11,12 @@ module Stigg
|
|
|
11
11
|
# @return [String]
|
|
12
12
|
required :id, String
|
|
13
13
|
|
|
14
|
+
# @!attribute archived_at
|
|
15
|
+
# Timestamp of when the record was deleted
|
|
16
|
+
#
|
|
17
|
+
# @return [Time, nil]
|
|
18
|
+
required :archived_at, Time, api_name: :archivedAt, nil?: true
|
|
19
|
+
|
|
14
20
|
# @!attribute attribution_keys
|
|
15
21
|
# Dimension keys used to attribute usage events to instances of this type (e.g.
|
|
16
22
|
# ["orgId"]). Empty array means no attribution.
|
|
@@ -43,7 +49,7 @@ module Stigg
|
|
|
43
49
|
# @return [Time]
|
|
44
50
|
required :updated_at, Time, api_name: :updatedAt
|
|
45
51
|
|
|
46
|
-
# @!method initialize(id:, attribution_keys:, created_at:, description:, display_name:, updated_at:)
|
|
52
|
+
# @!method initialize(id:, archived_at:, attribution_keys:, created_at:, description:, display_name:, updated_at:)
|
|
47
53
|
# Some parameter documentations has been truncated, see
|
|
48
54
|
# {Stigg::Models::V1Beta::EntityTypeListResponse} for more details.
|
|
49
55
|
#
|
|
@@ -54,6 +60,8 @@ module Stigg
|
|
|
54
60
|
#
|
|
55
61
|
# @param id [String] The unique identifier for the entity
|
|
56
62
|
#
|
|
63
|
+
# @param archived_at [Time, nil] Timestamp of when the record was deleted
|
|
64
|
+
#
|
|
57
65
|
# @param attribution_keys [Array<String>] Dimension keys used to attribute usage events to instances of this type (e.g. ["
|
|
58
66
|
#
|
|
59
67
|
# @param created_at [Time] Timestamp of when the record was created
|
|
@@ -23,6 +23,12 @@ module Stigg
|
|
|
23
23
|
# @return [String]
|
|
24
24
|
required :id, String
|
|
25
25
|
|
|
26
|
+
# @!attribute archived_at
|
|
27
|
+
# Timestamp of when the record was deleted
|
|
28
|
+
#
|
|
29
|
+
# @return [Time, nil]
|
|
30
|
+
required :archived_at, Time, api_name: :archivedAt, nil?: true
|
|
31
|
+
|
|
26
32
|
# @!attribute attribution_keys
|
|
27
33
|
# Dimension keys used to attribute usage events to instances of this type (e.g.
|
|
28
34
|
# ["orgId"]). Empty array means no attribution.
|
|
@@ -55,7 +61,7 @@ module Stigg
|
|
|
55
61
|
# @return [Time]
|
|
56
62
|
required :updated_at, Time, api_name: :updatedAt
|
|
57
63
|
|
|
58
|
-
# @!method initialize(id:, attribution_keys:, created_at:, description:, display_name:, updated_at:)
|
|
64
|
+
# @!method initialize(id:, archived_at:, attribution_keys:, created_at:, description:, display_name:, updated_at:)
|
|
59
65
|
# Some parameter documentations has been truncated, see
|
|
60
66
|
# {Stigg::Models::V1Beta::EntityTypeUpsertResponse::Data} for more details.
|
|
61
67
|
#
|
|
@@ -66,6 +72,8 @@ module Stigg
|
|
|
66
72
|
#
|
|
67
73
|
# @param id [String] The unique identifier for the entity
|
|
68
74
|
#
|
|
75
|
+
# @param archived_at [Time, nil] Timestamp of when the record was deleted
|
|
76
|
+
#
|
|
69
77
|
# @param attribution_keys [Array<String>] Dimension keys used to attribute usage events to instances of this type (e.g. ["
|
|
70
78
|
#
|
|
71
79
|
# @param created_at [Time] Timestamp of when the record was created
|
|
@@ -54,7 +54,7 @@ module Stigg
|
|
|
54
54
|
# Updates an existing customer's properties such as name, email, and billing
|
|
55
55
|
# information.
|
|
56
56
|
#
|
|
57
|
-
# @overload update(id, billing_currency: nil, billing_id: nil, coupon_id: nil, email: nil, integrations: nil, language: nil, metadata: nil, name: nil, passthrough: nil, timezone: nil, x_account_id: nil, x_environment_id: nil, request_options: {})
|
|
57
|
+
# @overload update(id, billing_currency: nil, billing_id: nil, coupon_id: nil, email: nil, integrations: nil, language: nil, metadata: nil, name: nil, passthrough: nil, salesforce_id: nil, timezone: nil, x_account_id: nil, x_environment_id: nil, request_options: {})
|
|
58
58
|
#
|
|
59
59
|
# @param id [String] Path param: The unique identifier of the entity
|
|
60
60
|
#
|
|
@@ -76,6 +76,8 @@ module Stigg
|
|
|
76
76
|
#
|
|
77
77
|
# @param passthrough [Stigg::Models::V1::CustomerUpdateParams::Passthrough] Body param: Vendor-specific billing passthrough fields.
|
|
78
78
|
#
|
|
79
|
+
# @param salesforce_id [String, nil] Body param: The unique identifier for the customer in Salesforce integration
|
|
80
|
+
#
|
|
79
81
|
# @param timezone [String, nil] Body param: Timezone to use for this customer
|
|
80
82
|
#
|
|
81
83
|
# @param x_account_id [String] Header param: Account ID — optional when authenticating with a user JWT (Bearer
|
|
@@ -456,7 +458,7 @@ module Stigg
|
|
|
456
458
|
#
|
|
457
459
|
# Creates a new customer.
|
|
458
460
|
#
|
|
459
|
-
# @overload provision(id:, billing_currency: nil, billing_id: nil, coupon_id: nil, default_payment_method: nil, email: nil, integrations: nil, language: nil, metadata: nil, name: nil, passthrough: nil, timezone: nil, x_account_id: nil, x_environment_id: nil, request_options: {})
|
|
461
|
+
# @overload provision(id:, billing_currency: nil, billing_id: nil, coupon_id: nil, default_payment_method: nil, email: nil, integrations: nil, language: nil, metadata: nil, name: nil, passthrough: nil, salesforce_id: nil, timezone: nil, x_account_id: nil, x_environment_id: nil, request_options: {})
|
|
460
462
|
#
|
|
461
463
|
# @param id [String] Body param: Customer slug
|
|
462
464
|
#
|
|
@@ -480,6 +482,8 @@ module Stigg
|
|
|
480
482
|
#
|
|
481
483
|
# @param passthrough [Stigg::Models::V1::CustomerProvisionParams::Passthrough] Body param: Vendor-specific billing passthrough fields.
|
|
482
484
|
#
|
|
485
|
+
# @param salesforce_id [String, nil] Body param: The unique identifier for the customer in Salesforce integration
|
|
486
|
+
#
|
|
483
487
|
# @param timezone [String, nil] Body param: Timezone to use for this customer
|
|
484
488
|
#
|
|
485
489
|
# @param x_account_id [String] Header param: Account ID — optional when authenticating with a user JWT (Bearer
|
|
@@ -125,10 +125,13 @@ module Stigg
|
|
|
125
125
|
)
|
|
126
126
|
end
|
|
127
127
|
|
|
128
|
+
# @deprecated
|
|
129
|
+
#
|
|
128
130
|
# Some parameter documentations has been truncated, see
|
|
129
131
|
# {Stigg::Models::V1Beta::Customers::EntityUnarchiveParams} for more details.
|
|
130
132
|
#
|
|
131
|
-
#
|
|
133
|
+
# Deprecated: upsert an entity to restore it. Restores previously archived
|
|
134
|
+
# entities in bulk for the given customer by id.
|
|
132
135
|
#
|
|
133
136
|
# @overload unarchive(id, ids:, x_account_id: nil, x_environment_id: nil, request_options: {})
|
|
134
137
|
#
|
|
@@ -162,7 +165,8 @@ module Stigg
|
|
|
162
165
|
# {Stigg::Models::V1Beta::Customers::EntityUpsertParams} for more details.
|
|
163
166
|
#
|
|
164
167
|
# Creates or updates entities in bulk for the given customer. Existing entities
|
|
165
|
-
# matched by id are updated; new ids are created.
|
|
168
|
+
# matched by id are updated; new ids are created. An upsert of an archived entity
|
|
169
|
+
# restores it. An entity on an archived entity type fails with 400.
|
|
166
170
|
#
|
|
167
171
|
# @overload upsert(id, entities:, x_account_id: nil, x_environment_id: nil, request_options: {})
|
|
168
172
|
#
|
|
@@ -9,14 +9,17 @@ module Stigg
|
|
|
9
9
|
#
|
|
10
10
|
# Returns a cursor-paginated list of entity types defined in the environment.
|
|
11
11
|
# Entity types are vendor-defined categories of resource that can be governed
|
|
12
|
-
# (e.g. Org, Team, User).
|
|
12
|
+
# (e.g. Org, Team, User). Archived entity types are excluded unless
|
|
13
|
+
# includeArchived=true.
|
|
13
14
|
#
|
|
14
|
-
# @overload list(after: nil, before: nil, limit: nil, x_account_id: nil, x_environment_id: nil, request_options: {})
|
|
15
|
+
# @overload list(after: nil, before: nil, include_archived: nil, limit: nil, x_account_id: nil, x_environment_id: nil, request_options: {})
|
|
15
16
|
#
|
|
16
17
|
# @param after [String] Query param: Return items that come after this cursor
|
|
17
18
|
#
|
|
18
19
|
# @param before [String] Query param: Return items that come before this cursor
|
|
19
20
|
#
|
|
21
|
+
# @param include_archived [Symbol, Stigg::Models::V1Beta::EntityTypeListParams::IncludeArchived] Query param: Whether to include archived entity types. One of: true, false
|
|
22
|
+
#
|
|
20
23
|
# @param limit [Integer] Query param: Maximum number of items to return
|
|
21
24
|
#
|
|
22
25
|
# @param x_account_id [String] Header param: Account ID — optional when authenticating with a user JWT (Bearer
|
|
@@ -29,13 +32,13 @@ module Stigg
|
|
|
29
32
|
#
|
|
30
33
|
# @see Stigg::Models::V1Beta::EntityTypeListParams
|
|
31
34
|
def list(params = {})
|
|
32
|
-
query_params = [:after, :before, :limit]
|
|
35
|
+
query_params = [:after, :before, :include_archived, :limit]
|
|
33
36
|
parsed, options = Stigg::V1Beta::EntityTypeListParams.dump_request(params)
|
|
34
37
|
query = Stigg::Internal::Util.encode_query_params(parsed.slice(*query_params))
|
|
35
38
|
@client.request(
|
|
36
39
|
method: :get,
|
|
37
40
|
path: "api/v1-beta/entity-types",
|
|
38
|
-
query: query,
|
|
41
|
+
query: query.transform_keys(include_archived: "includeArchived"),
|
|
39
42
|
headers: parsed.except(*query_params).transform_keys(
|
|
40
43
|
x_account_id: "x-account-id",
|
|
41
44
|
x_environment_id: "x-environment-id"
|
|
@@ -51,7 +54,7 @@ module Stigg
|
|
|
51
54
|
#
|
|
52
55
|
# Batched create-or-update of entity types. Existing types matched by id are
|
|
53
56
|
# updated; new ids are created. Idempotent — re-submitting the same payload
|
|
54
|
-
# converges to the same state.
|
|
57
|
+
# converges to the same state. An upsert of an archived entity type restores it.
|
|
55
58
|
#
|
|
56
59
|
# @overload upsert(types:, x_account_id: nil, x_environment_id: nil, request_options: {})
|
|
57
60
|
#
|
data/lib/stigg/version.rb
CHANGED
|
@@ -131,6 +131,10 @@ module Stigg
|
|
|
131
131
|
end
|
|
132
132
|
attr_writer :passthrough
|
|
133
133
|
|
|
134
|
+
# The unique identifier for the customer in Salesforce integration
|
|
135
|
+
sig { returns(T.nilable(String)) }
|
|
136
|
+
attr_accessor :salesforce_id
|
|
137
|
+
|
|
134
138
|
# Timezone to use for this customer
|
|
135
139
|
sig { returns(T.nilable(String)) }
|
|
136
140
|
attr_accessor :timezone
|
|
@@ -168,6 +172,7 @@ module Stigg
|
|
|
168
172
|
name: T.nilable(String),
|
|
169
173
|
passthrough:
|
|
170
174
|
Stigg::Models::V1::CustomerListResponse::Passthrough::OrHash,
|
|
175
|
+
salesforce_id: T.nilable(String),
|
|
171
176
|
timezone: T.nilable(String)
|
|
172
177
|
).returns(T.attached_class)
|
|
173
178
|
end
|
|
@@ -204,6 +209,8 @@ module Stigg
|
|
|
204
209
|
name: nil,
|
|
205
210
|
# Vendor-specific billing passthrough fields.
|
|
206
211
|
passthrough: nil,
|
|
212
|
+
# The unique identifier for the customer in Salesforce integration
|
|
213
|
+
salesforce_id: nil,
|
|
207
214
|
# Timezone to use for this customer
|
|
208
215
|
timezone: nil
|
|
209
216
|
)
|
|
@@ -236,6 +243,7 @@ module Stigg
|
|
|
236
243
|
metadata: T::Hash[Symbol, String],
|
|
237
244
|
name: T.nilable(String),
|
|
238
245
|
passthrough: Stigg::Models::V1::CustomerListResponse::Passthrough,
|
|
246
|
+
salesforce_id: T.nilable(String),
|
|
239
247
|
timezone: T.nilable(String)
|
|
240
248
|
}
|
|
241
249
|
)
|
|
@@ -113,6 +113,10 @@ module Stigg
|
|
|
113
113
|
end
|
|
114
114
|
attr_writer :passthrough
|
|
115
115
|
|
|
116
|
+
# The unique identifier for the customer in Salesforce integration
|
|
117
|
+
sig { returns(T.nilable(String)) }
|
|
118
|
+
attr_accessor :salesforce_id
|
|
119
|
+
|
|
116
120
|
# Timezone to use for this customer
|
|
117
121
|
sig { returns(T.nilable(String)) }
|
|
118
122
|
attr_accessor :timezone
|
|
@@ -156,6 +160,7 @@ module Stigg
|
|
|
156
160
|
name: T.nilable(String),
|
|
157
161
|
passthrough:
|
|
158
162
|
Stigg::V1::CustomerProvisionParams::Passthrough::OrHash,
|
|
163
|
+
salesforce_id: T.nilable(String),
|
|
159
164
|
timezone: T.nilable(String),
|
|
160
165
|
x_account_id: String,
|
|
161
166
|
x_environment_id: String,
|
|
@@ -189,6 +194,8 @@ module Stigg
|
|
|
189
194
|
name: nil,
|
|
190
195
|
# Vendor-specific billing passthrough fields.
|
|
191
196
|
passthrough: nil,
|
|
197
|
+
# The unique identifier for the customer in Salesforce integration
|
|
198
|
+
salesforce_id: nil,
|
|
192
199
|
# Timezone to use for this customer
|
|
193
200
|
timezone: nil,
|
|
194
201
|
x_account_id: nil,
|
|
@@ -224,6 +231,7 @@ module Stigg
|
|
|
224
231
|
metadata: T::Hash[Symbol, String],
|
|
225
232
|
name: T.nilable(String),
|
|
226
233
|
passthrough: Stigg::V1::CustomerProvisionParams::Passthrough,
|
|
234
|
+
salesforce_id: T.nilable(String),
|
|
227
235
|
timezone: T.nilable(String),
|
|
228
236
|
x_account_id: String,
|
|
229
237
|
x_environment_id: String,
|
|
@@ -149,6 +149,10 @@ module Stigg
|
|
|
149
149
|
end
|
|
150
150
|
attr_writer :passthrough
|
|
151
151
|
|
|
152
|
+
# The unique identifier for the customer in Salesforce integration
|
|
153
|
+
sig { returns(T.nilable(String)) }
|
|
154
|
+
attr_accessor :salesforce_id
|
|
155
|
+
|
|
152
156
|
# Timezone to use for this customer
|
|
153
157
|
sig { returns(T.nilable(String)) }
|
|
154
158
|
attr_accessor :timezone
|
|
@@ -186,6 +190,7 @@ module Stigg
|
|
|
186
190
|
name: T.nilable(String),
|
|
187
191
|
passthrough:
|
|
188
192
|
Stigg::V1::CustomerResponse::Data::Passthrough::OrHash,
|
|
193
|
+
salesforce_id: T.nilable(String),
|
|
189
194
|
timezone: T.nilable(String)
|
|
190
195
|
).returns(T.attached_class)
|
|
191
196
|
end
|
|
@@ -222,6 +227,8 @@ module Stigg
|
|
|
222
227
|
name: nil,
|
|
223
228
|
# Vendor-specific billing passthrough fields.
|
|
224
229
|
passthrough: nil,
|
|
230
|
+
# The unique identifier for the customer in Salesforce integration
|
|
231
|
+
salesforce_id: nil,
|
|
225
232
|
# Timezone to use for this customer
|
|
226
233
|
timezone: nil
|
|
227
234
|
)
|
|
@@ -254,6 +261,7 @@ module Stigg
|
|
|
254
261
|
metadata: T::Hash[Symbol, String],
|
|
255
262
|
name: T.nilable(String),
|
|
256
263
|
passthrough: Stigg::V1::CustomerResponse::Data::Passthrough,
|
|
264
|
+
salesforce_id: T.nilable(String),
|
|
257
265
|
timezone: T.nilable(String)
|
|
258
266
|
}
|
|
259
267
|
)
|
|
@@ -89,6 +89,10 @@ module Stigg
|
|
|
89
89
|
end
|
|
90
90
|
attr_writer :passthrough
|
|
91
91
|
|
|
92
|
+
# The unique identifier for the customer in Salesforce integration
|
|
93
|
+
sig { returns(T.nilable(String)) }
|
|
94
|
+
attr_accessor :salesforce_id
|
|
95
|
+
|
|
92
96
|
# Timezone to use for this customer
|
|
93
97
|
sig { returns(T.nilable(String)) }
|
|
94
98
|
attr_accessor :timezone
|
|
@@ -127,6 +131,7 @@ module Stigg
|
|
|
127
131
|
metadata: T::Hash[Symbol, String],
|
|
128
132
|
name: T.nilable(String),
|
|
129
133
|
passthrough: Stigg::V1::CustomerUpdateParams::Passthrough::OrHash,
|
|
134
|
+
salesforce_id: T.nilable(String),
|
|
130
135
|
timezone: T.nilable(String),
|
|
131
136
|
x_account_id: String,
|
|
132
137
|
x_environment_id: String,
|
|
@@ -157,6 +162,8 @@ module Stigg
|
|
|
157
162
|
name: nil,
|
|
158
163
|
# Vendor-specific billing passthrough fields.
|
|
159
164
|
passthrough: nil,
|
|
165
|
+
# The unique identifier for the customer in Salesforce integration
|
|
166
|
+
salesforce_id: nil,
|
|
160
167
|
# Timezone to use for this customer
|
|
161
168
|
timezone: nil,
|
|
162
169
|
x_account_id: nil,
|
|
@@ -188,6 +195,7 @@ module Stigg
|
|
|
188
195
|
metadata: T::Hash[Symbol, String],
|
|
189
196
|
name: T.nilable(String),
|
|
190
197
|
passthrough: Stigg::V1::CustomerUpdateParams::Passthrough,
|
|
198
|
+
salesforce_id: T.nilable(String),
|
|
191
199
|
timezone: T.nilable(String),
|
|
192
200
|
x_account_id: String,
|
|
193
201
|
x_environment_id: String,
|
|
@@ -26,6 +26,24 @@ module Stigg
|
|
|
26
26
|
sig { params(before: String).void }
|
|
27
27
|
attr_writer :before
|
|
28
28
|
|
|
29
|
+
# Whether to include archived entity types. One of: true, false
|
|
30
|
+
sig do
|
|
31
|
+
returns(
|
|
32
|
+
T.nilable(
|
|
33
|
+
Stigg::V1Beta::EntityTypeListParams::IncludeArchived::OrSymbol
|
|
34
|
+
)
|
|
35
|
+
)
|
|
36
|
+
end
|
|
37
|
+
attr_reader :include_archived
|
|
38
|
+
|
|
39
|
+
sig do
|
|
40
|
+
params(
|
|
41
|
+
include_archived:
|
|
42
|
+
Stigg::V1Beta::EntityTypeListParams::IncludeArchived::OrSymbol
|
|
43
|
+
).void
|
|
44
|
+
end
|
|
45
|
+
attr_writer :include_archived
|
|
46
|
+
|
|
29
47
|
# Maximum number of items to return
|
|
30
48
|
sig { returns(T.nilable(Integer)) }
|
|
31
49
|
attr_reader :limit
|
|
@@ -49,6 +67,8 @@ module Stigg
|
|
|
49
67
|
params(
|
|
50
68
|
after: String,
|
|
51
69
|
before: String,
|
|
70
|
+
include_archived:
|
|
71
|
+
Stigg::V1Beta::EntityTypeListParams::IncludeArchived::OrSymbol,
|
|
52
72
|
limit: Integer,
|
|
53
73
|
x_account_id: String,
|
|
54
74
|
x_environment_id: String,
|
|
@@ -60,6 +80,8 @@ module Stigg
|
|
|
60
80
|
after: nil,
|
|
61
81
|
# Return items that come before this cursor
|
|
62
82
|
before: nil,
|
|
83
|
+
# Whether to include archived entity types. One of: true, false
|
|
84
|
+
include_archived: nil,
|
|
63
85
|
# Maximum number of items to return
|
|
64
86
|
limit: nil,
|
|
65
87
|
x_account_id: nil,
|
|
@@ -73,6 +95,8 @@ module Stigg
|
|
|
73
95
|
{
|
|
74
96
|
after: String,
|
|
75
97
|
before: String,
|
|
98
|
+
include_archived:
|
|
99
|
+
Stigg::V1Beta::EntityTypeListParams::IncludeArchived::OrSymbol,
|
|
76
100
|
limit: Integer,
|
|
77
101
|
x_account_id: String,
|
|
78
102
|
x_environment_id: String,
|
|
@@ -82,6 +106,41 @@ module Stigg
|
|
|
82
106
|
end
|
|
83
107
|
def to_hash
|
|
84
108
|
end
|
|
109
|
+
|
|
110
|
+
# Whether to include archived entity types. One of: true, false
|
|
111
|
+
module IncludeArchived
|
|
112
|
+
extend Stigg::Internal::Type::Enum
|
|
113
|
+
|
|
114
|
+
TaggedSymbol =
|
|
115
|
+
T.type_alias do
|
|
116
|
+
T.all(
|
|
117
|
+
Symbol,
|
|
118
|
+
Stigg::V1Beta::EntityTypeListParams::IncludeArchived
|
|
119
|
+
)
|
|
120
|
+
end
|
|
121
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
|
122
|
+
|
|
123
|
+
TRUE =
|
|
124
|
+
T.let(
|
|
125
|
+
:true,
|
|
126
|
+
Stigg::V1Beta::EntityTypeListParams::IncludeArchived::TaggedSymbol
|
|
127
|
+
)
|
|
128
|
+
FALSE =
|
|
129
|
+
T.let(
|
|
130
|
+
:false,
|
|
131
|
+
Stigg::V1Beta::EntityTypeListParams::IncludeArchived::TaggedSymbol
|
|
132
|
+
)
|
|
133
|
+
|
|
134
|
+
sig do
|
|
135
|
+
override.returns(
|
|
136
|
+
T::Array[
|
|
137
|
+
Stigg::V1Beta::EntityTypeListParams::IncludeArchived::TaggedSymbol
|
|
138
|
+
]
|
|
139
|
+
)
|
|
140
|
+
end
|
|
141
|
+
def self.values
|
|
142
|
+
end
|
|
143
|
+
end
|
|
85
144
|
end
|
|
86
145
|
end
|
|
87
146
|
end
|
|
@@ -16,6 +16,10 @@ module Stigg
|
|
|
16
16
|
sig { returns(String) }
|
|
17
17
|
attr_accessor :id
|
|
18
18
|
|
|
19
|
+
# Timestamp of when the record was deleted
|
|
20
|
+
sig { returns(T.nilable(Time)) }
|
|
21
|
+
attr_accessor :archived_at
|
|
22
|
+
|
|
19
23
|
# Dimension keys used to attribute usage events to instances of this type (e.g.
|
|
20
24
|
# ["orgId"]). Empty array means no attribution.
|
|
21
25
|
sig { returns(T::Array[String]) }
|
|
@@ -45,6 +49,7 @@ module Stigg
|
|
|
45
49
|
sig do
|
|
46
50
|
params(
|
|
47
51
|
id: String,
|
|
52
|
+
archived_at: T.nilable(Time),
|
|
48
53
|
attribution_keys: T::Array[String],
|
|
49
54
|
created_at: Time,
|
|
50
55
|
description: T.nilable(String),
|
|
@@ -55,6 +60,8 @@ module Stigg
|
|
|
55
60
|
def self.new(
|
|
56
61
|
# The unique identifier for the entity
|
|
57
62
|
id:,
|
|
63
|
+
# Timestamp of when the record was deleted
|
|
64
|
+
archived_at:,
|
|
58
65
|
# Dimension keys used to attribute usage events to instances of this type (e.g.
|
|
59
66
|
# ["orgId"]). Empty array means no attribution.
|
|
60
67
|
attribution_keys:,
|
|
@@ -74,6 +81,7 @@ module Stigg
|
|
|
74
81
|
override.returns(
|
|
75
82
|
{
|
|
76
83
|
id: String,
|
|
84
|
+
archived_at: T.nilable(Time),
|
|
77
85
|
attribution_keys: T::Array[String],
|
|
78
86
|
created_at: Time,
|
|
79
87
|
description: T.nilable(String),
|
|
@@ -55,6 +55,10 @@ module Stigg
|
|
|
55
55
|
sig { returns(String) }
|
|
56
56
|
attr_accessor :id
|
|
57
57
|
|
|
58
|
+
# Timestamp of when the record was deleted
|
|
59
|
+
sig { returns(T.nilable(Time)) }
|
|
60
|
+
attr_accessor :archived_at
|
|
61
|
+
|
|
58
62
|
# Dimension keys used to attribute usage events to instances of this type (e.g.
|
|
59
63
|
# ["orgId"]). Empty array means no attribution.
|
|
60
64
|
sig { returns(T::Array[String]) }
|
|
@@ -84,6 +88,7 @@ module Stigg
|
|
|
84
88
|
sig do
|
|
85
89
|
params(
|
|
86
90
|
id: String,
|
|
91
|
+
archived_at: T.nilable(Time),
|
|
87
92
|
attribution_keys: T::Array[String],
|
|
88
93
|
created_at: Time,
|
|
89
94
|
description: T.nilable(String),
|
|
@@ -94,6 +99,8 @@ module Stigg
|
|
|
94
99
|
def self.new(
|
|
95
100
|
# The unique identifier for the entity
|
|
96
101
|
id:,
|
|
102
|
+
# Timestamp of when the record was deleted
|
|
103
|
+
archived_at:,
|
|
97
104
|
# Dimension keys used to attribute usage events to instances of this type (e.g.
|
|
98
105
|
# ["orgId"]). Empty array means no attribution.
|
|
99
106
|
attribution_keys:,
|
|
@@ -113,6 +120,7 @@ module Stigg
|
|
|
113
120
|
override.returns(
|
|
114
121
|
{
|
|
115
122
|
id: String,
|
|
123
|
+
archived_at: T.nilable(Time),
|
|
116
124
|
attribution_keys: T::Array[String],
|
|
117
125
|
created_at: Time,
|
|
118
126
|
description: T.nilable(String),
|
|
@@ -65,6 +65,7 @@ module Stigg
|
|
|
65
65
|
metadata: T::Hash[Symbol, String],
|
|
66
66
|
name: T.nilable(String),
|
|
67
67
|
passthrough: Stigg::V1::CustomerUpdateParams::Passthrough::OrHash,
|
|
68
|
+
salesforce_id: T.nilable(String),
|
|
68
69
|
timezone: T.nilable(String),
|
|
69
70
|
x_account_id: String,
|
|
70
71
|
x_environment_id: String,
|
|
@@ -96,6 +97,8 @@ module Stigg
|
|
|
96
97
|
name: nil,
|
|
97
98
|
# Body param: Vendor-specific billing passthrough fields.
|
|
98
99
|
passthrough: nil,
|
|
100
|
+
# Body param: The unique identifier for the customer in Salesforce integration
|
|
101
|
+
salesforce_id: nil,
|
|
99
102
|
# Body param: Timezone to use for this customer
|
|
100
103
|
timezone: nil,
|
|
101
104
|
# Header param: Account ID — optional when authenticating with a user JWT (Bearer
|
|
@@ -425,6 +428,7 @@ module Stigg
|
|
|
425
428
|
name: T.nilable(String),
|
|
426
429
|
passthrough:
|
|
427
430
|
Stigg::V1::CustomerProvisionParams::Passthrough::OrHash,
|
|
431
|
+
salesforce_id: T.nilable(String),
|
|
428
432
|
timezone: T.nilable(String),
|
|
429
433
|
x_account_id: String,
|
|
430
434
|
x_environment_id: String,
|
|
@@ -458,6 +462,8 @@ module Stigg
|
|
|
458
462
|
name: nil,
|
|
459
463
|
# Body param: Vendor-specific billing passthrough fields.
|
|
460
464
|
passthrough: nil,
|
|
465
|
+
# Body param: The unique identifier for the customer in Salesforce integration
|
|
466
|
+
salesforce_id: nil,
|
|
461
467
|
# Body param: Timezone to use for this customer
|
|
462
468
|
timezone: nil,
|
|
463
469
|
# Header param: Account ID — optional when authenticating with a user JWT (Bearer
|
|
@@ -101,7 +101,8 @@ module Stigg
|
|
|
101
101
|
)
|
|
102
102
|
end
|
|
103
103
|
|
|
104
|
-
#
|
|
104
|
+
# Deprecated: upsert an entity to restore it. Restores previously archived
|
|
105
|
+
# entities in bulk for the given customer by id.
|
|
105
106
|
sig do
|
|
106
107
|
params(
|
|
107
108
|
id: String,
|
|
@@ -128,7 +129,8 @@ module Stigg
|
|
|
128
129
|
end
|
|
129
130
|
|
|
130
131
|
# Creates or updates entities in bulk for the given customer. Existing entities
|
|
131
|
-
# matched by id are updated; new ids are created.
|
|
132
|
+
# matched by id are updated; new ids are created. An upsert of an archived entity
|
|
133
|
+
# restores it. An entity on an archived entity type fails with 400.
|
|
132
134
|
sig do
|
|
133
135
|
params(
|
|
134
136
|
id: String,
|
|
@@ -6,11 +6,14 @@ module Stigg
|
|
|
6
6
|
class EntityTypes
|
|
7
7
|
# Returns a cursor-paginated list of entity types defined in the environment.
|
|
8
8
|
# Entity types are vendor-defined categories of resource that can be governed
|
|
9
|
-
# (e.g. Org, Team, User).
|
|
9
|
+
# (e.g. Org, Team, User). Archived entity types are excluded unless
|
|
10
|
+
# includeArchived=true.
|
|
10
11
|
sig do
|
|
11
12
|
params(
|
|
12
13
|
after: String,
|
|
13
14
|
before: String,
|
|
15
|
+
include_archived:
|
|
16
|
+
Stigg::V1Beta::EntityTypeListParams::IncludeArchived::OrSymbol,
|
|
14
17
|
limit: Integer,
|
|
15
18
|
x_account_id: String,
|
|
16
19
|
x_environment_id: String,
|
|
@@ -26,6 +29,8 @@ module Stigg
|
|
|
26
29
|
after: nil,
|
|
27
30
|
# Query param: Return items that come before this cursor
|
|
28
31
|
before: nil,
|
|
32
|
+
# Query param: Whether to include archived entity types. One of: true, false
|
|
33
|
+
include_archived: nil,
|
|
29
34
|
# Query param: Maximum number of items to return
|
|
30
35
|
limit: nil,
|
|
31
36
|
# Header param: Account ID — optional when authenticating with a user JWT (Bearer
|
|
@@ -41,7 +46,7 @@ module Stigg
|
|
|
41
46
|
|
|
42
47
|
# Batched create-or-update of entity types. Existing types matched by id are
|
|
43
48
|
# updated; new ids are created. Idempotent — re-submitting the same payload
|
|
44
|
-
# converges to the same state.
|
|
49
|
+
# converges to the same state. An upsert of an archived entity type restores it.
|
|
45
50
|
sig do
|
|
46
51
|
params(
|
|
47
52
|
types:
|
|
@@ -17,6 +17,7 @@ module Stigg
|
|
|
17
17
|
metadata: ::Hash[Symbol, String],
|
|
18
18
|
name: String?,
|
|
19
19
|
passthrough: Stigg::Models::V1::CustomerListResponse::Passthrough,
|
|
20
|
+
salesforce_id: String?,
|
|
20
21
|
timezone: String?
|
|
21
22
|
}
|
|
22
23
|
|
|
@@ -59,6 +60,8 @@ module Stigg
|
|
|
59
60
|
Stigg::Models::V1::CustomerListResponse::Passthrough
|
|
60
61
|
) -> Stigg::Models::V1::CustomerListResponse::Passthrough
|
|
61
62
|
|
|
63
|
+
attr_accessor salesforce_id: String?
|
|
64
|
+
|
|
62
65
|
attr_accessor timezone: String?
|
|
63
66
|
|
|
64
67
|
def initialize: (
|
|
@@ -76,6 +79,7 @@ module Stigg
|
|
|
76
79
|
?metadata: ::Hash[Symbol, String],
|
|
77
80
|
?name: String?,
|
|
78
81
|
?passthrough: Stigg::Models::V1::CustomerListResponse::Passthrough,
|
|
82
|
+
?salesforce_id: String?,
|
|
79
83
|
?timezone: String?
|
|
80
84
|
) -> void
|
|
81
85
|
|
|
@@ -94,6 +98,7 @@ module Stigg
|
|
|
94
98
|
metadata: ::Hash[Symbol, String],
|
|
95
99
|
name: String?,
|
|
96
100
|
passthrough: Stigg::Models::V1::CustomerListResponse::Passthrough,
|
|
101
|
+
salesforce_id: String?,
|
|
97
102
|
timezone: String?
|
|
98
103
|
}
|
|
99
104
|
|
|
@@ -14,6 +14,7 @@ module Stigg
|
|
|
14
14
|
metadata: ::Hash[Symbol, String],
|
|
15
15
|
name: String?,
|
|
16
16
|
passthrough: Stigg::V1::CustomerProvisionParams::Passthrough,
|
|
17
|
+
salesforce_id: String?,
|
|
17
18
|
timezone: String?,
|
|
18
19
|
x_account_id: String,
|
|
19
20
|
x_environment_id: String
|
|
@@ -56,6 +57,8 @@ module Stigg
|
|
|
56
57
|
Stigg::V1::CustomerProvisionParams::Passthrough
|
|
57
58
|
) -> Stigg::V1::CustomerProvisionParams::Passthrough
|
|
58
59
|
|
|
60
|
+
attr_accessor salesforce_id: String?
|
|
61
|
+
|
|
59
62
|
attr_accessor timezone: String?
|
|
60
63
|
|
|
61
64
|
attr_reader x_account_id: String?
|
|
@@ -78,6 +81,7 @@ module Stigg
|
|
|
78
81
|
?metadata: ::Hash[Symbol, String],
|
|
79
82
|
?name: String?,
|
|
80
83
|
?passthrough: Stigg::V1::CustomerProvisionParams::Passthrough,
|
|
84
|
+
?salesforce_id: String?,
|
|
81
85
|
?timezone: String?,
|
|
82
86
|
?x_account_id: String,
|
|
83
87
|
?x_environment_id: String,
|
|
@@ -96,6 +100,7 @@ module Stigg
|
|
|
96
100
|
metadata: ::Hash[Symbol, String],
|
|
97
101
|
name: String?,
|
|
98
102
|
passthrough: Stigg::V1::CustomerProvisionParams::Passthrough,
|
|
103
|
+
salesforce_id: String?,
|
|
99
104
|
timezone: String?,
|
|
100
105
|
x_account_id: String,
|
|
101
106
|
x_environment_id: String,
|
|
@@ -26,6 +26,7 @@ module Stigg
|
|
|
26
26
|
metadata: ::Hash[Symbol, String],
|
|
27
27
|
name: String?,
|
|
28
28
|
passthrough: Stigg::V1::CustomerResponse::Data::Passthrough,
|
|
29
|
+
salesforce_id: String?,
|
|
29
30
|
timezone: String?
|
|
30
31
|
}
|
|
31
32
|
|
|
@@ -68,6 +69,8 @@ module Stigg
|
|
|
68
69
|
Stigg::V1::CustomerResponse::Data::Passthrough
|
|
69
70
|
) -> Stigg::V1::CustomerResponse::Data::Passthrough
|
|
70
71
|
|
|
72
|
+
attr_accessor salesforce_id: String?
|
|
73
|
+
|
|
71
74
|
attr_accessor timezone: String?
|
|
72
75
|
|
|
73
76
|
def initialize: (
|
|
@@ -85,6 +88,7 @@ module Stigg
|
|
|
85
88
|
?metadata: ::Hash[Symbol, String],
|
|
86
89
|
?name: String?,
|
|
87
90
|
?passthrough: Stigg::V1::CustomerResponse::Data::Passthrough,
|
|
91
|
+
?salesforce_id: String?,
|
|
88
92
|
?timezone: String?
|
|
89
93
|
) -> void
|
|
90
94
|
|
|
@@ -103,6 +107,7 @@ module Stigg
|
|
|
103
107
|
metadata: ::Hash[Symbol, String],
|
|
104
108
|
name: String?,
|
|
105
109
|
passthrough: Stigg::V1::CustomerResponse::Data::Passthrough,
|
|
110
|
+
salesforce_id: String?,
|
|
106
111
|
timezone: String?
|
|
107
112
|
}
|
|
108
113
|
|
|
@@ -13,6 +13,7 @@ module Stigg
|
|
|
13
13
|
metadata: ::Hash[Symbol, String],
|
|
14
14
|
name: String?,
|
|
15
15
|
passthrough: Stigg::V1::CustomerUpdateParams::Passthrough,
|
|
16
|
+
salesforce_id: String?,
|
|
16
17
|
timezone: String?,
|
|
17
18
|
x_account_id: String,
|
|
18
19
|
x_environment_id: String
|
|
@@ -53,6 +54,8 @@ module Stigg
|
|
|
53
54
|
Stigg::V1::CustomerUpdateParams::Passthrough
|
|
54
55
|
) -> Stigg::V1::CustomerUpdateParams::Passthrough
|
|
55
56
|
|
|
57
|
+
attr_accessor salesforce_id: String?
|
|
58
|
+
|
|
56
59
|
attr_accessor timezone: String?
|
|
57
60
|
|
|
58
61
|
attr_reader x_account_id: String?
|
|
@@ -74,6 +77,7 @@ module Stigg
|
|
|
74
77
|
?metadata: ::Hash[Symbol, String],
|
|
75
78
|
?name: String?,
|
|
76
79
|
?passthrough: Stigg::V1::CustomerUpdateParams::Passthrough,
|
|
80
|
+
?salesforce_id: String?,
|
|
77
81
|
?timezone: String?,
|
|
78
82
|
?x_account_id: String,
|
|
79
83
|
?x_environment_id: String,
|
|
@@ -91,6 +95,7 @@ module Stigg
|
|
|
91
95
|
metadata: ::Hash[Symbol, String],
|
|
92
96
|
name: String?,
|
|
93
97
|
passthrough: Stigg::V1::CustomerUpdateParams::Passthrough,
|
|
98
|
+
salesforce_id: String?,
|
|
94
99
|
timezone: String?,
|
|
95
100
|
x_account_id: String,
|
|
96
101
|
x_environment_id: String,
|
|
@@ -5,6 +5,7 @@ module Stigg
|
|
|
5
5
|
{
|
|
6
6
|
after: String,
|
|
7
7
|
before: String,
|
|
8
|
+
include_archived: Stigg::Models::V1Beta::EntityTypeListParams::include_archived,
|
|
8
9
|
limit: Integer,
|
|
9
10
|
x_account_id: String,
|
|
10
11
|
x_environment_id: String
|
|
@@ -23,6 +24,12 @@ module Stigg
|
|
|
23
24
|
|
|
24
25
|
def before=: (String) -> String
|
|
25
26
|
|
|
27
|
+
attr_reader include_archived: Stigg::Models::V1Beta::EntityTypeListParams::include_archived?
|
|
28
|
+
|
|
29
|
+
def include_archived=: (
|
|
30
|
+
Stigg::Models::V1Beta::EntityTypeListParams::include_archived
|
|
31
|
+
) -> Stigg::Models::V1Beta::EntityTypeListParams::include_archived
|
|
32
|
+
|
|
26
33
|
attr_reader limit: Integer?
|
|
27
34
|
|
|
28
35
|
def limit=: (Integer) -> Integer
|
|
@@ -38,6 +45,7 @@ module Stigg
|
|
|
38
45
|
def initialize: (
|
|
39
46
|
?after: String,
|
|
40
47
|
?before: String,
|
|
48
|
+
?include_archived: Stigg::Models::V1Beta::EntityTypeListParams::include_archived,
|
|
41
49
|
?limit: Integer,
|
|
42
50
|
?x_account_id: String,
|
|
43
51
|
?x_environment_id: String,
|
|
@@ -47,11 +55,23 @@ module Stigg
|
|
|
47
55
|
def to_hash: -> {
|
|
48
56
|
after: String,
|
|
49
57
|
before: String,
|
|
58
|
+
include_archived: Stigg::Models::V1Beta::EntityTypeListParams::include_archived,
|
|
50
59
|
limit: Integer,
|
|
51
60
|
x_account_id: String,
|
|
52
61
|
x_environment_id: String,
|
|
53
62
|
request_options: Stigg::RequestOptions
|
|
54
63
|
}
|
|
64
|
+
|
|
65
|
+
type include_archived = :true | :false
|
|
66
|
+
|
|
67
|
+
module IncludeArchived
|
|
68
|
+
extend Stigg::Internal::Type::Enum
|
|
69
|
+
|
|
70
|
+
TRUE: :true
|
|
71
|
+
FALSE: :false
|
|
72
|
+
|
|
73
|
+
def self?.values: -> ::Array[Stigg::Models::V1Beta::EntityTypeListParams::include_archived]
|
|
74
|
+
end
|
|
55
75
|
end
|
|
56
76
|
end
|
|
57
77
|
end
|
|
@@ -4,6 +4,7 @@ module Stigg
|
|
|
4
4
|
type entity_type_list_response =
|
|
5
5
|
{
|
|
6
6
|
id: String,
|
|
7
|
+
archived_at: Time?,
|
|
7
8
|
attribution_keys: ::Array[String],
|
|
8
9
|
created_at: Time,
|
|
9
10
|
description: String?,
|
|
@@ -14,6 +15,8 @@ module Stigg
|
|
|
14
15
|
class EntityTypeListResponse < Stigg::Internal::Type::BaseModel
|
|
15
16
|
attr_accessor id: String
|
|
16
17
|
|
|
18
|
+
attr_accessor archived_at: Time?
|
|
19
|
+
|
|
17
20
|
attr_accessor attribution_keys: ::Array[String]
|
|
18
21
|
|
|
19
22
|
attr_accessor created_at: Time
|
|
@@ -26,6 +29,7 @@ module Stigg
|
|
|
26
29
|
|
|
27
30
|
def initialize: (
|
|
28
31
|
id: String,
|
|
32
|
+
archived_at: Time?,
|
|
29
33
|
attribution_keys: ::Array[String],
|
|
30
34
|
created_at: Time,
|
|
31
35
|
description: String?,
|
|
@@ -35,6 +39,7 @@ module Stigg
|
|
|
35
39
|
|
|
36
40
|
def to_hash: -> {
|
|
37
41
|
id: String,
|
|
42
|
+
archived_at: Time?,
|
|
38
43
|
attribution_keys: ::Array[String],
|
|
39
44
|
created_at: Time,
|
|
40
45
|
description: String?,
|
|
@@ -18,6 +18,7 @@ module Stigg
|
|
|
18
18
|
type data =
|
|
19
19
|
{
|
|
20
20
|
id: String,
|
|
21
|
+
archived_at: Time?,
|
|
21
22
|
attribution_keys: ::Array[String],
|
|
22
23
|
created_at: Time,
|
|
23
24
|
description: String?,
|
|
@@ -28,6 +29,8 @@ module Stigg
|
|
|
28
29
|
class Data < Stigg::Internal::Type::BaseModel
|
|
29
30
|
attr_accessor id: String
|
|
30
31
|
|
|
32
|
+
attr_accessor archived_at: Time?
|
|
33
|
+
|
|
31
34
|
attr_accessor attribution_keys: ::Array[String]
|
|
32
35
|
|
|
33
36
|
attr_accessor created_at: Time
|
|
@@ -40,6 +43,7 @@ module Stigg
|
|
|
40
43
|
|
|
41
44
|
def initialize: (
|
|
42
45
|
id: String,
|
|
46
|
+
archived_at: Time?,
|
|
43
47
|
attribution_keys: ::Array[String],
|
|
44
48
|
created_at: Time,
|
|
45
49
|
description: String?,
|
|
@@ -49,6 +53,7 @@ module Stigg
|
|
|
49
53
|
|
|
50
54
|
def to_hash: -> {
|
|
51
55
|
id: String,
|
|
56
|
+
archived_at: Time?,
|
|
52
57
|
attribution_keys: ::Array[String],
|
|
53
58
|
created_at: Time,
|
|
54
59
|
description: String?,
|
|
@@ -26,6 +26,7 @@ module Stigg
|
|
|
26
26
|
?metadata: ::Hash[Symbol, String],
|
|
27
27
|
?name: String?,
|
|
28
28
|
?passthrough: Stigg::V1::CustomerUpdateParams::Passthrough,
|
|
29
|
+
?salesforce_id: String?,
|
|
29
30
|
?timezone: String?,
|
|
30
31
|
?x_account_id: String,
|
|
31
32
|
?x_environment_id: String,
|
|
@@ -121,6 +122,7 @@ module Stigg
|
|
|
121
122
|
?metadata: ::Hash[Symbol, String],
|
|
122
123
|
?name: String?,
|
|
123
124
|
?passthrough: Stigg::V1::CustomerProvisionParams::Passthrough,
|
|
125
|
+
?salesforce_id: String?,
|
|
124
126
|
?timezone: String?,
|
|
125
127
|
?x_account_id: String,
|
|
126
128
|
?x_environment_id: String,
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: stigg
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.1.0.pre.beta.
|
|
4
|
+
version: 0.1.0.pre.beta.62
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Stigg
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2026-10-
|
|
11
|
+
date: 2026-10-29 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: cgi
|