workos 2.8.0 → 2.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8aa19ede17769e141b7fcffeeb62b5cf4b3629fa0e70d1084b79078b691e1a28
-  data.tar.gz: '0395d416943a7f9f2e76643ae5eaa895025ee80acbdc751760e5cc7fb361b6f9'
+  metadata.gz: fd6da710852e1f089d5c3b501cc2d55ef5f9e85d8f8a745d740a5d6e0a6df4d6
+  data.tar.gz: 66ecf5d3316f904bacf20d9a0ecf7f7ff81633b455979863ce988d1d19f78c82
 SHA512:
-  metadata.gz: db2f2a83a2805b3e1f838a5335cfc990edf2dd045955e4086ecc6b209c52dffad25b9d06e34f085e98e3f55b54b39d281a419026cc7216b6f368a95e17353679
-  data.tar.gz: 90412141f8bda8924677b49381ee111fe06bff8dde9d7ff8b6c1c039c52f2970ef2b3b503766955f2454ccf92b7839087248f2796ea71d880546e24ec5c04628
+  metadata.gz: 036340bb1ba592f4abdf7884c1a64080a2d3b0c8bf1e24f6ed1323304f9a073723c5cd5297f6067f5d63b9e23ecdb498b2d776301c7d00431c9fc3085a9a070d
+  data.tar.gz: 10b5067388e52420fde807b1f0b40f66efd4cf9c9c027a6bc27610acc7700cdbee910311b819ad941d4be32ed78fa87356fc81c39555af947d984b6103bcbd6d

data/.github/pull_request_template.md

@@ -0,0 +1,11 @@
+## Description
+
+## Documentation
+
+Does this require changes to the WorkOS Docs? E.g. the [API Reference](https://workos.com/docs/reference) or code snippets need updates.
+
+```
+[ ] Yes
+```
+
+If yes, link a related docs PR and add a docs maintainer as a reviewer. Their approval is required.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    workos (2.8.0)
+    workos (2.10.0)
       sorbet-runtime (~> 0.5)
 
 GEM

data/lib/workos/portal.rb

@@ -17,20 +17,23 @@ module WorkOS
       # Generate a link to grant access to an organization's Admin Portal
       #
       # @param [String] intent The access scope for the generated Admin Portal
-      #  link. Valid values are: ["sso", "dsync"]
+      #  link. Valid values are: ["audit_logs", "dsync", "log_streams", "sso",]
       # @param [String] organization The ID of the organization the Admin
       #  Portal link will be generated for.
       # @param [String] The URL that the end user will be redirected to upon
       #  exiting the generated Admin Portal. If none is provided, the default
       #  redirect link set in your WorkOS Dashboard will be used.
+      # @param [String] The URL to which WorkOS will redirect users to upon
+      #  successfully setting up Single Sign On or Directory Sync.
       sig do
         params(
           intent: String,
           organization: String,
           return_url: T.nilable(String),
+          success_url: T.nilable(String),
         ).returns(String)
       end
-      def generate_link(intent:, organization:, return_url: nil)
+      def generate_link(intent:, organization:, return_url: nil, success_url: nil)
         validate_intent(intent)
 
         request = post_request(
@@ -39,6 +42,7 @@ module WorkOS
             intent: intent,
             organization: organization,
             return_url: return_url,
+            success_url: success_url,
           },
           path: '/portal/generate_link',
         )

data/lib/workos/types/intent_enum.rb

@@ -7,9 +7,10 @@ module WorkOS
     # intents while generating an Admin Portal link.
     class Intent < T::Enum
       enums do
-        SSO = new('sso')
-        DSYNC = new('dsync')
         AUDIT_LOGS = new('audit_logs')
+        DSYNC = new('dsync')
+        LOG_STREAMS = new('log_streams')
+        SSO = new('sso')
       end
     end
   end

data/lib/workos/version.rb

@@ -2,5 +2,5 @@
 # typed: strong
 
 module WorkOS
-  VERSION = '2.8.0'
+  VERSION = '2.10.0'
 end

data/spec/support/fixtures/vcr_cassettes/portal/generate_link_audit_logs.yml

@@ -5,7 +5,7 @@ http_interactions:
       uri: https://api.workos.com/portal/generate_link
       body:
         encoding: UTF-8
-        string: '{"intent":"audit_logs","organization":"org_01EHQMYV6MBK39QC5PZXHY59C3","return_url":null}'
+        string: '{"intent":"audit_logs","organization":"org_01EHQMYV6MBK39QC5PZXHY59C3","return_url":null,"success_url":null}'
       headers:
         Content-Type:
           - application/json

data/spec/support/fixtures/vcr_cassettes/portal/generate_link_dsync.yml

@@ -5,7 +5,7 @@ http_interactions:
     uri: https://api.workos.com/portal/generate_link
     body:
       encoding: UTF-8
-      string: '{"intent":"dsync","organization":"org_01EHQMYV6MBK39QC5PZXHY59C3","return_url":null}'
+      string: '{"intent":"dsync","organization":"org_01EHQMYV6MBK39QC5PZXHY59C3","return_url":null,"success_url":null}'
     headers:
       Content-Type:
       - application/json

data/spec/support/fixtures/vcr_cassettes/portal/generate_link_sso.yml

@@ -5,7 +5,7 @@ http_interactions:
     uri: https://api.workos.com/portal/generate_link
     body:
       encoding: UTF-8
-      string: '{"intent":"sso","organization":"org_01EHQMYV6MBK39QC5PZXHY59C3","return_url":null}'
+      string: '{"intent":"sso","organization":"org_01EHQMYV6MBK39QC5PZXHY59C3","return_url":null,"success_url":null}'
     headers:
       Content-Type:
       - application/json

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: workos
 version: !ruby/object:Gem::Version
-  version: 2.8.0
+  version: 2.10.0
 platform: ruby
 authors:
 - WorkOS
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-12 00:00:00.000000000 Z
+date: 2022-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sorbet-runtime
@@ -162,6 +162,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/CODEOWNERS"
+- ".github/pull_request_template.md"
 - ".github/renovate.json"
 - ".gitignore"
 - ".rspec"
@@ -402,7 +403,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.23
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: API client for WorkOS